#include "lfuns.h"
#include "frontends/mouse_state.h"
-#include "support/std_string.h"
-class BufferView;
+#include "support/docstring.h"
+
+#include <iosfwd>
+
+
+namespace lyx {
+
/**
* This class encapsulates a LyX action and its argument
*/
class FuncRequest {
public:
- /// just for putting thes things in std::container
- FuncRequest();
- /// actions without extra argument
- explicit FuncRequest(kb_action act);
+ /// Where the request came from
+ enum Origin {
+ INTERNAL,
+ MENU, // A menu entry
+ TOOLBAR, // A toolbar icon
+ KEYBOARD, // a keyboard binding
+ COMMANDBUFFER
+ };
+
+ /// just for putting these things in std::container
+ explicit FuncRequest(Origin o = INTERNAL);
/// actions without extra argument
- FuncRequest(kb_action act, int x, int y, mouse_button::state button);
- /// actions with extra argument
- FuncRequest(kb_action act, string const & arg);
+ explicit FuncRequest(kb_action act, Origin o = INTERNAL);
/// actions without extra argument
- FuncRequest(BufferView * bv, kb_action act);
+ FuncRequest(kb_action act, int x, int y, mouse_button::state button,
+ Origin o = INTERNAL);
/// actions with extra argument
- FuncRequest(BufferView * bv, kb_action act, string const & arg);
- /// for mouse events
- FuncRequest(BufferView * bv, kb_action act,
- int x, int y, mouse_button::state button);
+ FuncRequest(kb_action act, docstring const & arg,
+ Origin o = INTERNAL);
+ /// actions with extra argument. FIXME: remove this
+ FuncRequest(kb_action act, std::string const & arg,
+ Origin o = INTERNAL);
/// for changing requests a bit
- FuncRequest(FuncRequest const & cmd, string const & arg);
- /// for changing requests a bit
- FuncRequest(FuncRequest const & cmd, BufferView * bv);
+ FuncRequest(FuncRequest const & cmd, docstring const & arg,
+ Origin o = INTERNAL);
+ /// for changing requests a bit. FIXME: remove this
+ FuncRequest(FuncRequest const & cmd, std::string const & arg,
+ Origin o = INTERNAL);
- /// access to the view
- BufferView * view() const;
- /// access to the view
- void setView(BufferView * bv);
/// access to button
mouse_button::state button() const;
- /// output a message
- void message(string const & msg) const;
- /// output an error message
- void errorMessage(string const & msg) const;
+ /// argument parsing, extract argument i as std::string
+ std::string getArg(unsigned int i) const;
- /// argument parsing, extract argument i as string
- string getArg(unsigned int i) const;
+ /// access the whole argument
+ docstring const & argument() const { return argument_; }
-private:
- /// the BufferView we are talking to
- BufferView * view_;
-public: // should be private, too...
+public: // should be private
/// the action
kb_action action;
+private:
/// the action's string argument
- string argument;
+ docstring argument_;
+public: // should be private
+ /// who initiated the action
+ Origin origin;
/// the x coordinate of a mouse press
int x;
/// the y coordinate of a mouse press
};
-inline
-bool operator==(FuncRequest const & lhs, FuncRequest const & rhs)
-{
- return lhs.action == rhs.action && lhs.argument == rhs.argument;
-}
+bool operator==(FuncRequest const & lhs, FuncRequest const & rhs);
+
+std::ostream & operator<<(std::ostream &, FuncRequest const &);
+
+
+} // namespace lyx
#endif // FUNCREQUEST_H