]> git.lyx.org Git - lyx.git/blobdiff - src/Layout.h
Natbib authoryear uses (Ref1; Ref2) by default.
[lyx.git] / src / Layout.h
index de4176526f88d6f4bd3a08d8929976a00356150f..b7c6e708cd1f1c02db73fb28ec3a8b6ce212ee16 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,6 +74,10 @@ public:
        ///
        void readSpacing(Lexer &);
        ///
+       void readArgument(Lexer &);
+       /// Write a layout definition in utf8 encoding
+       void write(std::ostream &) const;
+       ///
        docstring const & name() const { return name_; }
        ///
        void setName(docstring const & n) { name_ = n; }
@@ -83,7 +88,37 @@ public:
        ///
        std::string const & latexname() const { return latexname_; }
        ///
-       void setLatexName(std::string const & n) { latexname_ = n; }
+       std::string const & itemcommand() const { return itemcommand_; }
+       /// The arguments of this layout
+       struct latexarg {
+               docstring labelstring;
+               docstring menustring;
+               bool mandatory;
+               docstring ldelim;
+               docstring rdelim;
+               docstring defaultarg;
+               docstring presetarg;
+               docstring tooltip;
+               std::string requires;
+               std::string decoration;
+               FontInfo font;
+               FontInfo labelfont;
+               bool autoinsert;
+       };
+       ///
+       typedef std::map<std::string, latexarg> LaTeXArgMap;
+       ///
+       LaTeXArgMap args() const;
+       ///
+       LaTeXArgMap const & latexargs() const { return latexargs_; }
+       ///
+       LaTeXArgMap const & postcommandargs() const { return postcommandargs_; }
+       ///
+       LaTeXArgMap const & itemargs() const { return itemargs_; }
+       ///
+       int optArgs() const;
+       ///
+       int requiredArgs() const;
        ///
        docstring const & labelstring(bool in_appendix) const 
        { return in_appendix ? labelstring_appendix_ : labelstring_; }
@@ -95,15 +130,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 +161,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; }
@@ -138,6 +181,24 @@ public:
                        || latextype == LATEX_ITEM_ENVIRONMENT
                        || latextype == LATEX_LIST_ENVIRONMENT;
        }
+       /// Is this the kind of layout in which adjacent paragraphs
+       /// are handled as one group?
+       bool isParagraphGroup() const {
+       return latextype == LATEX_ENVIRONMENT
+               || latextype == LATEX_BIB_ENVIRONMENT;
+       }
+       ///
+       bool labelIsInline() const {
+               return labeltype == LABEL_STATIC
+                       || labeltype == LABEL_SENSITIVE
+                 || labeltype == LABEL_ENUMERATE
+                       || labeltype == LABEL_ITEMIZE;
+       }
+       bool labelIsAbove() const {
+               return labeltype == LABEL_ABOVE
+                       || labeltype == LABEL_CENTERED
+                 || labeltype == LABEL_BIBLIO;
+       }
 
        ///
        bool operator==(Layout const &) const;
@@ -210,10 +271,6 @@ public:
        ///
        MarginType margintype;
        ///
-       bool fill_top;
-       ///
-       bool fill_bottom;
-       ///
        bool newline_allowed;
        ///
        bool nextnoindent;
@@ -221,6 +278,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 +294,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,13 +308,14 @@ 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 defaultCSSClass() + "_item"; }
        ///
        std::string defaultCSSLabelClass() const { return defaultCSSClass() + "_label"; }
@@ -289,6 +351,12 @@ private:
        docstring labelstring_appendix_;
        /// LaTeX parameter for environment
        std::string latexparam_;
+       /// Item command in lists
+       std::string itemcommand_;
+       /// 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)
@@ -345,6 +413,8 @@ private:
        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 +429,12 @@ private:
        docstring babelpreamble_;
        /// Packages needed for this layout
        std::set<std::string> requires_;
+       ///
+       LaTeXArgMap latexargs_;
+       ///
+       LaTeXArgMap postcommandargs_;
+       ///
+       LaTeXArgMap itemargs_;
 };
 
 } // namespace lyx