]> git.lyx.org Git - features.git/blobdiff - src/insets/InsetCommandParams.h
InsetIndex: Some comments and indentation fixes
[features.git] / src / insets / InsetCommandParams.h
index e82320583fc4a39856bc4a3de62387ed2af3038b..1800fb599d8998cfe974ea7513d419646a519ab4 100644 (file)
@@ -6,7 +6,7 @@
  *
  * \author Angus Leeming
  * \author Georg Baum
- * \author Richard Heck
+ * \author Richard Kimberly Heck
  *
  * Full author contact details are available in file CREDITS.
  */
@@ -16,8 +16,6 @@
 
 #include "InsetCode.h"
 
-#include "OutputParams.h"
-
 #include "support/docstring.h"
 
 #include <string>
@@ -27,8 +25,9 @@
 
 namespace lyx {
 
-class Lexer;
 class Buffer;
+class Lexer;
+class OutputParams;
 
 class ParamInfo {
 public:
@@ -45,7 +44,8 @@ public:
                HANDLING_NONE = 1,    /// no special handling
                HANDLING_ESCAPE = 2,  /// escape special characters
                HANDLING_LATEXIFY = 4, /// transform special characters to LaTeX macros
-               HANDLING_LTRIM = 8 /// trim blanks on the left
+               HANDLING_LTRIM = 8, /// trim blanks on the left
+               HANDLING_INDEX_ESCAPE = 16, /// escape makeindex special chars
        };
        ///
        class ParamData {
@@ -87,10 +87,10 @@ public:
        };
 
        /// adds a new parameter
-       /// If ignore is true, then the parameter is never saved, and is always
+       /// If ignoreval is true, then the parameter is never saved, and is always
        /// given the default value.
        void add(std::string const & name, ParamType type,
-                ParamHandling = HANDLING_NONE, bool ignore = false,
+                ParamHandling = HANDLING_NONE, bool ignoreval = false,
                 docstring default_value = docstring());
        ///
        bool empty() const { return info_.empty(); }