X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FFuncRequest.h;h=a5822f4b967b5708a4573343024f4216db64c922;hb=28be7d552f62cc02fa86d7f79201d089bfb2d7b5;hp=9ea6dc43447ed733b5605165661d4a658548055a;hpb=1a77c867a23f6f904f24b4968bdeb41e4244ccec;p=lyx.git diff --git a/src/FuncRequest.h b/src/FuncRequest.h index 9ea6dc4344..a5822f4b96 100644 --- a/src/FuncRequest.h +++ b/src/FuncRequest.h @@ -4,7 +4,7 @@ * This file is part of LyX, the document processor. * Licence details can be found in the file COPYING. * - * \author André Pönitz + * \author André Pönitz * * Full author contact details are available in file CREDITS. */ @@ -12,22 +12,24 @@ #ifndef FUNCREQUEST_H #define FUNCREQUEST_H -#include "lfuns.h" -#include "frontends/mouse_state.h" +#include "FuncCode.h" #include "support/docstring.h" -#include +#include "frontends/KeyModifier.h" +#include "frontends/mouse_state.h" namespace lyx { +class LyXErr; /** * This class encapsulates a LyX action and its argument * in order to pass it around easily. */ -class FuncRequest { +class FuncRequest +{ public: /// Where the request came from enum Origin { @@ -35,57 +37,74 @@ public: MENU, // A menu entry TOOLBAR, // A toolbar icon KEYBOARD, // a keyboard binding - COMMANDBUFFER + COMMANDBUFFER, + LYXSERVER, + TOC }; /// just for putting these things in std::container explicit FuncRequest(Origin o = INTERNAL); /// actions without extra argument - explicit FuncRequest(kb_action act, Origin o = INTERNAL); + explicit FuncRequest(FuncCode act, Origin o = INTERNAL); /// actions without extra argument - FuncRequest(kb_action act, int x, int y, mouse_button::state button, - Origin o = INTERNAL); + FuncRequest(FuncCode act, int x, int y, mouse_button::state button, + KeyModifier modifier, Origin o = INTERNAL); /// actions with extra argument - FuncRequest(kb_action act, docstring const & arg, + FuncRequest(FuncCode act, docstring const & arg, Origin o = INTERNAL); /// actions with extra argument. FIXME: remove this - FuncRequest(kb_action act, std::string const & arg, + FuncRequest(FuncCode act, std::string const & arg, Origin o = INTERNAL); /// for changing requests a bit 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; + + /// access the whole argument + docstring const & argument() const { return argument_; } + /// + FuncCode action() const { return action_ ; } + /// + void setAction(FuncCode act) { action_ = act; } + /// + Origin origin() const { return origin_; } + /// + void setOrigin(Origin o) { origin_ = o; } + /// + int x() const { return x_; } + /// + int y() const { return y_; } + /// + void set_y(int y) { y_ = y; } + /// + mouse_button::state button() const { return button_; } + /// + KeyModifier modifier() { return modifier_; } /// 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_; } + /// argument parsing, extract argument i as std::string, + /// eating all characters up to the end of the command line + std::string getLongArg(unsigned int i) const; /// static FuncRequest const unknown; /// static FuncRequest const noaction; -public: // should be private - /// the action - kb_action action; private: + /// the action + FuncCode action_; /// the action's string argument docstring argument_; -public: // should be private /// who initiated the action - Origin origin; + Origin origin_; /// the x coordinate of a mouse press - int x; + int x_; /// the y coordinate of a mouse press - int y; + int y_; /// some extra information (like button number) mouse_button::state button_; + /// + KeyModifier modifier_; }; @@ -93,6 +112,8 @@ bool operator==(FuncRequest const & lhs, FuncRequest const & rhs); std::ostream & operator<<(std::ostream &, FuncRequest const &); +LyXErr & operator<<(LyXErr &, FuncRequest const &); + } // namespace lyx