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"
31 /* Fixed labels are printed flushright, manual labels flushleft.
32 * MARGIN_MANUAL and MARGIN_FIRST_DYNAMIC are *only* for LABEL_MANUAL,
33 * MARGIN_DYNAMIC and MARGIN_STATIC are *not* for LABEL_MANUAL.
34 * This seems a funny restriction, but I think other combinations are
35 * not needed, so I will not change it yet.
36 * Correction: MARGIN_FIRST_DYNAMIC also usable with LABEL_STATIC.
40 /* There is a parindent and a parskip. Which one is used depends on the
41 * paragraph_separation-flag of the text-object.
42 * BUT: parindent is only thrown away, if a parskip is defined! So if you
43 * want a space between the paragraphs and a parindent at the same time,
44 * you should set parskip to zero and use topsep, parsep and bottomsep.
46 * The standard layout is an exception: its parindent is only set, if the
47 * previous paragraph is standard too. Well, this is LateX and it is good!
55 /// is this layout a default layout created for an unknown layout
56 bool isUnknown() const { return unknown_; }
57 void setUnknown(bool unknown) { unknown_ = unknown; }
58 /// Reads a layout definition from file
59 /// \return true on success.
60 bool read(Lexer &, TextClass const &);
62 void readAlign(Lexer &);
64 void readAlignPossible(Lexer &);
66 void readLabelType(Lexer &);
68 void readEndLabelType(Lexer &);
70 void readMargin(Lexer &);
72 void readLatexType(Lexer &);
74 void readSpacing(Lexer &);
76 docstring const & name() const { return name_; };
78 void setName(docstring const & n) { name_ = n; }
80 docstring const & obsoleted_by() const { return obsoleted_by_; }
82 docstring const & depends_on() const { return depends_on_; }
84 std::string const & latexname() const { return latexname_; }
86 void setLatexName(std::string const & n) { latexname_ = n; }
88 docstring const & labelstring(bool in_appendix) const
89 { return in_appendix ? labelstring_appendix_ : labelstring_; }
91 docstring const & endlabelstring() const { return endlabelstring_; }
93 docstring const & category() const { return category_; }
95 docstring const & preamble() const { return preamble_; }
96 /// Get language dependent macro definitions needed for this layout
97 /// for language \p lang
98 docstring const langpreamble(Language const * lang) const;
99 /// Get language and babel dependent macro definitions needed for
100 /// this layout for language \p lang
101 docstring const babelpreamble(Language const * lang) const;
103 std::set<std::string> const & requires() const { return requires_; }
105 std::string const & latexparam() const { return latexparam_; }
107 std::string const & innertag() const { return innertag_; }
109 std::string const & labeltag() const { return labeltag_; }
111 std::string const & itemtag() const { return itemtag_; }
113 std::string const & htmltag() const { return htmltag_; }
115 std::string const & htmlattr() const { return htmlattr_; }
117 std::string const & htmlitem() const { return htmlitem_; }
119 std::string const & htmlitemattr() const { return htmlitemattr_; }
121 std::string const & htmllabel() const { return htmllabel_; }
123 std::string const & htmllabelattr() const { return htmllabelattr_; }
125 bool htmllabelfirst() const { return htmllabelfirst_; }
127 docstring htmlstyle() const;
129 docstring const & htmlpreamble() const { return htmlpreamble_; }
131 bool isParagraph() const { return latextype == LATEX_PARAGRAPH; }
133 bool isCommand() const { return latextype == LATEX_COMMAND; }
135 bool isEnvironment() const {
136 return latextype == LATEX_ENVIRONMENT
137 || latextype == LATEX_BIB_ENVIRONMENT
138 || latextype == LATEX_ITEM_ENVIRONMENT
139 || latextype == LATEX_LIST_ENVIRONMENT;
143 bool operator==(Layout const &) const;
145 bool operator!=(Layout const & rhs) const
146 { return !(*this == rhs); }
148 ////////////////////////////////////////////////////////////////
150 ////////////////////////////////////////////////////////////////
151 /** Default font for this layout/environment.
152 The main font for this kind of environment. If an attribute has
153 INHERITED_*, it means that the value is specified by
154 the defaultfont for the entire layout. If we are nested, the
155 font is inherited from the font in the environment one level
156 up until the font is resolved. The values :IGNORE_*
157 and FONT_TOGGLE are illegal here.
161 /** Default font for labels.
162 Interpretation the same as for font above
166 /** Resolved version of the font for this layout/environment.
167 This is a resolved version the default font. The font is resolved
168 against the defaultfont of the entire layout.
172 /** Resolved version of the font used for labels.
173 This is a resolved version the label font. The font is resolved
174 against the defaultfont of the entire layout.
176 FontInfo reslabelfont;
178 /// Text that dictates how wide the left margin is on the screen
179 docstring leftmargin;
180 /// Text that dictates how wide the right margin is on the screen
181 docstring rightmargin;
182 /// Text that dictates how much space to leave after a potential label
184 /// Text that dictates how much space to leave before a potential label
185 docstring labelindent;
186 /// Text that dictates the width of the indentation of indented pars
197 double labelbottomsep;
205 LyXAlignment alignpossible;
209 EndLabelType endlabeltype;
211 MarginType margintype;
217 bool newline_allowed;
226 /// special value of toclevel for non-section layouts
227 static const int NOT_IN_TOC;
229 /** true when the fragile commands in the paragraph need to be
232 /// true when empty paragraphs should be kept.
234 /// Type of LaTeX object
236 /// Does this object belong in the title part of the document?
238 /// Does this layout allow for an optional parameter?
240 /// Which counter to step
242 /// Depth of XML command
245 /// Return a pointer on a new layout suitable to describe a caption.
246 /// FIXME: remove this eventually. This is only for tex2lyx
247 /// until it has proper support for the caption inset (JMarc)
248 static Layout * forCaption();
252 /// generates the default CSS for this layout
253 void makeDefaultCSS() const;
255 /// Name of the layout/paragraph environment
258 /// LaTeX name for environment
259 std::string latexname_;
261 /** Is this layout the default layout for an unknown layout? If
262 * so, its name will be displayed as xxx (unknown).
266 /** Name of an layout that has replaced this layout.
267 This is used to rename a layout, while keeping backward
270 docstring obsoleted_by_;
272 /** Name of an layout which preamble must come before this one
273 This is used when the preamble snippet uses macros defined in
276 docstring depends_on_;
278 /// Label string. "Abstract", "Reference", "Caption"...
279 docstring labelstring_;
281 docstring endlabelstring_;
282 /// Label string inside appendix. "Appendix", ...
283 docstring labelstring_appendix_;
284 /// LaTeX parameter for environment
285 std::string latexparam_;
286 /// Internal tag to use (e.g., <title></title> for sect header)
287 std::string innertag_;
288 /// Internal tag to use (e.g. to surround varentrylist label)
289 std::string labeltag_;
290 /// Internal tag to surround the item text in a list.
291 std::string itemtag_;
292 /// Tag for HTML output, e.g., h2. Defaults to "div".
293 std::string htmltag_;
294 /// Additional attributes for inclusion with the start tag. Defaults
295 /// to: class="layoutname".
296 std::string htmlattr_;
297 /// Tag for individual paragraphs in an environment. In lists, this
298 /// would be something like "li". But it also needs to be set for
299 /// quotation, e.g., since the paragraphs in a quote need to be
300 /// in "p" tags. Default is "div".
301 std::string htmlitem_;
302 /// Attributes for htmlitem_. Default is: class="layoutnameitem".
303 std::string htmlitemattr_;
304 /// Tag for labels, of whatever sort. One use for this is in setting
305 /// descriptions, in which case it would be: dt. Another use is to
306 /// customize the display of, say, the auto-generated label for
307 /// sections. Defaults to "span".
308 /// If set to "NONE", this suppresses the printing of the label.
309 std::string htmllabel_;
310 /// Attributes for the label. Defaults to: class="layoutnamelabel".
311 std::string htmllabelattr_;
312 /// Whether to put the label before the item, or within the item.
313 /// I.e., do we have (true):
314 /// <label>...</label><item>...</item>
315 /// or instead (false):
316 /// <item><label>...</label>...</item>
317 /// The latter is the default.
318 bool htmllabelfirst_;
319 /// CSS information needed by this layout.
320 docstring htmlstyle_;
321 /// Should we generate the default CSS for this layout, even if HTMLStyle
322 /// has been given? Default is false.
323 /// Note that the default CSS is output first, then the user CSS, so it is
324 /// possible to override what one does not want.
325 bool htmlforcedefault_;
326 /// A cache for the default style info so generated.
327 mutable docstring htmldefaultstyle_;
328 /// Any other info for the HTML header.
329 docstring htmlpreamble_;
330 /// This is the `category' for this layout. The following are
331 /// recommended basic categories: FrontMatter, BackMatter, MainText,
332 /// Section, Starred, List, Theorem.
334 /// Macro definitions needed for this layout
336 /// Language dependent macro definitions needed for this layout
337 docstring langpreamble_;
338 /// Language and babel dependent macro definitions needed for this layout
339 docstring babelpreamble_;
340 /// Packages needed for this layout
341 std::set<std::string> requires_;