]> git.lyx.org Git - lyx.git/blobdiff - src/Layout.h
Fix unnecessary cprotect
[lyx.git] / src / Layout.h
index 184711b3b4b9c48c2af1e642b6e229b4c17fd111..14784a27d23315456d7eddb2286a912d28572a97 100644 (file)
@@ -94,20 +94,24 @@ public:
                docstring labelstring;
                docstring menustring;
                bool mandatory;
+               bool nodelims;
                docstring ldelim;
                docstring rdelim;
                docstring defaultarg;
                docstring presetarg;
                docstring tooltip;
-               std::string requires;
+               std::string required;
                std::string decoration;
                FontInfo font;
                FontInfo labelfont;
                bool autoinsert;
                bool insertcotext;
+               bool insertonnewline;
                ArgPassThru passthru;
                docstring pass_thru_chars;
                bool is_toc_caption;
+               bool free_spacing;
+               std::string newlinecmd;
        };
        ///
        typedef std::map<std::string, latexarg> LaTeXArgMap;
@@ -116,7 +120,12 @@ public:
        ///
        LaTeXArgMap const & postcommandargs() const { return postcommandargs_; }
        ///
+       LaTeXArgMap const & listpreamble() const { return listpreamble_; }
+       ///
        LaTeXArgMap const & itemargs() const { return itemargs_; }
+       /// Returns true is the layout has arguments. If false, then an
+       /// InsetArgument in this layout stands for the parent InsetText.
+       bool hasArgs() const;
        /// Returns latexargs() + postcommandargs() + itemargs().
        /// But note that it returns a *copy*, not a reference, so do not do
        /// anything like:
@@ -129,7 +138,7 @@ public:
        ///
        int requiredArgs() const;
        ///
-       docstring const & labelstring(bool in_appendix) const 
+       docstring const & labelstring(bool in_appendix) const
        { return in_appendix ? labelstring_appendix_ : labelstring_; }
        ///
        docstring const & endlabelstring() const { return endlabelstring_; }
@@ -144,7 +153,11 @@ public:
        /// this layout for language \p lang
        docstring const babelpreamble() const { return babelpreamble_; }
        ///
-       std::set<std::string> const & requires() const { return requires_; }
+       std::set<std::string> const & required() const { return required_; }
+       ///
+       std::set<docstring> const & autonests() const { return autonests_; }
+       ///
+       std::set<docstring> const & isAutonestedBy() const { return autonested_by_; }
        ///
        std::string const & latexparam() const { return latexparam_; }
        ///
@@ -157,29 +170,75 @@ public:
        std::string const & labeltag() const { return labeltag_; }
        ///
        std::string const & itemtag() const { return itemtag_; }
-       /// 
+       ///
        std::string const & htmltag() const;
-       /// 
+       ///
        std::string const & htmlattr() const;
-       /// 
+       ///
        std::string const & htmlitemtag() const;
-       /// 
+       ///
        std::string const & htmlitemattr() const;
-       /// 
+       ///
        std::string const & htmllabeltag() const;
-       /// 
+       ///
        std::string const & htmllabelattr() const;
        ///
        std::string defaultCSSClass() const;
        ///
        bool htmllabelfirst() const { return htmllabelfirst_; }
-       /// 
+       ///
        docstring htmlstyle() const;
-       /// 
+       ///
        docstring const & htmlpreamble() const { return htmlpreamble_; }
        ///
        bool htmltitle() const { return htmltitle_; }
        ///
