* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
* \author John Levon
*
* Full author contact details are available in file CREDITS.
#ifndef LYXACTION_H
#define LYXACTION_H
-#include "lfuns.h"
+#include "FuncCode.h"
#include <map>
#include <string>
namespace lyx {
class FuncRequest;
+class LyXErr;
/**
- * This class is a container for LyX actions. It also
- * stores and managers "pseudo-actions". Pseudo-actions
- * are not part of the kb_action enum, but are created
- * dynamically, for encapsulating a real action and an
- * argument. They are used for things like the menus.
+ * This class is a container for LyX actions. It associates a name to
+ * most of them and describes some of their properties.
*/
class LyXAction {
public:
private:
/// information for an action
- struct func_info {
+ struct FuncInfo {
/// the action name
std::string name;
/// the func_attrib values set
void operator=(LyXAction const &);
/// type for map between a function name and its action
- typedef std::map<std::string, kb_action> func_map;
+ typedef std::map<std::string, FuncCode> func_map;
/// type for map between an action and its info
- typedef std::map<kb_action, func_info> info_map;
+ typedef std::map<FuncCode, FuncInfo> info_map;
/// possible "permissions" for an action
enum func_attrib {
- Noop = 0, //< nothing special about this func
- ReadOnly = 1, //< can be used in RO mode (perhaps this should change)
+ Noop = 0, //< Nothing special about this func
+ ReadOnly = 1, //< Can be used in RO mode (perhaps this should change); no automatic markDirty
NoBuffer = 2, //< Can be used when there is no document open
Argument = 4, //< Requires argument
NoUpdate = 8, //< Does not (usually) require update
FuncRequest lookupFunc(std::string const & func_name) const;
/// Return the name (and argument) associated with the given (pseudo) action
- std::string const getActionName(kb_action action) const;
+ std::string const getActionName(FuncCode action) const;
- func_type const getActionType(kb_action action) const;
+ func_type getActionType(FuncCode action) const;
/// True if the command has `flag' set
- bool funcHasFlag(kb_action action, func_attrib flag) const;
+ bool funcHasFlag(FuncCode action, func_attrib flag) const;
/// iterator across all real actions
typedef func_map::const_iterator const_func_iterator;
/// populate the action container with our actions
void init();
/// add the given action
- void newFunc(kb_action, std::string const & name, unsigned int attrib, func_type type);
+ void newFunc(FuncCode, std::string const & name, unsigned int attrib, func_type type);
/**
* This is a list of all the LyXFunc names with the
info_map lyx_info_map;
};
+LyXErr & operator<<(LyXErr &, FuncCode);
+
/// singleton instance
extern LyXAction lyxaction;