* Full author contact details are available in file CREDITS.
*/
-#ifndef LYXTEXTCLASS_H
-#define LYXTEXTCLASS_H
+#ifndef TEXTCLASS_H
+#define TEXTCLASS_H
-#include "Layout.h"
-#include "lyxlayout_ptr_fwd.h"
+#include "ColorCode.h"
+#include "FontInfo.h"
+#include "LayoutEnums.h"
+#include "LayoutPtr.h"
+
+#include "insets/InsetLayout.h"
+
+#include "support/docstring.h"
+#include "support/types.h"
#include <boost/shared_ptr.hpp>
namespace support { class FileName; }
+class Layout;
class Lexer;
class Counters;
class FloatList;
-
-///
-class CharStyle {
-public:
- std::string name;
- std::string latextype;
- std::string latexname;
- std::string latexparam;
- Font font;
- Font labelfont;
- docstring preamble;
-};
-
-
-class InsetLayout {
-public:
- docstring labelstring;
- std::string latextype;
- std::string latexname;
- std::string latexparam;
- Font font;
- Font labelfont;
- docstring preamble;
-};
-
-
-/// List of semantically defined character style insets
-typedef std::vector<CharStyle> CharStyles;
-
/// List of inset layouts
typedef std::map<docstring, InsetLayout> InsetLayouts;
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.
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;
/// 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 &);
///
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;
FloatList const & floats() const;
/// The Counters present in this document class.
Counters & counters() const;
- /// CharStyles of this doc class
- CharStyles & charstyles() const { return charstylelist_; };
- /// Inset layouts of this doc class
+ /// Inset layouts of this doc class
+ InsetLayouts & insetlayouts() const { return insetlayoutlist_; };
+ ///
InsetLayout const & insetlayout(docstring const & name) const;
- /// Retrieve element of name s:
- CharStyles::iterator charstyle(std::string const & s) const;
///
docstring const & defaultLayoutName() const;
///
- Layout_ptr const & defaultLayout() const;
+ LayoutPtr const & defaultLayout() const;
///
std::string const & name() 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;
/// 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;
OutputType outputType() const;
///
- Font const & defaultfont() const;
+ FontInfo 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;
+ TitleLatexType titletype() const;
/// The name of the title command
std::string const & titlename() const;
bool hasTocLevels() const;
private:
///
- bool delete_layout(docstring const &);
+ bool deleteLayout(docstring const &);
///
- bool do_readStyle(Lexer &, Layout &);
+ bool readStyle(Lexer &, Layout &);
/// Layout file name
std::string name_;
/// document class name
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_;
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_;
///
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
- 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_;
+ TitleLatexType titletype_;
/// The name of the title command
std::string titlename_;
/// 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_;
/// convert page sides option to text 1 or 2
-std::ostream & operator<<(std::ostream & os, TextClass::PageSides p);
-
+std::ostream & operator<<(std::ostream & os, PageSides p);
} // namespace lyx
projects / lyx.git / blobdiff