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 /* Fix 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() const { return labelstring_; }
90 docstring const & endlabelstring() const { return endlabelstring_; }
92 docstring const & category() const { return category_; }
94 docstring const & preamble() const { return preamble_; }
95 /// Get language dependent macro definitions needed for this layout
96 /// for language \p lang
97 docstring const langpreamble(Language const * lang) const;
98 /// Get language and babel dependent macro definitions needed for
99 /// this layout for language \p lang
100 docstring const babelpreamble(Language const * lang) const;
102 std::set<std::string> const & requires() const { return requires_; }
104 std::string const & latexparam() const { return latexparam_; }
106 std::string const & innertag() const { return innertag_; }
108 std::string const & labeltag() const { return labeltag_; }
110 std::string const & itemtag() const { return itemtag_; }
112 std::string const & htmltag() const { return htmltag_; }
114 std::string const & htmlattr() const { return htmlattr_; }
116 std::string const & htmlitem() const { return htmlitem_; }
118 std::string const & htmlitemattr() const { return htmlitemattr_; }
120 std::string const & htmllabel() const { return htmllabel_; }
122 std::string const & htmllabelattr() const { return htmllabelattr_; }
124 docstring const & htmlstyle() const { return htmlstyle_; }
126 docstring const & labelstring_appendix() const {
127 return labelstring_appendix_;
130 bool isParagraph() const { return latextype == LATEX_PARAGRAPH; }
132 bool isCommand() const { return latextype == LATEX_COMMAND; }
134 bool isEnvironment() const {
135 return latextype == LATEX_ENVIRONMENT
136 || latextype == LATEX_BIB_ENVIRONMENT
137 || latextype == LATEX_ITEM_ENVIRONMENT
138 || latextype == LATEX_LIST_ENVIRONMENT;
142 bool operator==(Layout const &) const;
144 bool operator!=(Layout const & rhs) const
145 { return !(*this == rhs); }
147 ////////////////////////////////////////////////////////////////
149 ////////////////////////////////////////////////////////////////
150 /** Default font for this layout/environment.
151 The main font for this kind of environment. If an attribute has
152 INHERITED_*, it means that the value is specified by
153 the defaultfont for the entire layout. If we are nested, the
154 font is inherited from the font in the environment one level
155 up until the font is resolved. The values :IGNORE_*
156 and FONT_TOGGLE are illegal here.
160 /** Default font for labels.
161 Interpretation the same as for font above
165 /** Resolved version of the font for this layout/environment.
166 This is a resolved version the default font. The font is resolved
167 against the defaultfont of the entire layout.
171 /** Resolved version of the font used for labels.
172 This is a resolved version the label font. The font is resolved
173 against the defaultfont of the entire layout.
175 FontInfo reslabelfont;
177 /// Text that dictates how wide the left margin is on the screen
178 docstring leftmargin;
179 /// Text that dictates how wide the right margin is on the screen
180 docstring rightmargin;
181 /// Text that dictates how much space to leave after a potential label
183 /// Text that dictates how much space to leave before a potential label
184 docstring labelindent;
185 /// Text that dictates the width of the indentation of indented pars
196 double labelbottomsep;
204 LyXAlignment alignpossible;
208 EndLabelType endlabeltype;
210 MarginType margintype;
216 bool newline_allowed;
225 /// special value of toclevel for non-section layouts
226 static const int NOT_IN_TOC;
228 /** true when the fragile commands in the paragraph need to be
231 /// true when empty paragraphs should be kept.
233 /// Type of LaTeX object
235 /// Does this object belong in the title part of the document?
237 /// Does this layout allow for an optional parameter?
239 /// Which counter to step
241 /// Depth of XML command
244 /// Return a pointer on a new layout suitable to describe a caption.
245 /// FIXME: remove this eventually. This is only for tex2lyx
246 /// until it has proper support for the caption inset (JMarc)
247 static Layout * forCaption();
251 /// Name of the layout/paragraph environment
254 /// LaTeX name for environment
255 std::string latexname_;
257 /** Is this layout the default layout for an unknown layout? If
258 * so, its name will be displayed as xxx (unknown).
262 /** Name of an layout that has replaced this layout.
263 This is used to rename a layout, while keeping backward
266 docstring obsoleted_by_;
268 /** Name of an layout which preamble must come before this one
269 This is used when the preamble snippet uses macros defined in
272 docstring depends_on_;
274 /// Label string. "Abstract", "Reference", "Caption"...
275 docstring labelstring_;
277 docstring endlabelstring_;
278 /// Label string inside appendix. "Appendix", ...
279 docstring labelstring_appendix_;
280 /// LaTeX parameter for environment
281 std::string latexparam_;
282 /// Internal tag to use (e.g., <title></title> for sect header)
283 std::string innertag_;
284 /// Internal tag to use e.g. to surround varlistentry label)
285 std::string labeltag_;
286 /// Internal tag to surround the item text in a list)
287 std::string itemtag_;
288 /// Tag for HTML output, e.g., h2.
289 std::string htmltag_;
290 /// Additional attributes for inclusion with the start tag,
291 /// e.g.: class='section'.
292 std::string htmlattr_;
293 /// Tag for individual paragraphs in an environment. In lists, this
294 /// would be something like "li". But it also needs to be set for
295 /// quotation, e.g., since the paragraphs in a quote need to be
297 std::string htmlitem_;
298 /// Attributes for htmlitem_
299 std::string htmlitemattr_;
300 /// Tag for labels, of whatever sort. One use for this is in setting
301 /// descriptions, in which case it would be: dt. Another use is to
302 /// customize the display of, say, the auto-generated label for
303 /// sections (in that case, it might be: span).
304 std::string htmllabel_;
305 /// Attributes for the label.
306 std::string htmllabelattr_;
307 /// CSS information needed by this layout.
308 docstring htmlstyle_;
309 /// This is the `category' for this layout. The following are
310 /// recommended basic categories: FrontMatter, BackMatter, MainText,
311 /// Section, Starred, List, Theorem.
313 /// Macro definitions needed for this layout
315 /// Language dependent macro definitions needed for this layout
316 docstring langpreamble_;
317 /// Language and babel dependent macro definitions needed for this layout
318 docstring babelpreamble_;
319 /// Packages needed for this layout
320 std::set<std::string> requires_;