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 & labelstring_appendix() const {
69 return labelstring_appendix_;
71 /** Default font for this layout/environment.
72 The main font for this kind of environment. If an attribute has
73 LyXFont::INHERITED_*, it means that the value is specified by
74 the defaultfont for the entire layout. If we are nested, the
75 font is inherited from the font in the environment one level
76 up until the font is resolved. The values LyXFont::IGNORE_*
77 and LyXFont::TOGGLE are illegal here.
81 /** Default font for labels.
82 Interpretation the same as for font above
86 /** Resolved version of the font for this layout/environment.
87 This is a resolved version the default font. The font is resolved
88 against the defaultfont of the entire layout.
92 /** Resolved version of the font used for labels.
93 This is a resolved version the label font. The font is resolved
94 against the defaultfont of the entire layout.
98 /// Text that dictates how wide the left margin is on the screen
99 std::string leftmargin;
100 /// Text that dictates how wide the right margin is on the screen
101 std::string rightmargin;
102 /// Text that dictates how much space to leave after a potential label
103 std::string labelsep;
104 /// Text that dictates how much space to leave before a potential label
105 std::string labelindent;
106 /// Text that dictates the width of the indentation of indented pars
107 std::string parindent;
117 float labelbottomsep;
125 LyXAlignment alignpossible;
127 LYX_LABEL_TYPES labeltype;
129 LYX_END_LABEL_TYPES endlabeltype;
131 LYX_MARGIN_TYPE margintype;
137 bool newline_allowed;
148 /// for new environment insets
149 std::string latexheader;
150 /// for new environment insets
151 std::string latexfooter;
152 /// for new environment insets
153 std::string latexparagraph;
155 /** true when the fragile commands in the paragraph need to be
158 /// true when empty paragraphs should be kept.
161 bool isParagraph() const {
162 return latextype == LATEX_PARAGRAPH;
165 bool isCommand() const {
166 return latextype == LATEX_COMMAND;
169 bool isEnvironment() const {
170 return (latextype == LATEX_ENVIRONMENT
171 || latextype == LATEX_BIB_ENVIRONMENT
172 || latextype == LATEX_ITEM_ENVIRONMENT
173 || latextype == LATEX_LIST_ENVIRONMENT);
175 /// Type of LaTeX object
176 LYX_LATEX_TYPES latextype;
177 /// Does this object belong in the title part of the document?
179 /// Does this layout allow for an optional parameter?
181 /// Which counter to step
183 /// Depth of XML command
187 /// Name of the layout/paragraph environment
190 /** Name of an layout that has replaced this layout.
191 This is used to rename a layout, while keeping backward
194 std::string obsoleted_by_;
196 /** Name of an layout which preamble must come before this one
197 This is used when the preamble snippet uses macros defined in
200 std::string depends_on_;
202 /// LaTeX name for environment
203 std::string latexname_;
204 /// Label string. "Abstract", "Reference", "Caption"...
205 std::string labelstring_;
207 std::string endlabelstring_;
208 /// Label string inside appendix. "Appendix", ...
209 std::string labelstring_appendix_;
210 /// LaTeX parameter for environment
211 std::string latexparam_;
212 /// Internal tag to use (e.g., <title></title> for sect header)
213 std::string innertag_;
214 /// Macro definitions needed for this layout
215 std::string preamble_;