+       std::string const & docbooktag() const;
+       ///
+       std::string const & docbookattr() const;
+       ///
+       std::string const & docbooktagtype() const;
+       ///
+       std::string const & docbookininfo() const;
+       ///
+       bool docbookabstract() const { return docbookabstract_; }
+       ///
+       std::string const & docbookwrappertag() const;
+       ///
+       std::string const & docbookwrapperattr() const;
+       ///
+       std::string const & docbookwrappertagtype() const;
+       ///
+       bool docbookwrappermergewithprevious() const { return docbookwrappermergewithprevious_; }
+       ///
+       std::string const & docbooksectiontag() const;
+       ///
+       std::string const & docbookitemwrappertag() const;
+       ///
+       std::string const & docbookitemwrapperattr() const;
+       ///
+       std::string const & docbookitemwrappertagtype() const;
+       ///
+       std::string const & docbookitemlabeltag() const;
+       ///
+       std::string const & docbookitemlabelattr() const;
+       ///
+       std::string const & docbookitemlabeltagtype() const;
+       ///
+       std::string const & docbookiteminnertag() const;
+       ///
+       std::string const & docbookiteminnerattr() const;
+       ///
+       std::string const & docbookiteminnertagtype() const;
+       ///
+       std::string const & docbookitemtag() const;
+       ///
+       std::string const & docbookitemattr() const;
+       ///
+       std::string const & docbookitemtagtype() const;
+       ///
+       std::string const & docbookforceabstracttag() const;
+       ///
        bool isParagraph() const { return latextype == LATEX_PARAGRAPH; }
        ///
        bool isCommand() const { return latextype == LATEX_COMMAND; }
@@ -215,7 +274,7 @@ public:
        ///
        bool operator==(Layout const &) const;
        ///
-       bool operator!=(Layout const & rhs) const 
+       bool operator!=(Layout const & rhs) const
                { return !(*this == rhs); }
 
        ////////////////////////////////////////////////////////////////
@@ -304,6 +363,12 @@ public:
        /** true when the fragile commands in the paragraph need to be
            \protect'ed. */
        bool needprotect;
+       /** true when the verbatim stuff of this layout needs to be
+           \cprotect'ed. */
+       bool needcprotect;
+       /** true when specific commands in this paragraph need to be
+           protected in an \mbox. */
+       bool needmboxprotect;
        /// true when empty paragraphs should be kept.
        bool keepempty;
        /// Type of LaTeX object
@@ -353,7 +418,7 @@ private:
        std::string defaultCSSItemClass() const { return defaultCSSClass() + "_item"; }
        ///
        std::string defaultCSSLabelClass() const { return defaultCSSClass() + "_label"; }
-       
+
        /// Name of the layout/paragraph environment
        docstring name_;
 
@@ -398,13 +463,13 @@ private:
        /// Internal tag to surround the item text in a list.
        std::string itemtag_;
        /// The interpretation of this tag varies depending upon the latextype.
-       /// In an environment, it is the tag enclosing all content for this set of 
-       /// paragraphs. So for quote, e.g,. it would be: blockquote. For itemize, 
+       /// In an environment, it is the tag enclosing all content for this set of
+       /// paragraphs. So for quote, e.g,. it would be: blockquote. For itemize,
        /// it would be: ul. (You get the idea.)
        ///
        /// For a command, it is the tag enclosing the content of the command.
        /// So, for section, it might be: h2.
-       /// 
+       ///
        /// For the paragraph type, it is the tag that will enclose each paragraph.
        ///
        /// Defaults to "div".
@@ -414,7 +479,7 @@ private:
        mutable std::string htmlattr_;
        /// Tag for individual paragraphs in an environment. In lists, this
        /// would be something like "li". But it also needs to be set for
-       /// quotation, e.g., since the paragraphs in a quote need to be 
+       /// quotation, e.g., since the paragraphs in a quote need to be
        /// in "p" tags. Default is "div".
        /// Note that when I said "environment", I meant it: This has no
        /// effect for LATEX_PARAGRAPH type layouts.
@@ -423,7 +488,7 @@ private:
        mutable std::string htmlitemattr_;
        /// Tag for labels, of whatever sort. One use for this is in setting
        /// descriptions, in which case it would be: dt. Another use is to
-       /// customize the display of, say, the auto-generated label for 
+       /// customize the display of, say, the auto-generated label for
        /// sections. Defaults to "span".
        /// If set to "NONE", this suppresses the printing of the label.
        mutable std::string htmllabeltag_;
@@ -438,6 +503,56 @@ private:
        bool htmllabelfirst_;
        /// CSS information needed by this layout.
        docstring htmlstyle_;
