X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Ffuncrequest.h;h=118e4f45bfdeeccdbf12463affa64794dcbc40b8;hb=e7f4618bcce770369cf46335c2c7f0164b4b8857;hp=8224d29460e857cdc41e92648cec43c2f0ad9fb2;hpb=70d0ba900118ac7e253c1e1969fd7a3d64ec8e03;p=lyx.git diff --git a/src/funcrequest.h b/src/funcrequest.h index 8224d29460..118e4f45bf 100644 --- a/src/funcrequest.h +++ b/src/funcrequest.h @@ -15,42 +15,67 @@ #include "lfuns.h" #include "frontends/mouse_state.h" -#include +#include "support/docstring.h" + #include + +namespace lyx { + + /** * This class encapsulates a LyX action and its argument * in order to pass it around easily. */ class FuncRequest { public: - /// just for putting thes things in std::container - FuncRequest(); + /// 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 - explicit FuncRequest(kb_action act); + explicit FuncRequest(kb_action act, Origin o = INTERNAL); /// actions without extra argument - FuncRequest(kb_action act, int x, int y, mouse_button::state button); + FuncRequest(kb_action act, int x, int y, mouse_button::state button, + Origin o = INTERNAL); /// actions with extra argument - FuncRequest(kb_action act, std::string const & arg); + 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, std::string const & arg); + 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 button mouse_button::state button() const; - /// output a message - void message(std::string const & msg) const; - /// output an error message - void errorMessage(std::string const & msg) const; - /// argument parsing, extract argument i as std::string std::string getArg(unsigned int i) const; + /// access the whole argument + docstring const & argument() const { return argument_; } + public: // should be private /// the action kb_action action; - /// the action's std::string argument - std::string argument; +private: + /// the action's 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 @@ -64,4 +89,7 @@ bool operator==(FuncRequest const & lhs, FuncRequest const & rhs); std::ostream & operator<<(std::ostream &, FuncRequest const &); + +} // namespace lyx + #endif // FUNCREQUEST_H