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.
18 #include <boost/utility.hpp>
26 * This class is a container for LyX actions. It also
27 * stores and managers "pseudo-actions". Pseudo-actions
28 * are not part of the kb_action enum, but are created
29 * dynamically, for encapsulating a real action and an
30 * argument. They are used for things like the menus.
32 class LyXAction : boost::noncopyable {
34 /// information for an action
38 /// the func_attrib values set
43 /// type for map between a function name and its action
44 typedef std::map<std::string, kb_action> func_map;
45 /// type for map between an action and its info
46 typedef std::map<kb_action, func_info> info_map;
48 /// possible "permissions" for an action
50 Noop = 0, //< nothing special about this func
51 ReadOnly = 1, //< can be used in RO mode (perhaps this should change)
52 NoBuffer = 2, //< Can be used when there is no document open
53 Argument = 4 //< Requires argument
59 * Returns an pseudoaction from a string
60 * If you include arguments in func_name, a new pseudoaction
61 * will be created if needed.
63 FuncRequest lookupFunc(std::string const & func_name) const;
65 /// Return the name (and argument) associated with the given (pseudo) action
66 std::string const getActionName(kb_action action) const;
68 /// True if the command has `flag' set
69 bool funcHasFlag(kb_action action, func_attrib flag) const;
71 /// iterator across all real actions
72 typedef func_map::const_iterator const_func_iterator;
74 /// return an iterator to the start of all real actions
75 const_func_iterator func_begin() const;
77 /// return an iterator to the end of all real actions
78 const_func_iterator func_end() const;
81 /// populate the action container with our actions
83 /// add the given action
84 void newFunc(kb_action, std::string const & name, unsigned int attrib);
87 * This is a list of all the LyXFunc names with the
88 * coresponding action number. It is usually only used by the
89 * minibuffer or when assigning commands to keys during init.
91 func_map lyx_func_map;
94 * This is a mapping from action number to an object holding
95 * info about this action. f.ex. command name (string),
96 * command attributes (ro)
98 info_map lyx_info_map;
101 /// singleton instance
102 extern LyXAction lyxaction;
104 #endif // LYXACTION_H