Style. Enum names and typedefs are almost always CamelCase in the LyX

[lyx.git] / src / LyXAction.h

diff --git a/src/LyXAction.h b/src/LyXAction.h
index 77e557ee92c8853071e610abfe6056067400e2c0..6d0e8228e7ba38415d769e9674d1fdd7c672a4ee 100644 (file)
--- a/src/LyXAction.h
+++ b/src/LyXAction.h
@@ -31,7 +31,7 @@ class LyXErr;
 class LyXAction {
 public:
        /// category of an action, used in the Shortcuts dialog
-       enum func_type {
+       enum FuncType {
                Hidden,  //< Not listed for configuration
                Edit,    //< Cursor and mouse movement, copy/paste etc
                Math,    //< Mathematics
@@ -48,21 +48,21 @@ private:
                /// the func_attrib values set
                unsigned int attrib;
                /// the category of this func
-               func_type type;
+               FuncType type;
        };
+       /// type for map between a function name and its action
+       typedef std::map<std::string, FuncCode> FuncMap;
+       /// type for map between an action and its info
+       typedef std::map<FuncCode, FuncInfo> InfoMap;
+
 
 public:
        /// noncopyable
        LyXAction(LyXAction const &);
        void operator=(LyXAction const &);
 
-       /// type for map between a function name and its action
-       typedef std::map<std::string, FuncCode> func_map;
-       /// type for map between an action and its info
-       typedef std::map<FuncCode, FuncInfo> info_map;
-
        /// possible "permissions" for an action
-       enum func_attrib {
+       enum FuncAttribs {
                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
@@ -76,22 +76,24 @@ public:
        LyXAction();
 
        /**
-        * Returns an pseudoaction from a string
-        * If you include arguments in func_name, a new pseudoaction
-        * will be created if needed.
+        * Creates a FuncRequest from a string of the form:
+        *   lyx-function [argument]
+        * where the argument is optional and "lyx-function" is in the form you'd
+        * enter it in the mini-buffer. 
         */
        FuncRequest lookupFunc(std::string const & func_name) const;
 
-       /// Return the name (and argument) associated with the given (pseudo) action
+       /// Return the command name associated with the given action
+       /// Thus: getActionName(LFUN_ERT_INSERT) --> "ert-insert".
        std::string const getActionName(FuncCode action) const;
-
-        func_type getActionType(FuncCode action) const;
+       ///
+       FuncType getActionType(FuncCode action) const;
 
        /// True if the command has `flag' set
-       bool funcHasFlag(FuncCode action, func_attrib flag) const;
+       bool funcHasFlag(FuncCode action, FuncAttribs flag) const;
 
        /// iterator across all real actions
-       typedef func_map::const_iterator const_func_iterator;
+       typedef FuncMap::const_iterator const_func_iterator;
 
        /// return an iterator to the start of all real actions
        const_func_iterator func_begin() const;
@@ -103,21 +105,21 @@ private:
        /// populate the action container with our actions
        void init();
        /// add the given action
-       void newFunc(FuncCode, std::string const & name, unsigned int attrib, func_type type);
+       void newFunc(FuncCode, std::string const & name, unsigned int attrib, FuncType type);
 
        /**
         * This is a list of all the LyXFunc names with the
         * coresponding action number. It is usually only used by the
         * minibuffer or when assigning commands to keys during init.
         */
-       func_map lyx_func_map;
+       FuncMap lyx_func_map;
 
        /**
         * This is a mapping from action number to an object holding
         * info about this action. f.ex. command name (string),
         * command attributes (ro)
         */
-       info_map lyx_info_map;
+       InfoMap lyx_info_map;
 };
 
 LyXErr & operator<<(LyXErr &, FuncCode);