ws changes only

[lyx.git] / src / funcrequest.h

diff --git a/src/funcrequest.h b/src/funcrequest.h
index e3f4ccf15d42d5ea6432c79d2ff2befc18e91b0c..2091ab0b466551c68dda4d07d74c9a9a8c8e93a6 100644 (file)
--- a/src/funcrequest.h
+++ b/src/funcrequest.h
@@ -1,39 +1,86 @@
+// -*- 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>
+
+class BufferView;
 
-/** 
+/**
  * This class encapsulates a LyX action and its argument
  * in order to pass it around easily.
  */
-struct FuncRequest {
+class FuncRequest {
+public:
+       /// just for putting thes things in std::container
+       FuncRequest();
+       /// actions without extra argument
+       explicit FuncRequest(kb_action act);
+       /// actions without extra argument
+       FuncRequest(kb_action act, int x, int y, mouse_button::state button);
+       /// actions with extra argument
+       FuncRequest(kb_action act, std::string const & arg);
+       /// actions without extra argument
+       FuncRequest(BufferView * bv, kb_action act);
+       /// actions with extra argument
+       FuncRequest(BufferView * bv, kb_action act, std::string const & arg);
+       /// for mouse events
+       FuncRequest(BufferView * bv, kb_action act,
+               int x, int y, mouse_button::state button);
+       /// for changing requests a bit
+       FuncRequest(FuncRequest const & cmd, std::string const & arg);
+       /// for changing requests a bit
+       FuncRequest(FuncRequest const & cmd, BufferView * bv);
 
-       FuncRequest()
-               : action(LFUN_UNKNOWN_ACTION)
-       {}
+       /// access to the view
+       BufferView * view() const;
+       /// access to the view
+       void setView(BufferView * bv);
+       /// access to button
+       mouse_button::state button() const;
 
-       FuncRequest(kb_action act)
-               : action(act)
-       {}
+       /// output a message
+       void message(std::string const & msg) const;
+       /// output an error message
+       void errorMessage(std::string const & msg) const;
 
-       FuncRequest(kb_action act, string const & arg)
-               : action(act), argument(arg)
-       {}
+       /// 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...
        /// the action
        kb_action action;
-       /// the action's string argument
-       string argument;
+       /// the action's std::string argument
+       std::string argument;
+       /// 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_;
 };
 
+
+inline
+bool operator==(FuncRequest const & lhs, FuncRequest const & rhs)
+{
+       return lhs.action == rhs.action && lhs.argument == rhs.argument;
+}
+
 #endif // FUNCREQUEST_H