]> git.lyx.org Git - lyx.git/blobdiff - src/TextClass.h
InsetIndex: enable escaping for terms in the index
[lyx.git] / src / TextClass.h
index 3d063456366bdc6c7eafabdc1890369e43db9426..a4c758f3394569c6ccee89fadd6080e6ed3bee06 100644 (file)
@@ -15,7 +15,6 @@
 #include "DocumentClassPtr.h"
 #include "FloatList.h"
 #include "FontInfo.h"
-#include "Layout.h"
 #include "LayoutEnums.h"
 #include "LayoutModuleList.h"
 
@@ -38,7 +37,6 @@ namespace lyx {
 
 namespace support { class FileName; }
 
-class Counters;
 class FloatList;
 class Layout;
 class LayoutFile;
@@ -211,7 +209,11 @@ public:
        bool hasOutputFormat() const { return has_output_format_; }
        /// Return the non-localised names for the toc types.
        std::map<std::string, docstring> const &
-       outlinerNames() const { return outliner_names_; }
+               outlinerNames() const { return outliner_names_; }
+       /// \returns Layout named \p name if it exists, otherwise 0
+       Layout const * getLayout(docstring const & name) const;
+       /// \returns Layout named \p name if it exists, otherwise 0
+       Layout * getLayout(docstring const & name);
 
 protected:
        /// Protect construction
@@ -299,12 +301,17 @@ protected:
        docstring htmlpreamble_;
        /// same, but specifically for CSS information
        docstring htmlstyles_;
-       /// the paragraph style to use for TOCs, Bibliography, etc
+       /// the paragraph style to use for TOCs, bibliography, etc.
        mutable docstring html_toc_section_;
+       /// root element when exporting as DocBook
+       std::string docbookroot_;
+       /// whether this root element 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 within <info> and <abstract>
+       bool docbookforceabstract_;
        /// latex packages loaded by document class.
        std::set<std::string> provides_;
        /// latex packages requested by document class.
-       std::set<std::string> requires_;
+       std::set<std::string> required_;
        ///
        std::map<std::string, std::string> package_options_;
        /// default modules wanted by document class
@@ -380,7 +387,7 @@ private:
        /// Reads the layout file without running layout2layout.
        ReturnValues readWithoutConv(support::FileName const & filename, ReadType rt);
        /// \return true for success.
-       bool readStyle(Lexer &, Layout &) const;
+       bool readStyle(Lexer &, Layout &, ReadType) const;
        ///
        void readOutputType(Lexer &);
        ///
@@ -426,7 +433,7 @@ public:
        /// \return true if there is a Layout with latexname lay
        bool hasLaTeXLayout(std::string const & lay) const;
        /// A DocumentClass nevers count as loaded, since it is dynamic
-       virtual bool loaded() const { return false; }
+       bool loaded() const override { return false; }
        /// \return the layout object of an inset given by name. If the name
        /// is not found as such, the part after the ':' is stripped off, and
        /// searched again. In this way, an error fallback can be provided:
@@ -480,6 +487,10 @@ public:
        docstring const & htmlpreamble() const { return htmlpreamble_; }
        ///
        docstring const & htmlstyles() const { return htmlstyles_; }
+       ///
+       bool docbookforceabstract() const { return docbookforceabstract_; }
+       ///
+       std::string const & docbookroot() const { return docbookroot_; }
        /// Looks for the layout of "highest level", other than Part (or other
        /// layouts with a negative toc number), for use in constructing TOCs and
        /// similar information.
@@ -490,7 +501,7 @@ public:
        /// is this feature already provided by the class?
        bool provides(std::string const & p) const;
        /// features required by the class?
-       std::set<std::string> const & requires() const { return requires_; }
+       std::set<std::string> const & required() const { return required_; }
        /// package options to write to LaTeX file
        std::map<std::string, std::string> const & packageOptions() const
                { return package_options_; }
@@ -540,9 +551,9 @@ public:
        /// The maximum number of citations before "et al."
        size_t max_citenames() const { return maxcitenames_; }
        ///
-       bool const & fullAuthorList() const { return cite_full_author_list_; }
+       bool fullAuthorList() const { return cite_full_author_list_; }
        ///
-       bool const & bibInToc() const { return bibintoc_; }
+       bool bibInToc() const { return bibintoc_; }
 protected:
        /// Constructs a DocumentClass based upon a LayoutFile.
        DocumentClass(LayoutFile const & tc);
@@ -553,7 +564,7 @@ private:
        friend DocumentClassPtr
                getDocumentClass(LayoutFile const &, LayoutModuleList const &,
                                 std::string const &,
-                                bool const clone);
+                                bool clone, bool internal);
 };
 
 
@@ -564,7 +575,7 @@ private:
 DocumentClassPtr getDocumentClass(LayoutFile const & baseClass,
                        LayoutModuleList const & modlist,
                        std::string const & cengine = std::string(),
-                       bool const clone = false);
+                       bool clone = false, bool internal = false);
 
 /// convert page sides option to text 1 or 2
 std::ostream & operator<<(std::ostream & os, PageSides p);