X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Ffuncrequest.h;h=355499992da6bfc9961508dff37b45eaab9b1342;hb=87cd77d1fc819bc8f14982fc6b20091720c011f5;hp=a03d953081da52ec055ed0db5f11e6708ee6fb5b;hpb=c69f29dda75751987a71ec3dccc9b62725006e20;p=lyx.git diff --git a/src/funcrequest.h b/src/funcrequest.h index a03d953081..355499992d 100644 --- a/src/funcrequest.h +++ b/src/funcrequest.h @@ -1,62 +1,65 @@ +// -*- 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 "lfuns.h" #include "frontends/mouse_state.h" -#include "LString.h" -class BufferView; +#include +#include + -/** +/** * 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, + UI, // The menu or the toolbar + 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); - /// 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 * view, kb_action act); + FuncRequest(kb_action act, int x, int y, mouse_button::state button, + Origin o = INTERNAL); /// actions with extra argument - FuncRequest(BufferView * view, kb_action act, string const & arg); - /// for mouse events - FuncRequest(BufferView * view, kb_action act, - int x, int y, mouse_button::state button); + FuncRequest(kb_action act, std::string const & arg, + Origin o = INTERNAL); /// for changing requests a bit - FuncRequest(FuncRequest const & cmd, string const & arg); + 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 * view); /// 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; -private: - /// the BufferView we are talking to - BufferView * view_; -public: // should be private, too... +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 @@ -65,4 +68,9 @@ public: // should be private, too... mouse_button::state button_; }; + +bool operator==(FuncRequest const & lhs, FuncRequest const & rhs); + +std::ostream & operator<<(std::ostream &, FuncRequest const &); + #endif // FUNCREQUEST_H