4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
10 * Full author contact details are available in file CREDITS.
28 * This class is a container for LyX actions. It associates a name to
29 * most of them and describes some of their properties.
33 /// category of an action, used in the Shortcuts dialog
35 Hidden, //< Not listed for configuration
36 Edit, //< Cursor and mouse movement, copy/paste etc
38 Buffer, //< Buffer and window related
39 Layout, //< Font, Layout and textclass related
40 System, //< Lyx preference, server etc
44 /// information for an action
48 /// the func_attrib values set
50 /// the category of this func
56 LyXAction(LyXAction const &);
57 void operator=(LyXAction const &);
59 /// type for map between a function name and its action
60 typedef std::map<std::string, FuncCode> func_map;
61 /// type for map between an action and its info
62 typedef std::map<FuncCode, FuncInfo> info_map;
64 /// possible "permissions" for an action
66 Noop = 0, //< Nothing special about this func
67 ReadOnly = 1, //< Can be used in RO mode (perhaps this should change); no automatic markDirty
68 NoBuffer = 2, //< Can be used when there is no document open
69 Argument = 4, //< Requires argument
70 NoUpdate = 8, //< Does not (usually) require update
71 SingleParUpdate = 16 //< Usually only requires this par updated
77 * Returns an pseudoaction from a string
78 * If you include arguments in func_name, a new pseudoaction
79 * will be created if needed.
81 FuncRequest lookupFunc(std::string const & func_name) const;
83 /// Return the name (and argument) associated with the given (pseudo) action
84 std::string const getActionName(FuncCode action) const;
86 func_type getActionType(FuncCode action) const;
88 /// True if the command has `flag' set
89 bool funcHasFlag(FuncCode action, func_attrib flag) const;
91 /// iterator across all real actions
92 typedef func_map::const_iterator const_func_iterator;
94 /// return an iterator to the start of all real actions
95 const_func_iterator func_begin() const;
97 /// return an iterator to the end of all real actions
98 const_func_iterator func_end() const;
101 /// populate the action container with our actions
103 /// add the given action
104 void newFunc(FuncCode, std::string const & name, unsigned int attrib, func_type type);
107 * This is a list of all the LyXFunc names with the
108 * coresponding action number. It is usually only used by the
109 * minibuffer or when assigning commands to keys during init.
111 func_map lyx_func_map;
114 * This is a mapping from action number to an object holding
115 * info about this action. f.ex. command name (string),
116 * command attributes (ro)
118 info_map lyx_info_map;
121 LyXErr & operator<<(LyXErr &, FuncCode);
123 /// singleton instance
124 extern LyXAction lyxaction;
129 #endif // LYXACTION_H