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"
25 * This class encapsulates a LyX action and its argument
26 * in order to pass it around easily.
30 /// Where the request came from
34 TOOLBAR, // A toolbar icon
35 KEYBOARD, // a keyboard binding
39 /// just for putting these things in std::container
40 explicit FuncRequest(Origin o = INTERNAL);
41 /// actions without extra argument
42 explicit FuncRequest(kb_action act, Origin o = INTERNAL);
43 /// actions without extra argument
44 FuncRequest(kb_action act, int x, int y, mouse_button::state button,
46 /// actions with extra argument
47 FuncRequest(kb_action act, docstring const & arg,
49 /// actions with extra argument. FIXME: remove this
50 FuncRequest(kb_action act, std::string const & arg,
52 /// for changing requests a bit
53 FuncRequest(FuncRequest const & cmd, docstring const & arg,
55 /// for changing requests a bit. FIXME: remove this
56 FuncRequest(FuncRequest const & cmd, std::string const & arg,
60 mouse_button::state button() const;
62 /// argument parsing, extract argument i as std::string
63 std::string getArg(unsigned int i) const;
65 /// access the whole argument
66 docstring const & argument() const { return argument_; }
69 static FuncRequest const unknown;
71 static FuncRequest const noaction;
72 public: // should be private
76 /// the action's string argument
78 public: // should be private
79 /// who initiated the action
81 /// the x coordinate of a mouse press
83 /// the y coordinate of a mouse press
85 /// some extra information (like button number)
86 mouse_button::state button_;
90 bool operator==(FuncRequest const & lhs, FuncRequest const & rhs);
92 std::ostream & operator<<(std::ostream &, FuncRequest const &);
97 #endif // FUNCREQUEST_H