4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS.
16 #include "frontends/mouse_state.h"
18 #include "support/docstring.h"
24 * This class encapsulates a LyX action and its argument
25 * in order to pass it around easily.
29 /// Where the request came from
32 UI, // The menu or the toolbar
33 KEYBOARD, // a keyboard binding
37 /// just for putting these things in std::container
38 explicit FuncRequest(Origin o = INTERNAL);
39 /// actions without extra argument
40 explicit FuncRequest(kb_action act, Origin o = INTERNAL);
41 /// actions without extra argument
42 FuncRequest(kb_action act, int x, int y, mouse_button::state button,
44 /// actions with extra argument
45 FuncRequest(kb_action act, lyx::docstring const & arg,
47 /// actions with extra argument. FIXME: remove this
48 FuncRequest(kb_action act, std::string const & arg,
50 /// for changing requests a bit
51 FuncRequest(FuncRequest const & cmd, lyx::docstring const & arg,
53 /// for changing requests a bit. FIXME: remove this
54 FuncRequest(FuncRequest const & cmd, std::string const & arg,
58 mouse_button::state button() const;
60 /// argument parsing, extract argument i as std::string
61 std::string getArg(unsigned int i) const;
63 /// access the whole argument
64 lyx::docstring const & argument() const { return argument_; }
66 public: // should be private
70 /// the action's string argument
71 lyx::docstring argument_;
72 public: // should be private
73 /// who initiated the action
75 /// the x coordinate of a mouse press
77 /// the y coordinate of a mouse press
79 /// some extra information (like button number)
80 mouse_button::state button_;
84 bool operator==(FuncRequest const & lhs, FuncRequest const & rhs);
86 std::ostream & operator<<(std::ostream &, FuncRequest const &);
88 #endif // FUNCREQUEST_H