X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLayout.h;h=90d1b2e8edf5ff87dc7501aae47f45331c82d546;hb=a81a0c55349693df59be9239cae2fdfd3333f7a1;hp=b02c5289be2a9f315b3c40dbca3197b0913a5a5e;hpb=37f41fd4b56c54764014c93c003be555f3fd6421;p=lyx.git diff --git a/src/Layout.h b/src/Layout.h index b02c5289be..90d1b2e8ed 100644 --- a/src/Layout.h +++ b/src/Layout.h @@ -75,6 +75,8 @@ 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_; } /// @@ -87,8 +89,6 @@ public: std::string const & latexname() const { return latexname_; } /// std::string const & itemcommand() const { return itemcommand_; } - /// - void setLatexName(std::string const & n) { latexname_ = n; } /// The arguments of this layout struct latexarg { docstring labelstring; @@ -96,6 +96,7 @@ public: bool mandatory; docstring ldelim; docstring rdelim; + docstring defaultarg; docstring presetarg; docstring tooltip; std::string requires; @@ -103,23 +104,35 @@ public: FontInfo font; FontInfo labelfont; bool autoinsert; + bool insertcotext; + ArgPassThru passthru; + docstring pass_thru_chars; + bool is_toc_caption; }; /// typedef std::map LaTeXArgMap; /// - LaTeXArgMap args() const; - /// LaTeXArgMap const & latexargs() const { return latexargs_; } /// LaTeXArgMap const & postcommandargs() const { return postcommandargs_; } /// 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: + /// Layout::LaTeXArgMap::iterator it = args().begin(); + /// Layout::LaTeXArgMap::iterator en = args().end(); + /// Those are iterators for different containers. + LaTeXArgMap args() const; /// int optArgs() const; /// 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_; } @@ -147,25 +160,25 @@ 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_; } @@ -180,11 +193,32 @@ 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 par_group_; } + /// + 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 addToToc() const { return add_to_toc_; } + /// + std::string tocType() const { return toc_type_; } + /// + bool isTocCaption() const { return is_toc_caption_; } /// bool operator==(Layout const &) const; /// - bool operator!=(Layout const & rhs) const + bool operator!=(Layout const & rhs) const { return !(*this == rhs); } //////////////////////////////////////////////////////////////// @@ -256,9 +290,13 @@ public: /// bool nextnoindent; /// + ToggleIndentation toggle_indent; + /// bool free_spacing; /// bool pass_thru; + /// Individual chars to be passed verbatim + docstring pass_thru_chars; /// bool parbreak_is_newline; /// show this in toc @@ -279,6 +317,10 @@ public: bool inpreamble; /// Which counter to step docstring counter; + /// Resume counter? + bool resumecounter; + /// Step master counter? + bool stepmastercounter; /// Prefix to use when creating labels docstring refprefix; /// Depth of XML command @@ -291,16 +333,30 @@ public: /// Is this spellchecked? bool spellcheck; + /** + * Should this layout definition always be written to the document preamble? + * Possible values are: + * 0: Do not enforce local layout + * >=1: Enforce local layout with version forcelocal + * -1: Enforce local layout with infinite version + * On reading, the forced local layout is only used if its version + * number is greater than the version number of the same layout in the + * document class. Otherwise, it is ignored. + */ + int forcelocal; private: + /// Reads a layout definition from file + /// \return true on success. + bool readIgnoreForcelocal(Lexer &, TextClass const &); /// generates the default CSS for this layout void makeDefaultCSS() const; /// std::string defaultCSSItemClass() const { return defaultCSSClass() + "_item"; } /// std::string defaultCSSLabelClass() const { return defaultCSSClass() + "_label"; } - + /// Name of the layout/paragraph environment docstring name_; @@ -345,13 +401,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". @@ -361,7 +417,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. @@ -370,7 +426,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_; @@ -400,7 +456,7 @@ private: mutable std::string defaultcssclass_; /// This is the `category' for this layout. The following are /// recommended basic categories: FrontMatter, BackMatter, MainText, - /// Section, Starred, List, Theorem. + /// Sectioning, Starred, List, Reasoning. docstring category_; /// Macro definitions needed for this layout docstring preamble_; @@ -408,6 +464,8 @@ private: docstring langpreamble_; /// Language and babel dependent macro definitions needed for this layout docstring babelpreamble_; + /// Are adjacent paragraphs handled as one group? + bool par_group_; /// Packages needed for this layout std::set requires_; /// @@ -416,8 +474,15 @@ private: LaTeXArgMap postcommandargs_; /// LaTeXArgMap itemargs_; + /// + bool add_to_toc_; + /// + std::string toc_type_; + /// + bool is_toc_caption_; }; + } // namespace lyx #endif