X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Ffuncrequest.h;h=118e4f45bfdeeccdbf12463affa64794dcbc40b8;hb=35204f8f33d7400a5fefeffea533fb4cb4097211;hp=8b3de7b1e6d29f47be34732cc55bb437f2c849bd;hpb=808973619b70166c140acfd12467ddc84ed6a848;p=lyx.git

diff --git a/src/funcrequest.h b/src/funcrequest.h
index 8b3de7b1e6..118e4f45bf 100644
--- a/src/funcrequest.h
+++ b/src/funcrequest.h
@@ -1,56 +1,95 @@
+// -*- 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 "support/docstring.h"
+
+#include <iosfwd>
+
+
+namespace lyx {
 
-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,
+		MENU, // A menu entry
+		TOOLBAR, // A toolbar icon
+		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);
+	FuncRequest(kb_action act, docstring const & arg,
+		    Origin o = INTERNAL);
+	/// actions with extra argument. FIXME: remove this
+	FuncRequest(kb_action 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);
 
-private:
-	/// the BufferView we are talking to
-	BufferView * view_;
-public:  // should be private, too...
+	/// access to button
+	mouse_button::state button() const;
+
+	/// 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_; }
+
+public:  // should be private
 	/// the action
 	kb_action action;
+private:
 	/// the action's string argument
-	string argument;
+	docstring argument_;
+public:  // should be private
+	/// 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 &);
+
+
+} // namespace lyx
+
 #endif // FUNCREQUEST_H