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;
115 std::string const & htmlattr() const;
117 std::string const & htmlitemtag() const;
119 std::string const & htmlitemattr() const;
121 std::string const & htmllabeltag() const;
123 std::string const & htmllabelattr() const;
125 std::string defaultCSSClass() const;
127 bool htmllabelfirst() const { return htmllabelfirst_; }
129 docstring htmlstyle() const;
131 docstring const & htmlpreamble() const { return htmlpreamble_; }
133 bool htmltitle() const { return htmltitle_; }
135 bool isParagraph() const { return latextype == LATEX_PARAGRAPH; }
137 bool isCommand() const { return latextype == LATEX_COMMAND; }
139 bool isEnvironment() const {
140 return latextype == LATEX_ENVIRONMENT
141 || latextype == LATEX_BIB_ENVIRONMENT
142 || latextype == LATEX_ITEM_ENVIRONMENT
143 || latextype == LATEX_LIST_ENVIRONMENT;
147 bool operator==(Layout const &) const;
149 bool operator!=(Layout const & rhs) const
150 { return !(*this == rhs); }
152 ////////////////////////////////////////////////////////////////
154 ////////////////////////////////////////////////////////////////
155 /** Default font for this layout/environment.
156 The main font for this kind of environment. If an attribute has
157 INHERITED_*, it means that the value is specified by
158 the defaultfont for the entire layout. If we are nested, the
159 font is inherited from the font in the environment one level
160 up until the font is resolved. The values :IGNORE_*
161 and FONT_TOGGLE are illegal here.
165 /** Default font for labels.
166 Interpretation the same as for font above
170 /** Resolved version of the font for this layout/environment.
171 This is a resolved version the default font. The font is resolved
172 against the defaultfont of the entire layout.
176 /** Resolved version of the font used for labels.
177 This is a resolved version the label font. The font is resolved
178 against the defaultfont of the entire layout.
180 FontInfo reslabelfont;
182 /// Text that dictates how wide the left margin is on the screen
183 docstring leftmargin;
184 /// Text that dictates how wide the right margin is on the screen
185 docstring rightmargin;
186 /// Text that dictates how much space to leave after a potential label
188 /// Text that dictates how much space to leave before a potential label
189 docstring labelindent;
190 /// Text that dictates the width of the indentation of indented pars
201 double labelbottomsep;
209 LyXAlignment alignpossible;
213 EndLabelType endlabeltype;
215 MarginType margintype;
221 bool newline_allowed;
230 /// special value of toclevel for non-section layouts
231 static const int NOT_IN_TOC;
233 /** true when the fragile commands in the paragraph need to be
236 /// true when empty paragraphs should be kept.
238 /// Type of LaTeX object
240 /// Does this object belong in the title part of the document?
242 /// Is the content to go in the preamble rather than the body?
244 /// Number of requried arguments for this command or environment
245 unsigned int reqargs;
246 /// Number of optional arguments for this command or environment
247 /// These MUST come at the beginning, so:
248 /// \cmd[opt1][opt2]{req1}{here is the text from LyX}
250 /// \cmd[opt1]{req1}[opt2]{here is the text from LyX}
252 unsigned int optargs;
253 /// Which counter to step
255 /// Prefix to use when creating labels
257 /// Depth of XML command
260 /// Return a pointer on a new layout suitable to describe a caption.
261 /// FIXME: remove this eventually. This is only for tex2lyx
262 /// until it has proper support for the caption inset (JMarc)
263 static Layout * forCaption();
265 /// Is this spellchecked?
270 /// generates the default CSS for this layout
271 void makeDefaultCSS() const;
273 std::string defaultCSSItemClass() const { return defaultCSSClass() + "_item"; }
275 std::string defaultCSSLabelClass() const { return defaultCSSClass() + "_label"; }
277 /// Name of the layout/paragraph environment
280 /// LaTeX name for environment
281 std::string latexname_;
283 /** Is this layout the default layout for an unknown layout? If
284 * so, its name will be displayed as xxx (unknown).
288 /** Name of an layout that has replaced this layout.
289 This is used to rename a layout, while keeping backward
292 docstring obsoleted_by_;
294 /** Name of an layout which preamble must come before this one
295 This is used when the preamble snippet uses macros defined in
298 docstring depends_on_;
300 /// Label string. "Abstract", "Reference", "Caption"...
301 docstring labelstring_;
303 docstring endlabelstring_;
304 /// Label string inside appendix. "Appendix", ...
305 docstring labelstring_appendix_;
306 /// LaTeX parameter for environment
307 std::string latexparam_;
308 /// Internal tag to use (e.g., <title></title> for sect header)
309 std::string innertag_;
310 /// Internal tag to use (e.g. to surround varentrylist label)
311 std::string labeltag_;
312 /// Internal tag to surround the item text in a list.
313 std::string itemtag_;
314 /// The interpretation of this tag varies depending upon the latextype.
315 /// In an environment, it is the tag enclosing all content for this set of
316 /// paragraphs. So for quote, e.g,. it would be: blockquote. For itemize,
317 /// it would be: ul. (You get the idea.)
319 /// For a command, it is the tag enclosing the content of the command.
320 /// So, for section, it might be: h2.
322 /// For the paragraph type, it is the tag that will enclose each paragraph.
324 /// Defaults to "div".
325 mutable std::string htmltag_;
326 /// Additional attributes for inclusion with the start tag. Defaults
327 /// to: class="layoutname".
328 mutable std::string htmlattr_;
329 /// Tag for individual paragraphs in an environment. In lists, this
330 /// would be something like "li". But it also needs to be set for
331 /// quotation, e.g., since the paragraphs in a quote need to be
332 /// in "p" tags. Default is "div".
333 /// Note that when I said "environment", I meant it: This has no
334 /// effect for LATEX_PARAGRAPH type layouts.
335 mutable std::string htmlitemtag_;
336 /// Attributes for htmlitemtag_. Default is: class="layoutname_item".
337 mutable std::string htmlitemattr_;
338 /// Tag for labels, of whatever sort. One use for this is in setting
339 /// descriptions, in which case it would be: dt. Another use is to
340 /// customize the display of, say, the auto-generated label for
341 /// sections. Defaults to "span".
342 /// If set to "NONE", this suppresses the printing of the label.
343 mutable std::string htmllabeltag_;
344 /// Attributes for the label. Defaults to: class="layoutname_label".
345 mutable std::string htmllabelattr_;
346 /// Whether to put the label before the item, or within the item.
347 /// I.e., do we have (true):
348 /// <label>...</label><item>...</item>
349 /// or instead (false):
350 /// <item><label>...</label>...</item>
351 /// The latter is the default.
352 bool htmllabelfirst_;
353 /// CSS information needed by this layout.
354 docstring htmlstyle_;
355 /// Should we generate the default CSS for this layout, even if HTMLStyle
356 /// has been given? Default is false.
357 /// Note that the default CSS is output first, then the user CSS, so it is
358 /// possible to override what one does not want.
360 /// A cache for the default style info so generated.
361 mutable docstring htmldefaultstyle_;
362 /// Any other info for the HTML header.
363 docstring htmlpreamble_;
364 /// Whether this is the <title> paragraph.
366 /// calculating this is expensive, so we cache it.
367 mutable std::string defaultcssclass_;
368 /// This is the `category' for this layout. The following are
369 /// recommended basic categories: FrontMatter, BackMatter, MainText,
370 /// Section, Starred, List, Theorem.
372 /// Macro definitions needed for this layout
374 /// Language dependent macro definitions needed for this layout
375 docstring langpreamble_;
376 /// Language and babel dependent macro definitions needed for this layout
377 docstring babelpreamble_;
378 /// Packages needed for this layout
379 std::set<std::string> requires_;