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"
27 * This class encapsulates a LyX action and its argument
28 * in order to pass it around easily.
32 /// Where the request came from
35 UI, // The menu or the toolbar
36 KEYBOARD, // a keyboard binding
40 /// just for putting these things in std::container
41 explicit FuncRequest(Origin o = INTERNAL);
42 /// actions without extra argument
43 explicit FuncRequest(kb_action act, Origin o = INTERNAL);
44 /// actions without extra argument
45 FuncRequest(kb_action act, int x, int y, mouse_button::state button,
47 /// actions with extra argument
48 FuncRequest(kb_action act, docstring const & arg,
50 /// actions with extra argument. FIXME: remove this
51 FuncRequest(kb_action act, std::string const & arg,
53 /// for changing requests a bit
54 FuncRequest(FuncRequest const & cmd, docstring const & arg,
56 /// for changing requests a bit. FIXME: remove this
57 FuncRequest(FuncRequest const & cmd, std::string const & arg,
61 mouse_button::state button() const;
63 /// argument parsing, extract argument i as std::string
64 std::string getArg(unsigned int i) const;
66 /// access the whole argument
67 docstring const & argument() const { return argument_; }
69 public: // should be private
73 /// the action's string argument
75 public: // should be private
76 /// who initiated the action
78 /// the x coordinate of a mouse press
80 /// the y coordinate of a mouse press
82 /// some extra information (like button number)
83 mouse_button::state button_;
87 bool operator==(FuncRequest const & lhs, FuncRequest const & rhs);
89 std::ostream & operator<<(std::ostream &, FuncRequest const &);
94 #endif // FUNCREQUEST_H