4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
11 * Full author contact details are available in file CREDITS.
18 #include "LayoutEnums.h"
20 #include "support/docstring.h"
30 /* Fix labels are printed flushright, manual labels flushleft.
31 * MARGIN_MANUAL and MARGIN_FIRST_DYNAMIC are *only* for LABEL_MANUAL,
32 * MARGIN_DYNAMIC and MARGIN_STATIC are *not* for LABEL_MANUAL.
33 * This seems a funny restriction, but I think other combinations are
34 * not needed, so I will not change it yet.
35 * Correction: MARGIN_FIRST_DYNAMIC also usable with LABEL_STATIC
39 /* There is a parindent and a parskip. Which one is used depends on the
40 * paragraph_separation-flag of the text-object.
41 * BUT: parindent is only thrown away, if a parskip is defined! So if you
42 * want a space between the paragraphs and a parindent at the same time,
43 * you should set parskip to zero and use topsep, parsep and bottomsep.
45 * The standard layout is an exception: its parindent is only set, if the
46 * previous paragraph is standard too. Well, this is LateX and it is good!
54 /// Reads a layout definition from file
55 /// \return true on success.
56 bool read(Lexer &, TextClass const &);
58 void readAlign(Lexer &);
60 void readAlignPossible(Lexer &);
62 void readLabelType(Lexer &);
64 void readEndLabelType(Lexer &);
66 void readMargin(Lexer &);
68 void readLatexType(Lexer &);
70 void readSpacing(Lexer &);
72 docstring const & name() const;
74 void setName(docstring const & n);
76 docstring const & obsoleted_by() const;
78 docstring const & depends_on() const;
80 std::string const & latexname() const { return latexname_; }
82 docstring const & labelstring() const { return labelstring_; }
84 docstring const & endlabelstring() const { return endlabelstring_; }
86 docstring const & preamble() const { return preamble_; }
88 std::set<std::string> const & requires() const { return requires_; }
90 std::string const & latexparam() const { return latexparam_; }
92 std::string const & innertag() const { return innertag_; }
94 std::string const & labeltag() const { return labeltag_; }
96 std::string const & itemtag() const { return itemtag_; }
98 docstring const & labelstring_appendix() const {
99 return labelstring_appendix_;
101 /** Default font for this layout/environment.
102 The main font for this kind of environment. If an attribute has
103 INHERITED_*, it means that the value is specified by
104 the defaultfont for the entire layout. If we are nested, the
105 font is inherited from the font in the environment one level
106 up until the font is resolved. The values :IGNORE_*
107 and FONT_TOGGLE are illegal here.
111 /** Default font for labels.
112 Interpretation the same as for font above
116 /** Resolved version of the font for this layout/environment.
117 This is a resolved version the default font. The font is resolved
118 against the defaultfont of the entire layout.
122 /** Resolved version of the font used for labels.
123 This is a resolved version the label font. The font is resolved
124 against the defaultfont of the entire layout.
126 FontInfo reslabelfont;
128 /// Text that dictates how wide the left margin is on the screen
129 docstring leftmargin;
130 /// Text that dictates how wide the right margin is on the screen
131 docstring rightmargin;
132 /// Text that dictates how much space to leave after a potential label
134 /// Text that dictates how much space to leave before a potential label
135 docstring labelindent;
136 /// Text that dictates the width of the indentation of indented pars
147 double labelbottomsep;
155 LyXAlignment alignpossible;
159 EndLabelType endlabeltype;
161 MarginType margintype;
167 bool newline_allowed;
175 * Whether this layout was declared with "Environment xxx" as opposed
176 * to "Style xxx". This is part of some unfinished generic environment
177 * handling (see also InsetEnvironment) started by Andre. No layout
178 * that is shipped with LyX has this flag set.
179 * Don't confuse this with isEnvironment()!
184 /// special value of toclevel for non-section layouts
185 static const int NOT_IN_TOC;
186 /// for new environment insets
187 std::string latexheader;
188 /// for new environment insets
189 std::string latexfooter;
190 /// for new environment insets
191 std::string latexparagraph;
193 /** true when the fragile commands in the paragraph need to be
196 /// true when empty paragraphs should be kept.
199 bool isParagraph() const { return latextype == LATEX_PARAGRAPH; }
201 bool isCommand() const { return latextype == LATEX_COMMAND; }
203 bool isEnvironment() const {
204 return latextype == LATEX_ENVIRONMENT
205 || latextype == LATEX_BIB_ENVIRONMENT
206 || latextype == LATEX_ITEM_ENVIRONMENT
207 || latextype == LATEX_LIST_ENVIRONMENT;
209 /// Type of LaTeX object
211 /// Does this object belong in the title part of the document?
213 /// Does this layout allow for an optional parameter?
215 /// Which counter to step
217 /// Depth of XML command
220 /// Return a pointer on a new layout suitable to describe a caption.
221 /// FIXME: remove this eventually. This is only for tex2lyx
222 /// until it has proper support for the caption inset (JMarc)
223 static Layout * forCaption();
226 /// Name of the layout/paragraph environment
229 /** Name of an layout that has replaced this layout.
230 This is used to rename a layout, while keeping backward
233 docstring obsoleted_by_;
235 /** Name of an layout which preamble must come before this one
236 This is used when the preamble snippet uses macros defined in
239 docstring depends_on_;
241 /// LaTeX name for environment
242 std::string latexname_;
243 /// Label string. "Abstract", "Reference", "Caption"...
244 docstring labelstring_;
246 docstring endlabelstring_;
247 /// Label string inside appendix. "Appendix", ...
248 docstring labelstring_appendix_;
249 /// LaTeX parameter for environment
250 std::string latexparam_;
251 /// Internal tag to use (e.g., <title></title> for sect header)
252 std::string innertag_;
253 /// Internal tag to use e.g. to surround varlistentry label)
254 std::string labeltag_;
255 /// Internal tag to surround the item text in a list)
256 std::string itemtag_;
257 /// Macro definitions needed for this layout
259 /// Packages needed for this layout
260 std::set<std::string> requires_;