* 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.
*/
#ifndef FUNCREQUEST_H
#define FUNCREQUEST_H
-#include "lfuns.h"
-#include "frontends/mouse_state.h"
+#include "FuncCode.h"
#include "support/docstring.h"
-#include <iosfwd>
+#include "frontends/mouse_state.h"
namespace lyx {
-
/**
* 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 {
MENU, // A menu entry
TOOLBAR, // A toolbar icon
KEYBOARD, // a keyboard binding
- COMMANDBUFFER
+ COMMANDBUFFER,
+ 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,
+ FuncRequest(FuncCode act, int x, int y, mouse_button::state button,
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,
/// argument parsing, extract argument i as std::string
std::string getArg(unsigned int i) const;
+ /// 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;
+
/// access the whole argument
docstring const & argument() const { return argument_; }
static FuncRequest const noaction;
public: // should be private
/// the action
- kb_action action;
+ FuncCode action;
private:
/// the action's string argument
docstring argument_;