Fulfill promise to Andre: TextClass_ptr --> TextClassPtr.

[lyx.git] / src / TextClass.h

diff --git a/src/TextClass.h b/src/TextClass.h
index b5ea3a38b571f19da53ddb269dc37b805eafc6f2..d9a13e84c49baa9a35b6e7ec175acc65b7595e0e 100644 (file)
--- a/src/TextClass.h
+++ b/src/TextClass.h
@@ -10,6 +10,7 @@
 #ifndef LYXTEXTCLASS_H
 #define LYXTEXTCLASS_H
 
+#include "Color.h"
 #include "Layout.h"
 #include "lyxlayout_ptr_fwd.h"
 
@@ -17,6 +18,7 @@
 
 #include <vector>
 #include <set>
+#include <map>
 
 namespace lyx {
 
@@ -28,27 +30,30 @@ class FloatList;
 
 
 ///
-class CharStyle {
+class InsetLayout {
 public:
        std::string name;
+       std::string lyxtype;
+       docstring labelstring;
+       std::string decoration;
        std::string latextype;
        std::string latexname;
        std::string latexparam;
        Font font;
        Font labelfont;
-       docstring preamble;
+       Color::color bgcolor;
+       std::string preamble;
 };
 
 
-/// List of semantically defined character style insets
-typedef std::vector<CharStyle> CharStyles;
-
+/// List of inset layouts
+typedef std::map<docstring, InsetLayout> InsetLayouts;
 
 /// Stores the layout specification of a LyX document class.
 class TextClass {
 public:
        /// The individual styles comprising the document class
-       typedef std::vector<Layout_ptr> LayoutList;
+       typedef std::vector<LayoutPtr> LayoutList;
        /// Enumerate the paragraph styles.
        typedef LayoutList::const_iterator const_iterator;
        /// Construct a layout with default values. Actual values loaded later.
@@ -56,8 +61,8 @@ public:
        TextClass(std::string const & = std::string(),
                     std::string const & = std::string(),
                     std::string const & = std::string(),
-                    bool = false);
-
+                    bool texClassAvail = false);
+       
        /// check whether the TeX class is available
        bool isTeXClassAvailable() const;
 
@@ -66,8 +71,14 @@ public:
        /// paragraph styles end iterator
        const_iterator end() const { return layoutlist_.end(); }
 
+       ///Enum used with TextClass::read
+       enum ReadType { 
+               BASECLASS, //>This is a base class, i.e., top-level layout file
+               MERGE, //>This is a file included in a layout file
+               MODULE //>This is a layout module
+       };
        /// Performs the read of the layout file.
-       bool read(support::FileName const & filename, bool merge = false);
+       bool read(support::FileName const & filename, ReadType rt = BASECLASS);
        ///
        void readOutputType(Lexer &);
        ///
@@ -79,6 +90,8 @@ public:
        ///
        void readCharStyle(Lexer &, std::string const &);
        ///
+       void readInsetLayout(Lexer &, docstring const &);
+       ///
        void readFloat(Lexer &);
        ///
        void readCounter(Lexer &);
@@ -86,7 +99,7 @@ public:
        bool hasLayout(docstring const & name) const;
 
        ///
-       Layout_ptr const & operator[](docstring const & vname) const;
+       LayoutPtr const & operator[](docstring const & vname) const;
 
        /// Sees to that the textclass structure has been loaded
        bool load(std::string const & path = std::string()) const;
@@ -99,21 +112,28 @@ public:
        FloatList const & floats() const;
        /// The Counters present in this document class.
        Counters & counters() const;
-       /// CharStyles of this doc class
-       CharStyles & charstyles() const { return charstylelist_; };
-       /// Retrieve element of name s:
-       CharStyles::iterator charstyle(std::string const & s) const;
+       /// Inset layouts of this doc class
+       InsetLayouts & insetlayouts() const { return insetlayoutlist_; };
+       ///
+       InsetLayout const & insetlayout(docstring const & name) const;
        ///
        docstring const & defaultLayoutName() const;
        ///
-       Layout_ptr const & defaultLayout() const;
+       LayoutPtr const & defaultLayout() const;
        ///
        std::string const & name() const;
        ///
+       docstring const & labelstring() const;
+       ///
        std::string const & latexname() const;
        ///
        std::string const & description() const;
        ///
+       bool isModular() const { return modular_; }
+       /// Sets the layout as a modular one. There is never any
+       /// need to reset this.
+       void markAsModular() { modular_ = true; }
+       ///
        std::string const & opt_fontsize() const;
        ///
        std::string const & opt_pagestyle() const;
@@ -152,10 +172,10 @@ public:
        Font const & defaultfont() const;
 
        /// Text that dictates how wide the left margin is on the screen
-       std::string const & leftmargin() const;
+       docstring const & leftmargin() const;
 
        /// Text that dictates how wide the right margin is on the screen
-       std::string const & rightmargin() const;
+       docstring const & rightmargin() const;
 
        /// The type of command used to produce a title
        LYX_TITLE_LATEX_TYPES titletype() const;
@@ -181,11 +201,14 @@ private:
        std::string latexname_;
        /// document class description
        std::string description_;
-       /// Specific class options
+       /// whether this is a modular layout, i.e., whether it has been
+       /// modified by loading of layout modules.
+       bool modular_;
+       ///
        std::string opt_fontsize_;
        ///
        std::string opt_pagestyle_;
-       ///
+       /// Specific class options
        std::string options_;
        ///
        std::string pagestyle_;
@@ -214,10 +237,10 @@ private:
        */
        Font defaultfont_;
        /// Text that dictates how wide the left margin is on the screen
-       std::string leftmargin_;
+       docstring leftmargin_;
 
        /// Text that dictates how wide the right margin is on the screen
-       std::string rightmargin_;
+       docstring rightmargin_;
 
        /// The type of command used to produce a title
        LYX_TITLE_LATEX_TYPES titletype_;
@@ -226,14 +249,15 @@ private:
 
        /// Paragraph styles used in this layout
        LayoutList layoutlist_;
-       /// CharStyles available to this layout
-       mutable CharStyles charstylelist_;
+
+       /// Input layouts available to this layout
+       mutable InsetLayouts insetlayoutlist_;
 
        /// available types of float, eg. figure, algorithm.
        boost::shared_ptr<FloatList> floatlist_;
 
        /// Types of counters, eg. sections, eqns, figures, avail. in document class.
-       boost::shared_ptr<Counters> ctrs_;
+       boost::shared_ptr<Counters> counters_;
 
        /// Has this layout file been loaded yet?
        mutable bool loaded_;