This is the first of a series of commits that will make InsetLayout a real class.

[lyx.git] / src / TextClass.h

diff --git a/src/TextClass.h b/src/TextClass.h
index 4f50311df3caa7791d2a8dc5712eb0e916191fca..818ce6a56dfb4ec69c40058f6b99980e32fadeb3 100644 (file)
--- a/src/TextClass.h
+++ b/src/TextClass.h
@@ -7,13 +7,18 @@
  * Full author contact details are available in file CREDITS.
  */
 
-#ifndef LYXTEXTCLASS_H
-#define LYXTEXTCLASS_H
+#ifndef TEXTCLASS_H
+#define TEXTCLASS_H
 
-#include "Color.h"
-#include "Font.h"
+#include "ColorCode.h"
+#include "FontInfo.h"
 #include "LayoutEnums.h"
-#include "lyxlayout_ptr_fwd.h"
+#include "LayoutPtr.h"
+
+#include "insets/InsetLayout.h"
+
+#include "support/docstring.h"
+#include "support/types.h"
 
 #include <boost/shared_ptr.hpp>
 
@@ -30,25 +35,6 @@ class Lexer;
 class Counters;
 class FloatList;
 
-
-///
-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;
-       Color::color bgcolor;
-       std::string preamble;
-       bool multipar;
-};
-
-
 /// List of inset layouts
 typedef std::map<docstring, InsetLayout> InsetLayouts;
 
@@ -81,6 +67,7 @@ public:
                MODULE //>This is a layout module
        };
        /// Performs the read of the layout file.
+       /// \return true on success.
        bool read(support::FileName const & filename, ReadType rt = BASECLASS);
        ///
        void readOutputType(Lexer &);
@@ -123,6 +110,13 @@ public:
        docstring const & defaultLayoutName() const;
        ///
        LayoutPtr const & defaultLayout() const;
+       /// returns a special layout for use when we don't really want one,
+       /// e.g., in table cells
+       LayoutPtr const & emptyLayout() const 
+                       { return operator[](emptylayout_); };
+       ///
+       docstring const & emptyLayoutName() const 
+                       { return emptylayout_; }
        ///
        std::string const & name() const;
        ///
@@ -151,17 +145,12 @@ 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_; }
 
        ///
        unsigned int columns() const;
        ///
-       enum PageSides {
-               ///
-               OneSide,
-               ///
-               TwoSides
-       };
-       ///
        PageSides sides() const;
        ///
        int secnumdepth() const;
@@ -172,7 +161,7 @@ public:
        OutputType outputType() const;
 
        ///
-       Font const & defaultfont() const;
+       FontInfo const & defaultfont() const;
 
        /// Text that dictates how wide the left margin is on the screen
        docstring const & leftmargin() const;
@@ -193,11 +182,13 @@ public:
        int max_toclevel() const;
        /// returns true if the class has a ToC structure
        bool hasTocLevels() const;
-private:
        ///
-       bool delete_layout(docstring const &);
+       static InsetLayout const & emptyInsetLayout() { return empty_insetlayout_; }
+private:
        ///
-       bool do_readStyle(Lexer &, Layout &);
+       bool deleteLayout(docstring const &);
+       /// \return true for success.
+       bool readStyle(Lexer &, Layout &);
        /// Layout file name
        std::string name_;
        /// document class name
@@ -219,10 +210,14 @@ private:
        std::string class_header_;
        ///
        docstring defaultlayout_;
+       /// name of empty layout
+       static const docstring emptylayout_;
        /// preamble text to support layout styles
        docstring preamble_;
        /// latex packages loaded by document class.
        std::set<std::string> provides_;
+       /// latex packages requested by document class.
+       std::set<std::string> requires_;
        ///
        unsigned int columns_;
        ///
@@ -235,10 +230,10 @@ private:
        OutputType outputType_;
        /** Base font. The paragraph and layout fonts are resolved against
            this font. This has to be fully instantiated. Attributes
-           Font::INHERIT, Font::IGNORE, and Font::TOGGLE are
+           FONT_INHERIT, FONT_IGNORE, and FONT_TOGGLE are
            extremely illegal.
        */
-       Font defaultfont_;
+       FontInfo defaultfont_;
        /// Text that dictates how wide the left margin is on the screen
        docstring leftmargin_;
 
@@ -272,18 +267,13 @@ private:
        int min_toclevel_;
        /// The maximal TocLevel of sectioning layouts
        int max_toclevel_;
+       ///
+       static InsetLayout empty_insetlayout_;
 };
 
 
 /// convert page sides option to text 1 or 2
-std::ostream & operator<<(std::ostream & os, TextClass::PageSides p);
-
-/** Shared pointer for possibly modular layout. Needed so that paste,
- *  for example, will still be able to retain the pointer, even when
- *  the buffer itself is closed.
- */
-typedef boost::shared_ptr<TextClass> TextClassPtr;
-
+std::ostream & operator<<(std::ostream & os, PageSides p);
 
 } // namespace lyx