gnome build removal, gtk build fix

[lyx.git] / src / funcrequest.h

diff --git a/src/funcrequest.h b/src/funcrequest.h
index c48a8938a9a555fc09e727baf206fb2e26eddae8..355499992da6bfc9961508dff37b45eaab9b1342 100644 (file)
--- a/src/funcrequest.h
+++ b/src/funcrequest.h
@@ -1,30 +1,76 @@
+// -*- C++ -*-
+/**
+ * \file funcrequest.h
+ * 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>
 
-/** This class encapsulates LyX action and arguemnt
- *  in order to passs it around easily.
+
+/**
+ * This class encapsulates a LyX action and its argument
+ * in order to pass it around easily.
  */
-struct FuncRequest {
-       /// 
-       FuncRequest()
-               : action(LFUN_UNKNOWN_ACTION)
-       {}
-       /// 
-       FuncRequest(kb_action act)
-               : action(act)
-       {}
-       /// 
-       FuncRequest(kb_action act, string const & arg)
-               : action(act), argument(arg)
-       {}
-
-       ///
+class FuncRequest {
+public:
+       /// 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, 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);
+
+       /// 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;
-       ///
-       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_;
 };
 
-#endif
+
+bool operator==(FuncRequest const & lhs, FuncRequest const & rhs);
+
+std::ostream & operator<<(std::ostream &, FuncRequest const &);
+
+#endif // FUNCREQUEST_H