#include "LayoutEnums.h"
#include "LayoutPtr.h"
+#include "insets/InsetLayout.h"
+
#include "support/docstring.h"
+#include "support/types.h"
#include <boost/shared_ptr.hpp>
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;
- FontInfo font;
- FontInfo labelfont;
- ColorCode bgcolor;
- std::string preamble;
- bool multipar;
- bool passthru;
- bool needprotect;
- bool freespacing;
- bool keepempty;
- bool forceltr;
-};
-
-
/// List of inset layouts
typedef std::map<docstring, InsetLayout> InsetLayouts;
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 &);
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;
///
/// 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;
int max_toclevel() const;
/// returns true if the class has a ToC structure
bool hasTocLevels() const;
+ ///
+ static InsetLayout const & emptyInsetLayout() { return empty_insetlayout_; }
private:
///
bool deleteLayout(docstring const &);
- ///
+ /// \return true for success.
bool readStyle(Lexer &, Layout &);
/// Layout file name
std::string name_;
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_;
///
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