* Full author contact details are available in file CREDITS.
*/
-#ifndef LYX_LAYOUT_H
-#define LYX_LAYOUT_H
+#ifndef LAYOUT_H
+#define LAYOUT_H
-#include "Font.h"
-#include "layout.h"
+#include "FontInfo.h"
+#include "LayoutEnums.h"
#include "Spacing.h"
#include "support/docstring.h"
+#include <set>
#include <string>
-
namespace lyx {
class Lexer;
class TextClass;
+/* Fix labels are printed flushright, manual labels flushleft.
+ * MARGIN_MANUAL and MARGIN_FIRST_DYNAMIC are *only* for LABEL_MANUAL,
+ * MARGIN_DYNAMIC and MARGIN_STATIC are *not* for LABEL_MANUAL.
+ * This seems a funny restriction, but I think other combinations are
+ * not needed, so I will not change it yet.
+ * Correction: MARGIN_FIRST_DYNAMIC also usable with LABEL_STATIC
+ */
+
+
+/* There is a parindent and a parskip. Which one is used depends on the
+ * paragraph_separation-flag of the text-object.
+ * BUT: parindent is only thrown away, if a parskip is defined! So if you
+ * want a space between the paragraphs and a parindent at the same time,
+ * you should set parskip to zero and use topsep, parsep and bottomsep.
+ *
+ * The standard layout is an exception: its parindent is only set, if the
+ * previous paragraph is standard too. Well, this is LateX and it is good!
+ */
+
///
class Layout {
public:
///
Layout();
- ///
+ /// is this layout a default layout created for an unknown layout
+ bool isUnknown() const { return unknown_; }
+ void setUnknown(bool unknown) { unknown_ = unknown; }
+ /// Reads a layout definition from file
+ /// \return true on success.
bool read(Lexer &, TextClass const &);
///
void readAlign(Lexer &);
///
void readSpacing(Lexer &);
///
- std::string const & name() const;
+ docstring const & name() const;
///
- void setName(std::string const & n);
+ void setName(docstring const & n);
///
- std::string const & obsoleted_by() const;
+ docstring const & obsoleted_by() const;
///
- std::string const & depends_on() const;
+ docstring const & depends_on() const;
///
std::string const & latexname() const { return latexname_; }
///
- lyx::docstring const & labelstring() const { return labelstring_; }
+ docstring const & labelstring() const { return labelstring_; }
+ ///
+ docstring const & endlabelstring() const { return endlabelstring_; }
///
- lyx::docstring const & endlabelstring() const { return endlabelstring_; }
+ docstring const & category() const { return category_; }
///
docstring const & preamble() const { return preamble_; }
///
+ std::set<std::string> const & requires() const { return requires_; }
+ ///
std::string const & latexparam() const { return latexparam_; }
///
std::string const & innertag() const { return innertag_; }
///
std::string const & itemtag() const { return itemtag_; }
///
- lyx::docstring const & labelstring_appendix() const {
+ docstring const & labelstring_appendix() const {
return labelstring_appendix_;
}
+ ///
+ bool isParagraph() const { return latextype == LATEX_PARAGRAPH; }
+ ///
+ bool isCommand() const { return latextype == LATEX_COMMAND; }
+ ///
+ bool isEnvironment() const {
+ return latextype == LATEX_ENVIRONMENT
+ || latextype == LATEX_BIB_ENVIRONMENT
+ || latextype == LATEX_ITEM_ENVIRONMENT
+ || latextype == LATEX_LIST_ENVIRONMENT;
+ }
+
+ ///
+ bool operator==(Layout const &) const;
+ ///
+ bool operator!=(Layout const & rhs) const
+ { return !(*this == rhs); }
+
+ ////////////////////////////////////////////////////////////////
+ // members
+ ////////////////////////////////////////////////////////////////
+ /** Is this layout the default layout for an unknown layout? If
+ * so, its name will be displayed as xxx (unknown).
+ */
+ bool unknown_;
+
/** Default font for this layout/environment.
The main font for this kind of environment. If an attribute has
- Font::INHERITED_*, it means that the value is specified by
+ INHERITED_*, it means that the value is specified by
the defaultfont for the entire layout. If we are nested, the
font is inherited from the font in the environment one level
- up until the font is resolved. The values Font::IGNORE_*
- and Font::TOGGLE are illegal here.
+ up until the font is resolved. The values :IGNORE_*
+ and FONT_TOGGLE are illegal here.
*/
- Font font;
+ FontInfo font;
/** Default font for labels.
Interpretation the same as for font above
*/
- Font labelfont;
+ FontInfo labelfont;
/** Resolved version of the font for this layout/environment.
This is a resolved version the default font. The font is resolved
against the defaultfont of the entire layout.
*/
- Font resfont;
+ FontInfo resfont;
/** Resolved version of the font used for labels.
This is a resolved version the label font. The font is resolved
against the defaultfont of the entire layout.
*/
- Font reslabelfont;
+ FontInfo reslabelfont;
/// 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;
/// Text that dictates how much space to leave after a potential label
- std::string labelsep;
+ docstring labelsep;
/// Text that dictates how much space to leave before a potential label
- std::string labelindent;
+ docstring labelindent;
/// Text that dictates the width of the indentation of indented pars
- std::string parindent;
+ docstring parindent;
///
double parskip;
///
///
LyXAlignment alignpossible;
///
- LYX_LABEL_TYPES labeltype;
+ LabelType labeltype;
///
- LYX_END_LABEL_TYPES endlabeltype;
+ EndLabelType endlabeltype;
///
- LYX_MARGIN_TYPE margintype;
+ MarginType margintype;
///
bool fill_top;
///
bool free_spacing;
///
bool pass_thru;
- /**
- * Whether this layout was declared with "Environment xxx" as opposed
- * to "Style xxx". This is part of some unfinished generic environment
- * handling (see also InsetEnvironment) started by Andre. No layout
- * that is shipped with LyX has this flag set.
- * Don't confuse this with isEnvironment()!
- */
- bool is_environment;
/// show this in toc
int toclevel;
/// special value of toclevel for non-section layouts
bool needprotect;
/// true when empty paragraphs should be kept.
bool keepempty;
- ///
- bool isParagraph() const {
- return latextype == LATEX_PARAGRAPH;
- }
- ///
- bool isCommand() const {
- return latextype == LATEX_COMMAND;
- }
- ///
- bool isEnvironment() const {
- return (latextype == LATEX_ENVIRONMENT
- || latextype == LATEX_BIB_ENVIRONMENT
- || latextype == LATEX_ITEM_ENVIRONMENT
- || latextype == LATEX_LIST_ENVIRONMENT);
- }
/// Type of LaTeX object
- LYX_LATEX_TYPES latextype;
+ LatexType latextype;
/// Does this object belong in the title part of the document?
bool intitle;
/// Does this layout allow for an optional parameter?
int optionalargs;
/// Which counter to step
- lyx::docstring counter;
+ docstring counter;
/// Depth of XML command
int commanddepth;
-private:
+ /// Return a pointer on a new layout suitable to describe a caption.
+ /// FIXME: remove this eventually. This is only for tex2lyx
+ /// until it has proper support for the caption inset (JMarc)
+ static Layout * forCaption();
+
/// Name of the layout/paragraph environment
- std::string name_;
+ docstring name_;
+ /// LaTeX name for environment
+ std::string latexname_;
+private:
/** Name of an layout that has replaced this layout.
This is used to rename a layout, while keeping backward
compatibility
*/
- std::string obsoleted_by_;
+ docstring obsoleted_by_;
/** Name of an layout which preamble must come before this one
This is used when the preamble snippet uses macros defined in
another preamble
*/
- std::string depends_on_;
+ docstring depends_on_;
- /// LaTeX name for environment
- std::string latexname_;
/// Label string. "Abstract", "Reference", "Caption"...
- lyx::docstring labelstring_;
+ docstring labelstring_;
///
- lyx::docstring endlabelstring_;
+ docstring endlabelstring_;
/// Label string inside appendix. "Appendix", ...
- lyx::docstring labelstring_appendix_;
+ docstring labelstring_appendix_;
/// LaTeX parameter for environment
std::string latexparam_;
/// Internal tag to use (e.g., <title></title> for sect header)
std::string labeltag_;
/// Internal tag to surround the item text in a list)
std::string itemtag_;
+ /// This is the `category' for this layout. The following are
+ /// recommended basic categories: FrontMatter, BackMatter, MainText,
+ /// Section, Starred, List, Theorem.
+ docstring category_;
/// Macro definitions needed for this layout
docstring preamble_;
+ /// Packages needed for this layout
+ std::set<std::string> requires_;
};
-
} // namespace lyx
#endif
projects / lyx.git / blobdiff