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.
32 bool Read(LyXLex &, LyXTextClass const &);
34 void readAlign(LyXLex &);
36 void readAlignPossible(LyXLex &);
38 void readLabelType(LyXLex &);
40 void readEndLabelType(LyXLex &);
42 void readMargin(LyXLex &);
44 void readLatexType(LyXLex &);
46 void readSpacing(LyXLex &);
48 std::string const & name() const;
50 void setName(std::string const & n);
52 std::string const & obsoleted_by() const;
54 std::string const & depends_on() const;
56 std::string const & latexname() const { return latexname_; }
58 std::string const & labelstring() const { return labelstring_; }
60 std::string const & endlabelstring() const { return endlabelstring_; }
62 std::string const & preamble() const { return preamble_; }
64 std::string const & latexparam() const { return latexparam_; }
66 std::string const & innertag() const { return innertag_; }
68 std::string const & labeltag() const { return labeltag_; }
70 std::string const & itemtag() const { return itemtag_; }
72 std::string const & labelstring_appendix() const {
73 return labelstring_appendix_;
75 /** Default font for this layout/environment.
76 The main font for this kind of environment. If an attribute has
77 LyXFont::INHERITED_*, it means that the value is specified by
78 the defaultfont for the entire layout. If we are nested, the
79 font is inherited from the font in the environment one level
80 up until the font is resolved. The values LyXFont::IGNORE_*
81 and LyXFont::TOGGLE are illegal here.
85 /** Default font for labels.
86 Interpretation the same as for font above
90 /** Resolved version of the font for this layout/environment.
91 This is a resolved version the default font. The font is resolved
92 against the defaultfont of the entire layout.
96 /** Resolved version of the font used for labels.
97 This is a resolved version the label font. The font is resolved
98 against the defaultfont of the entire layout.
100 LyXFont reslabelfont;
102 /// Text that dictates how wide the left margin is on the screen
103 std::string leftmargin;
104 /// Text that dictates how wide the right margin is on the screen
105 std::string rightmargin;
106 /// Text that dictates how much space to leave after a potential label
107 std::string labelsep;
108 /// Text that dictates how much space to leave before a potential label
109 std::string labelindent;
110 /// Text that dictates the width of the indentation of indented pars
111 std::string parindent;
121 double labelbottomsep;
129 LyXAlignment alignpossible;
131 LYX_LABEL_TYPES labeltype;
133 LYX_END_LABEL_TYPES endlabeltype;
135 LYX_MARGIN_TYPE margintype;
141 bool newline_allowed;
152 /// for new environment insets
153 std::string latexheader;
154 /// for new environment insets
155 std::string latexfooter;
156 /// for new environment insets
157 std::string latexparagraph;
159 /** true when the fragile commands in the paragraph need to be
162 /// true when empty paragraphs should be kept.
165 bool isParagraph() const {
166 return latextype == LATEX_PARAGRAPH;
169 bool isCommand() const {
170 return latextype == LATEX_COMMAND;
173 bool isEnvironment() const {
174 return (latextype == LATEX_ENVIRONMENT
175 || latextype == LATEX_BIB_ENVIRONMENT
176 || latextype == LATEX_ITEM_ENVIRONMENT
177 || latextype == LATEX_LIST_ENVIRONMENT);
179 /// Type of LaTeX object
180 LYX_LATEX_TYPES latextype;
181 /// Does this object belong in the title part of the document?
183 /// Does this layout allow for an optional parameter?
185 /// Which counter to step
187 /// Depth of XML command
191 /// Name of the layout/paragraph environment
194 /** Name of an layout that has replaced this layout.
195 This is used to rename a layout, while keeping backward
198 std::string obsoleted_by_;
200 /** Name of an layout which preamble must come before this one
201 This is used when the preamble snippet uses macros defined in
204 std::string depends_on_;
206 /// LaTeX name for environment
207 std::string latexname_;
208 /// Label string. "Abstract", "Reference", "Caption"...
209 std::string labelstring_;
211 std::string endlabelstring_;
212 /// Label string inside appendix. "Appendix", ...
213 std::string labelstring_appendix_;
214 /// LaTeX parameter for environment
215 std::string latexparam_;
216 /// Internal tag to use (e.g., <title></title> for sect header)
217 std::string innertag_;
218 /// Internal tag to use e.g. to surround varlistentry label)
219 std::string labeltag_;
220 /// Internal tag to surround the item text in a list)
221 std::string itemtag_;
222 /// Macro definitions needed for this layout
223 std::string preamble_;