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.
27 * This class is a container for LyX actions. It also
28 * stores and managers "pseudo-actions". Pseudo-actions
29 * are not part of the kb_action enum, but are created
30 * dynamically, for encapsulating a real action and an
31 * argument. They are used for things like the menus.
35 /// category of an action, used in the Shortcuts dialog
37 Hidden, //< Not listed for configuration
38 Edit, //< Cursor and mouse movement, copy/paste etc
40 Buffer, //< Buffer and window related
41 Layout, //< Font, Layout and textclass related
42 System, //< Lyx preference, server etc
46 /// information for an action
50 /// the func_attrib values set
52 /// the category of this func
58 LyXAction(LyXAction const &);
59 void operator=(LyXAction const &);
61 /// type for map between a function name and its action
62 typedef std::map<std::string, kb_action> func_map;
63 /// type for map between an action and its info
64 typedef std::map<kb_action, func_info> info_map;
66 /// possible "permissions" for an action
68 Noop = 0, //< nothing special about this func
69 ReadOnly = 1, //< can be used in RO mode (perhaps this should change)
70 NoBuffer = 2, //< Can be used when there is no document open
71 Argument = 4, //< Requires argument
72 NoUpdate = 8, //< Does not (usually) require update
73 SingleParUpdate = 16 //< Usually only requires this par updated
79 * Returns an pseudoaction from a string
80 * If you include arguments in func_name, a new pseudoaction
81 * will be created if needed.
83 FuncRequest lookupFunc(std::string const & func_name) const;
85 /// Return the name (and argument) associated with the given (pseudo) action
86 std::string const getActionName(kb_action action) const;
88 func_type const getActionType(kb_action action) const;
90 /// True if the command has `flag' set
91 bool funcHasFlag(kb_action action, func_attrib flag) const;
93 /// iterator across all real actions
94 typedef func_map::const_iterator const_func_iterator;
96 /// return an iterator to the start of all real actions
97 const_func_iterator func_begin() const;
99 /// return an iterator to the end of all real actions
100 const_func_iterator func_end() const;
103 /// populate the action container with our actions
105 /// add the given action
106 void newFunc(kb_action, std::string const & name, unsigned int attrib, func_type type);
109 * This is a list of all the LyXFunc names with the
110 * coresponding action number. It is usually only used by the
111 * minibuffer or when assigning commands to keys during init.
113 func_map lyx_func_map;
116 * This is a mapping from action number to an object holding
117 * info about this action. f.ex. command name (string),
118 * command attributes (ro)
120 info_map lyx_info_map;
123 /// singleton instance
124 extern LyXAction lyxaction;
129 #endif // LYXACTION_H