X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Ffuncrequest.h;h=355499992da6bfc9961508dff37b45eaab9b1342;hb=87cd77d1fc819bc8f14982fc6b20091720c011f5;hp=e3f4ccf15d42d5ea6432c79d2ff2befc18e91b0c;hpb=ba29fec6bfb93b60d4c06ae923e9fdd944d4c914;p=lyx.git diff --git a/src/funcrequest.h b/src/funcrequest.h index e3f4ccf15d..355499992d 100644 --- a/src/funcrequest.h +++ b/src/funcrequest.h @@ -1,39 +1,76 @@ +// -*- C++ -*- /** * \file funcrequest.h - * Copyright 2002 the LyX Team - * Read the file COPYING + * This file is part of LyX, the document processor. + * Licence details can be found in the file COPYING. * * \author André Pönitz + * + * Full author contact details are available in file CREDITS. */ #ifndef FUNCREQUEST_H #define FUNCREQUEST_H -#include "commandtags.h" -#include "LString.h" +#include "lfuns.h" +#include "frontends/mouse_state.h" + +#include +#include -/** + +/** * This class encapsulates a LyX action and its argument * in order to pass it around easily. */ -struct FuncRequest { +class FuncRequest { +public: + /// Where the request came from + enum Origin { + INTERNAL, + UI, // The menu or the toolbar + KEYBOARD, // a keyboard binding + COMMANDBUFFER + }; - FuncRequest() - : action(LFUN_UNKNOWN_ACTION) - {} + /// 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); + /// actions without extra argument + 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, + Origin o = INTERNAL); + /// for changing requests a bit + FuncRequest(FuncRequest const & cmd, std::string const & arg, + Origin o = INTERNAL); - FuncRequest(kb_action act) - : action(act) - {} + /// access to button + mouse_button::state button() const; - FuncRequest(kb_action act, string const & arg) - : action(act), argument(arg) - {} + /// argument parsing, extract argument i as std::string + std::string getArg(unsigned int i) const; +public: // should be private /// the action kb_action action; - /// the action's string argument - string argument; + /// the action's std::string argument + std::string argument; + /// who initiated the action + Origin origin; + /// the x coordinate of a mouse press + int x; + /// the y coordinate of a mouse press + int y; + /// some extra information (like button number) + mouse_button::state button_; }; + +bool operator==(FuncRequest const & lhs, FuncRequest const & rhs); + +std::ostream & operator<<(std::ostream &, FuncRequest const &); + #endif // FUNCREQUEST_H