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 & category() const { return category_; }
88 docstring const & preamble() const { return preamble_; }
90 std::set<std::string> const & requires() const { return requires_; }
92 std::string const & latexparam() const { return latexparam_; }
94 std::string const & innertag() const { return innertag_; }
96 std::string const & labeltag() const { return labeltag_; }
98 std::string const & itemtag() const { return itemtag_; }
100 docstring const & labelstring_appendix() const {
101 return labelstring_appendix_;
103 /** Default font for this layout/environment.
104 The main font for this kind of environment. If an attribute has
105 INHERITED_*, it means that the value is specified by
106 the defaultfont for the entire layout. If we are nested, the
107 font is inherited from the font in the environment one level
108 up until the font is resolved. The values :IGNORE_*
109 and FONT_TOGGLE are illegal here.
113 /** Default font for labels.
114 Interpretation the same as for font above
118 /** Resolved version of the font for this layout/environment.
119 This is a resolved version the default font. The font is resolved
120 against the defaultfont of the entire layout.
124 /** Resolved version of the font used for labels.
125 This is a resolved version the label font. The font is resolved
126 against the defaultfont of the entire layout.
128 FontInfo reslabelfont;
130 /// Text that dictates how wide the left margin is on the screen
131 docstring leftmargin;
132 /// Text that dictates how wide the right margin is on the screen
133 docstring rightmargin;
134 /// Text that dictates how much space to leave after a potential label
136 /// Text that dictates how much space to leave before a potential label
137 docstring labelindent;
138 /// Text that dictates the width of the indentation of indented pars
149 double labelbottomsep;
157 LyXAlignment alignpossible;
161 EndLabelType endlabeltype;
163 MarginType margintype;
169 bool newline_allowed;
177 * Whether this layout was declared with "Environment xxx" as opposed
178 * to "Style xxx". This is part of some unfinished generic environment
179 * handling (see also InsetEnvironment) started by Andre. No layout
180 * that is shipped with LyX has this flag set.
181 * Don't confuse this with isEnvironment()!
186 /// special value of toclevel for non-section layouts
187 static const int NOT_IN_TOC;
188 /// for new environment insets
189 std::string latexheader;
190 /// for new environment insets
191 std::string latexfooter;
192 /// for new environment insets
193 std::string latexparagraph;
195 /** true when the fragile commands in the paragraph need to be
198 /// true when empty paragraphs should be kept.
201 bool isParagraph() const { return latextype == LATEX_PARAGRAPH; }
203 bool isCommand() const { return latextype == LATEX_COMMAND; }
205 bool isEnvironment() const {
206 return latextype == LATEX_ENVIRONMENT
207 || latextype == LATEX_BIB_ENVIRONMENT
208 || latextype == LATEX_ITEM_ENVIRONMENT
209 || latextype == LATEX_LIST_ENVIRONMENT;
211 /// Type of LaTeX object
213 /// Does this object belong in the title part of the document?
215 /// Does this layout allow for an optional parameter?
217 /// Which counter to step
219 /// Depth of XML command
222 /// Return a pointer on a new layout suitable to describe a caption.
223 /// FIXME: remove this eventually. This is only for tex2lyx
224 /// until it has proper support for the caption inset (JMarc)
225 static Layout * forCaption();
228 /// Name of the layout/paragraph environment
231 /** Name of an layout that has replaced this layout.
232 This is used to rename a layout, while keeping backward
235 docstring obsoleted_by_;
237 /** Name of an layout which preamble must come before this one
238 This is used when the preamble snippet uses macros defined in
241 docstring depends_on_;
243 /// LaTeX name for environment
244 std::string latexname_;
245 /// Label string. "Abstract", "Reference", "Caption"...
246 docstring labelstring_;
248 docstring endlabelstring_;
249 /// Label string inside appendix. "Appendix", ...
250 docstring labelstring_appendix_;
251 /// LaTeX parameter for environment
252 std::string latexparam_;
253 /// Internal tag to use (e.g., <title></title> for sect header)
254 std::string innertag_;
255 /// Internal tag to use e.g. to surround varlistentry label)
256 std::string labeltag_;
257 /// Internal tag to surround the item text in a list)
258 std::string itemtag_;
259 /// This is the `category' for this layout. The following are
260 /// recommended basic categories: FrontMatter, BackMatter, MainText,
261 /// Section, Starred, List, Theorem.
263 /// Macro definitions needed for this layout
265 /// Packages needed for this layout
266 std::set<std::string> requires_;