]> git.lyx.org Git - lyx.git/blobdiff - src/Layout.h
Allow for some argument visual customization
[lyx.git] / src / Layout.h
index 2601baad068a93186b654e6e46e104f1305a61e2..b0c3ac5bad36eab221f67dc81bbaa0a504bff0cd 100644 (file)
 #include "FontInfo.h"
 #include "LayoutEnums.h"
 #include "Spacing.h"
+#include "support/debug.h"
 #include "support/docstring.h"
 
+#include <map>
 #include <set>
 #include <string>
 
 namespace lyx {
 
-class Language;
 class Lexer;
 class TextClass;
 
@@ -73,7 +74,9 @@ public:
        ///
        void readSpacing(Lexer &);
        ///
-       docstring const & name() const { return name_; };
+       void readArgument(Lexer &);
+       ///
+       docstring const & name() const { return name_; }
        ///
        void setName(docstring const & n) { name_ = n; }
        ///
@@ -84,6 +87,26 @@ public:
        std::string const & latexname() const { return latexname_; }
        ///
        void setLatexName(std::string const & n) { latexname_ = n; }
+       /// The arguments of this layout
+       struct latexarg {
+               docstring labelstring;
+               bool mandatory;
+               docstring ldelim;
+               docstring rdelim;
+               docstring tooltip;
+               std::string requires;
+               std::string decoration;
+               FontInfo font;
+               FontInfo labelfont;
+       };
+       ///
+       typedef std::map<unsigned int, latexarg> LaTeXArgMap;
+       ///
+       LaTeXArgMap const & latexargs() const { return latexargs_; }
+       ///
+       int optArgs() const;
+       ///
+       int requiredArgs() const;
        ///
        docstring const & labelstring(bool in_appendix) const 
        { return in_appendix ? labelstring_appendix_ : labelstring_; }
@@ -95,15 +118,19 @@ public:
        docstring const & preamble() const { return preamble_; }
        /// Get language dependent macro definitions needed for this layout
        /// for language \p lang
-       docstring const langpreamble(Language const * lang) const;
+       docstring const langpreamble() const { return langpreamble_; }
        /// Get language and babel dependent macro definitions needed for
        /// this layout for language \p lang
-       docstring const babelpreamble(Language const * lang) const;
+       docstring const babelpreamble() const { return babelpreamble_; }
        ///
        std::set<std::string> const & requires() const { return requires_; }
        ///
        std::string const & latexparam() const { return latexparam_; }
        ///
+       docstring leftdelim() const { return leftdelim_; }
+       ///
+       docstring rightdelim() const { return rightdelim_; }
+       ///
        std::string const & innertag() const { return innertag_; }
        ///
        std::string const & labeltag() const { return labeltag_; }
@@ -122,12 +149,16 @@ public:
        /// 
        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_; }
+       ///
        bool isParagraph() const { return latextype == LATEX_PARAGRAPH; }
        ///
        bool isCommand() const { return latextype == LATEX_COMMAND; }
@@ -210,10 +241,6 @@ public:
        ///
        MarginType margintype;
        ///
-       bool fill_top;
-       ///
-       bool fill_bottom;
-       ///
        bool newline_allowed;
        ///
        bool nextnoindent;
@@ -221,6 +248,8 @@ public:
        bool free_spacing;
        ///
        bool pass_thru;
+       ///
+       bool parbreak_is_newline;
        /// show this in toc
        int toclevel;
        /// special value of toclevel for non-section layouts
@@ -235,10 +264,12 @@ public:
        LatexType latextype;
        /// Does this object belong in the title part of the document?
        bool intitle;
-       /// Does this layout allow for an optional parameter?
-       int optionalargs;
+       /// Is the content to go in the preamble rather than the body?
+       bool inpreamble;
        /// Which counter to step
        docstring counter;
+       /// Prefix to use when creating labels
+       docstring refprefix;
        /// Depth of XML command
        int commanddepth;
 
@@ -247,16 +278,17 @@ public:
        /// until it has proper support for the caption inset (JMarc)
        static Layout * forCaption();
 
+       /// Is this spellchecked?
+       bool spellcheck;
+
 
 private:
        /// generates the default CSS for this layout
        void makeDefaultCSS() const;
        ///
-       std::string defaultCSSClass() const;
-       ///
-       std::string defaultCSSItemClass() const { return to_utf8(name()) + "item"; }
+       std::string defaultCSSItemClass() const { return defaultCSSClass() + "_item"; }
        ///
-       std::string defaultCSSLabelClass() const { return to_utf8(name()) + "label"; }
+       std::string defaultCSSLabelClass() const { return defaultCSSClass() + "_label"; }
        
        /// Name of the layout/paragraph environment
        docstring name_;
@@ -289,6 +321,10 @@ private:
        docstring labelstring_appendix_;
        /// LaTeX parameter for environment
        std::string latexparam_;
+       /// Left delimiter of the content
+       docstring leftdelim_;
+       /// Right delimiter of the content
+       docstring rightdelim_;
        /// Internal tag to use (e.g., <title></title> for sect header)
        std::string innertag_;
        /// Internal tag to use (e.g. to surround varentrylist label)
@@ -317,7 +353,7 @@ private:
        /// Note that when I said "environment", I meant it: This has no
        /// effect for LATEX_PARAGRAPH type layouts.
        mutable std::string htmlitemtag_;
-       /// Attributes for htmlitemtag_. Default is: class="layoutnameitem".
+       /// Attributes for htmlitemtag_. Default is: class="layoutname_item".
        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
@@ -325,7 +361,7 @@ private:
        /// sections. Defaults to "span".
        /// If set to "NONE", this suppresses the printing of the label.
        mutable std::string htmllabeltag_;
-       /// Attributes for the label. Defaults to: class="layoutnamelabel".
+       /// Attributes for the label. Defaults to: class="layoutname_label".
        mutable std::string htmllabelattr_;
        /// Whether to put the label before the item, or within the item.
        /// I.e., do we have (true):
@@ -340,11 +376,13 @@ private:
        /// has been given? Default is false.
        /// Note that the default CSS is output first, then the user CSS, so it is
        /// possible to override what one does not want.
-       bool htmlforcedefault_;
+       bool htmlforcecss_;
        /// A cache for the default style info so generated.
        mutable docstring htmldefaultstyle_;
        /// Any other info for the HTML header.
        docstring htmlpreamble_;
+       /// Whether this is the <title> paragraph.
+       bool htmltitle_;
        /// calculating this is expensive, so we cache it.
        mutable std::string defaultcssclass_;
        /// This is the `category' for this layout. The following are
@@ -359,6 +397,8 @@ private:
        docstring babelpreamble_;
        /// Packages needed for this layout
        std::set<std::string> requires_;
+       ///
+       LaTeXArgMap latexargs_;
 };
 
 } // namespace lyx