* lfun doc

[lyx.git] / src / Layout.h

diff --git a/src/Layout.h b/src/Layout.h
index 4eb8412723b9263d75427e4b71afcef11b4801d0..e837339c4976cf9f366742400ca71ca3bf845fa7 100644 (file)
--- a/src/Layout.h
+++ b/src/Layout.h
@@ -89,7 +89,7 @@ public:
        std::string const & latexname() const { return latexname_; }
        ///
        std::string const & itemcommand() const { return itemcommand_; }
-       /// The arguments of this layout
+       /// One argument of this layout
        struct latexarg {
                docstring labelstring;
                docstring menustring;
@@ -112,10 +112,16 @@ public:
                bool is_toc_caption = false;
                bool free_spacing = false;
                std::string newlinecmd;
+               /// The DocBook tag corresponding to this argument.
                docstring docbooktag;
                docstring docbooktagtype;
                docstring docbookattr;
+               /// Whether this argument should be output after the main tag (default: inside). The result if the argument
+               /// should be output both before and after the main tag is undefined.
                bool docbookargumentbeforemaintag = false;
+               /// Whether this argument should be output before the main tag (default: inside). The result if the argument
+               /// should be output both before and after the main tag is undefined.
+               bool docbookargumentaftermaintag = false;
        };
        ///
        typedef std::map<std::string, latexarg> LaTeXArgMap;
@@ -177,7 +183,11 @@ public:
        ///
        std::string const & htmltag() const;
        ///
-       std::string const & htmlattr() const;
+       std::string const & htmlattr() const { return htmlattr_; }
+       ///
+       std::string const & htmlclass() const;
+       /// Returns a complete attribute string, including class, etc.
+       std::string const & htmlGetAttrString() const;
        ///
        std::string const & htmlitemtag() const;
        ///
@@ -187,6 +197,8 @@ public:
        ///
        std::string const & htmllabelattr() const;
        ///
+       bool htmlintoc() const { return htmlintoc_; }
+       ///
        std::string defaultCSSClass() const;
        ///
        bool htmllabelfirst() const { return htmllabelfirst_; }
@@ -402,11 +414,6 @@ public:
        /// Depth of XML command
        int commanddepth;
 
-       /// Return a pointer on a new layout suitable to describe a caption.
-       /// FIXME: remove this eventually. This is only for tex2lyx
-       /// until it has proper support for the caption inset (JMarc)
-       static Layout * forCaption();
-
        /// Is this spellchecked?
        bool spellcheck;
        /**
@@ -488,9 +495,13 @@ private:
        ///
        /// Defaults to "div".
        mutable std::string htmltag_;
-       /// Additional attributes for inclusion with the start tag. Defaults
-       /// to: class="layoutname".
-       mutable std::string htmlattr_;
+       /// Additional attributes for inclusion with the start tag.
+       /// Note that the CSS class is handled separately.
+       std::string htmlattr_;
+       /// The CSS class to use. Calculated from the layout name if not given.
+       mutable std::string htmlclass_;
+       /// cached
+       mutable std::string htmlfullattrs_;
        /// 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
@@ -515,6 +526,8 @@ private:
        ///    <item><label>...</label>...</item>
        /// The latter is the default.
        bool htmllabelfirst_;
+       /// Is this to be output with the toc?
+       bool htmlintoc_;
        /// CSS information needed by this layout.
        docstring htmlstyle_;
        /// DocBook tag corresponding to this layout.