lyx_mirror/src/funcrequest.h
André Pönitz 3c7c7a3209 the workarea changes plus small math stuff
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@5128 a592a061-630c-0410-9148-cb99ea01b6c8
2002-08-28 08:30:27 +00:00

73 lines
1.9 KiB
C++

/**
* \file funcrequest.h
* Copyright 2002 the LyX Team
* Read the file COPYING
*
* \author André Pönitz
*/
#ifndef FUNCREQUEST_H
#define FUNCREQUEST_H
#include "commandtags.h"
#include "frontends/mouse_state.h"
#include "LString.h"
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();
/// 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, string const & arg);
/// actions without extra argument
FuncRequest(BufferView * bv, kb_action act);
/// actions with extra argument
FuncRequest(BufferView * bv, kb_action act, 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, string const & arg);
/// for changing requests a bit
FuncRequest(FuncRequest const & cmd, BufferView * bv);
/// access to the view
BufferView * view() const;
/// access to the view
void setView(BufferView * bv);
/// access to button
mouse_button::state button() const;
/// output a message
void message(string const & msg) const;
/// output an error message
void errorMessage(string const & msg) 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 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 // FUNCREQUEST_H