+// -*- 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 <string>
+#include <iosfwd>
-class BufferView;
-/**
+/**
* 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 ax, int ay, int aextra);
- /// access to the view
- BufferView * view() const;
- /// access to the view
- void setView(BufferView * view);
-
-private:
- /// the BufferView we are talking to
- BufferView * view_;
-public: // should be private, too...
+ 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);
+
+ /// access to button
+ mouse_button::state button() const;
+
+ /// 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)
- int extra;
+ mouse_button::state button_;
};
+
+bool operator==(FuncRequest const & lhs, FuncRequest const & rhs);
+
+std::ostream & operator<<(std::ostream &, FuncRequest const &);
+
#endif // FUNCREQUEST_H