+// -*- 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 "lfuns.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.
*/
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 * view, kb_action act);
+ FuncRequest(BufferView * bv, kb_action act);
/// actions with extra argument
- FuncRequest(BufferView * view, kb_action act, string const & arg);
+ FuncRequest(BufferView * bv, kb_action act, string const & arg);
/// for mouse events
- FuncRequest(BufferView * view, kb_action act,
+ 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 * 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;
+
+ /// argument parsing, extract argument i as string
+ string getArg(int i) const;
+
private:
/// the BufferView we are talking to
BufferView * view_;