Clarify member variable documentation

[lyx.git] / src / OutputParams.h

diff --git a/src/OutputParams.h b/src/OutputParams.h
index 15736f667da4a11fc884036bcc92d3276f83a7b9..87d8fcd122abebc74581f017b72ac615e37b6199 100644 (file)
--- a/src/OutputParams.h
+++ b/src/OutputParams.h
@@ -35,9 +35,10 @@ public:
                XETEX,
                XML,
                HTML,
-               TEXT
+               TEXT,
+               LYX
        };
-       
+
        enum MathFlavor {
                NotApplicable,
                MathAsMathML,
@@ -69,10 +70,10 @@ public:
        bool isLaTeX() const;
        /// does this flavour support full unicode?
        bool isFullUnicode() const;
-       
+
        /// Same, but for math output, which only matter is XHTML output.
        MathFlavor math_flavor;
-       
+
        /** Are we to write a 'nice' LaTeX file or not.
            This esentially seems to mean whether InsetInclude, InsetGraphics
            and InsetExternal should add the absolute path to any external
@@ -80,6 +81,12 @@ public:
        */
        bool nice;
 
+       /** Is this a real child (i.e., compiled as a child)?
+           This depends on wherefrom we export the buffer. Even children
+           that have a master can be compiled standalone.
+       */
+       mutable bool is_child;
+
        /** moving_arg == true means that the environment in which the inset
            is typeset is a moving argument. The inset should take care about
            fragile commands by preceding the latex with \\protect.
@@ -92,13 +99,13 @@ public:
        */
        bool intitle;
 
-       /** inulemcmd == true means that the environment in which the
+       /** inulemcmd > 0 means that the environment in which the
            inset is typeset is part of a ulem command (\uline, \uuline,
            \uwave, or \sout). Insets that output latex commands relying
            on local assignments (such as \cite) should enclose such
            commands in \mbox{} in order to avoid breakage.
        */
-       mutable bool inulemcmd;
+       mutable int inulemcmd;
 
        /** the font at the point where the inset is
         */
@@ -109,6 +116,8 @@ public:
        mutable std::string document_language;
 
        /** The master language. Non-null only for child documents.
+           Note that this is not the language of the top level master, but
+           of the direct parent for nested includes.
         */
        mutable Language const * master_language;
 
@@ -210,7 +219,7 @@ public:
 
        /** The change information of the outermost logically deleted inset.
         *  changeOfDeletedInset shall only be evaluated if inDeletedInset > 0.
-         */ 
+         */
        Change changeOfDeletedInset;
 
        /** allow output of only part of the top-level paragraphs
@@ -232,28 +241,37 @@ public:
 
        /// is this the last paragraph in the current buffer/inset?
        bool isLastPar;
-       
+
 
        /** whether or not do actual file copying and image conversion
         *  This mode will be used to preview the source code
         */
        bool dryrun;
-       
+
+       /// whether to display output errors or not
+       bool silent;
+
        /// Should we output verbatim or escape LaTeX's special chars?
        bool pass_thru;
-       
+
        /// Should we output captions?
        bool html_disable_captions;
-       
+
        /// Are we already in a paragraph?
        bool html_in_par;
-       
+
        /// Does the present context even permit paragraphs?
        bool html_make_pars;
-       
+
        /// Are we generating this material for inclusion in a TOC-like entity?
        bool for_toc;
-       
+
+       /// Are we generating this material for inclusion in a tooltip?
+       bool for_tooltip;
+
+       /// Are we generating this material for use by advanced search?
+       bool for_search;
+
        /// Include all children notwithstanding the use of \includeonly
        bool includeall;