src/funcrequest.h

   1 // -*- C++ -*-
   2 /**
   3  * \file funcrequest.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author André Pönitz
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef FUNCREQUEST_H
  13 #define FUNCREQUEST_H
  14
  15 #include "lfuns.h"
  16 #include "frontends/mouse_state.h"
  17
  18 #include <string>
  19 #include <iosfwd>
  20
  21
  22 /**
  23  * This class encapsulates a LyX action and its argument
  24  * in order to pass it around easily.
  25  */
  26 class FuncRequest {
  27 public:
  28         /// just for putting thes things in std::container
  29         FuncRequest();
  30         /// actions without extra argument
  31         explicit FuncRequest(kb_action act);
  32         /// actions without extra argument
  33         FuncRequest(kb_action act, int x, int y, mouse_button::state button);
  34         /// actions with extra argument
  35         FuncRequest(kb_action act, std::string const & arg);
  36         /// for changing requests a bit
  37         FuncRequest(FuncRequest const & cmd, std::string const & arg);
  38
  39         /// access to button
  40         mouse_button::state button() const;
  41
  42         /// argument parsing, extract argument i as std::string
  43         std::string getArg(unsigned int i) const;
  44
  45 public:  // should be private
  46         /// the action
  47         kb_action action;
  48         /// the action's std::string argument
  49         std::string argument;
  50         /// the x coordinate of a mouse press
  51         int x;
  52         /// the y coordinate of a mouse press
  53         int y;
  54         /// some extra information (like button number)
  55         mouse_button::state button_;
  56 };
  57
  58
  59 bool operator==(FuncRequest const & lhs, FuncRequest const & rhs);
  60
  61 std::ostream & operator<<(std::ostream &, FuncRequest const &);
  62
  63 #endif // FUNCREQUEST_H