+       /// DocBook tag corresponding to this layout.
+       mutable std::string docbooktag_;
+       /// Roles to add to docbooktag_, if any (default: none).
+       mutable std::string docbookattr_;
+       /// DocBook tag type corresponding to this layout (block, paragraph, or inline; default: block).
+       mutable std::string docbooktagtype_;
+       /// DocBook tag corresponding to this item (mainly for lists).
+       mutable std::string docbookitemtag_;
+       /// Roles to add to docbookitemtag_, if any (default: none).
+       mutable std::string docbookitemattr_;
+       /// DocBook tag type corresponding to this item (block, paragraph, or inline; default: block).
+       mutable std::string docbookitemtagtype_;
+       /// DocBook tag corresponding to the wrapper around an item (mainly for lists).
+       mutable std::string docbookitemwrappertag_;
+       /// Roles to add to docbookitemwrappertag_, if any (default: none).
+       mutable std::string docbookitemwrapperattr_;
+       /// DocBook tag type corresponding to the wrapper around an item (block, paragraph, or inline; default: block).
+       mutable std::string docbookitemwrappertagtype_;
+       /// DocBook tag corresponding to this label (mostly for description lists;
+       /// labels in the common sense do not exist with DocBook).
+       mutable std::string docbookitemlabeltag_;
+       /// Roles to add to docbooklabeltag_, if any (default: none).
+       mutable std::string docbookitemlabelattr_;
+       /// DocBook tag corresponding to this label (block, paragraph, or inline; default: block).
+       mutable std::string docbookitemlabeltagtype_;
+       /// DocBook tag to add within the item, around its direct content (mainly for lists).
+       mutable std::string docbookiteminnertag_;
+       /// Roles to add to docbookiteminnertag_, if any (default: none).
+       mutable std::string docbookiteminnerattr_;
+       /// DocBook tag to add within the item, around its direct content (block, paragraph, or inline; default: block).
+       mutable std::string docbookiteminnertagtype_;
+       /// DocBook tag corresponding to this wrapper around the main tag.
+       mutable std::string docbookwrappertag_;
+       /// Roles to add to docbookwrappertag_, if any (default: none).
+       mutable std::string docbookwrapperattr_;
+       /// DocBook tag corresponding to this wrapper around the main tag (block, paragraph, or inline; default: block).
+       mutable std::string docbookwrappertagtype_;
+       /// Whether this wrapper tag may be merged with the previously opened wrapper tag.
+       bool docbookwrappermergewithprevious_;
+       /// Outer tag for this section, only if this layout represent a sectionning item, including chapters
+       /// (default: section).
+       mutable std::string docbooksectiontag_;
+       /// Whether this tag must/can/can't go into an <info> tag (default: never, as it only makes sense for metadata).
+       mutable std::string docbookininfo_;
+       /// Wehther this paragraph should be considered as abstract.
+       bool docbookabstract_;
+       /// Whether this element (root or not) does not accept text without a section (i.e. the first text that is met
+       /// in LyX must be considered as the abstract if this is true); this text must be output with the specific tag
+       /// held by this attribute
+       mutable std::string docbookforceabstracttag_;
        /// Should we generate the default CSS for this layout, even if HTMLStyle
        /// has been given? Default is false.
        /// Note that the default CSS is output first, then the user CSS, so it is
@@ -464,12 +579,18 @@ private:
        /// Are adjacent paragraphs handled as one group?
        bool par_group_;
        /// Packages needed for this layout
-       std::set<std::string> requires_;
+       std::set<std::string> required_;
+       /// Layouts that are by default nested after this one
+       std::set<docstring> autonests_;
+       /// Layouts that by auto-nest this one
+       std::set<docstring> autonested_by_;
        ///
        LaTeXArgMap latexargs_;
        ///
        LaTeXArgMap postcommandargs_;
        ///
+       LaTeXArgMap listpreamble_;
+       ///
        LaTeXArgMap itemargs_;
        ///
        bool add_to_toc_;