4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Martin Vermeer
10 * Full author contact details are available in file CREDITS.
13 #ifndef INSET_LAYOUT_H
14 #define INSET_LAYOUT_H
16 #include "ColorCode.h"
20 #include "support/docstring.h"
34 InsetLayout() { labelfont_.setColor(Color_error); }
36 enum InsetDecoration {
58 bool read(Lexer & lexrc, TextClass const & tclass,
59 bool validating = false);
61 docstring name() const { return name_; }
63 void setName(docstring const & n) { name_ = n; }
65 InsetLyXType lyxtype() const { return lyxtype_; }
67 docstring labelstring() const { return labelstring_; }
69 docstring menustring() const { return menustring_; }
71 bool contentaslabel() const { return contentaslabel_; }
73 InsetDecoration decoration() const { return decoration_; }
75 InsetLaTeXType latextype() const { return latextype_; }
77 std::string latexname() const { return latexname_; }
79 std::string latexparam() const { return latexparam_; }
81 docstring leftdelim() const { return leftdelim_; }
83 docstring rightdelim() const { return rightdelim_; }
85 FontInfo font() const { return font_; }
87 FontInfo labelfont() const { return labelfont_; }
89 ColorCode bgcolor() const { return bgcolor_; }
91 Layout::LaTeXArgMap const & latexargs() const { return latexargs_; }
93 Layout::LaTeXArgMap const & postcommandargs() const { return postcommandargs_; }
94 /// Returns latexargs() + postcommandargs().
95 /// But note that it returns a *copy*, not a reference, so do not do
97 /// Layout::LaTeXArgMap::iterator it = args().begin();
98 /// Layout::LaTeXArgMap::iterator en = args().end();
99 /// Those are iterators for different containers.
100 Layout::LaTeXArgMap args() const;
104 int requiredArgs() const;
106 docstring preamble() const { return preamble_; }
107 /// Get language dependent macro definitions needed for this inset
108 docstring const langpreamble() const { return langpreamble_; }
109 /// Get language and babel dependent macro definitions needed for
111 docstring const babelpreamble() const { return babelpreamble_; }
113 bool fixedwidthpreambleencoding() const { return fixedwidthpreambleencoding_; }
115 docstring counter() const { return counter_; }
117 docstring refprefix() const { return refprefix_; }
118 /// The tag enclosing all the material in this inset. Default is "span".
119 std::string const & htmltag() const;
120 /// Additional attributes for inclusion with the start tag. Default (if
121 /// a tag is provided) is: class="name".
122 std::string const & htmlattr() const;
123 /// Tag for individual paragraphs in the inset. Default is none.
124 std::string const & htmlinnertag() const { return htmlinnertag_; }
125 /// Attributes for that tag. Default (if a tag is provided) is:
126 /// class="name_inner".
127 std::string const & htmlinnerattr() const;
128 /// A label for this environment, possibly including a reference
129 /// to a counter. E.g., for footnote, it might be:
130 /// \arabic{footnote}
132 /// FIXME Could we get this from the layout?
133 std::string const & htmllabel() const { return htmllabel_; }
135 inline std::string htmllabeltag() const { return "span"; }
137 std::string htmllabelattr() const
138 { return "class=\"" + defaultCSSClass() + "_label\""; }
139 /// CSS associated with this inset.
140 docstring htmlstyle() const;
141 /// Additional material for the header.
142 docstring htmlpreamble() const { return htmlpreamble_; }
143 /// Whether this inset represents a "block" of material, i.e., a set
144 /// of paragraphs of its own (true), or should be run into the previous
145 /// paragraph (false). Examples:
146 /// For branches, this is false.
147 /// For footnotes, this is true.
148 /// Defaults to true.
149 bool htmlisblock() const { return htmlisblock_; }
151 std::string docbooktag() const { return docbooktag_; }
153 std::string docbooktagtype() const;
155 std::string docbookattr() const { return docbookattr_; }
157 std::string const & docbookininfo() const;
159 bool docbooksection() const { return docbooksection_; }
161 bool docbooknotinpara() const { return docbooknotinpara_; }
163 bool docbookargumentbeforemaintag() const { return docbookargumentbeforemaintag_; }
165 std::string docbookwrappertag() const { return docbookwrappertag_; }
167 std::string docbookwrappertagtype() const;
169 std::string docbookwrapperattr() const { return docbookwrapperattr_; }
171 std::string docbookitemwrappertag() const { return docbookitemwrappertag_; }
173 std::string docbookitemwrappertagtype() const;
175 std::string docbookitemwrapperattr() const { return docbookitemwrapperattr_; }
177 std::string docbookitemtag() const { return docbookitemtag_; }
179 std::string docbookitemtagtype() const;
181 std::string docbookitemattr() const { return docbookitemattr_; }
183 std::set<std::string> required() const { return required_; }
185 bool isMultiPar() const { return multipar_; }
187 bool forcePlainLayout() const { return forceplain_; }
189 bool allowParagraphCustomization() const { return custompars_; }
191 bool isPassThru() const { return passthru_; }
193 docstring passThruChars() const { return passthru_chars_; }
195 std::string newlineCmd() const { return newline_cmd_; }
197 bool parbreakIsNewline() const { return parbreakisnewline_; }
199 bool parbreakIgnored() const { return parbreakignored_; }
201 bool isNeedProtect() const { return needprotect_; }
203 bool needsCProtect() const { return needcprotect_; }
204 /// Protection of some elements such as \ref and \cite
205 /// in \mbox (needed by commands building on soul or ulem)
206 bool isNeedMBoxProtect() const { return needmboxprotect_; }
208 bool isFreeSpacing() const { return freespacing_; }
210 bool isKeepEmpty() const { return keepempty_; }
212 bool forceLTR() const { return forceltr_; }
214 bool forceOwnlines() const { return forceownlines_; }
216 bool isInToc() const { return intoc_; }
218 bool spellcheck() const { return spellcheck_; }
220 bool resetsFont() const { return resetsfont_; }
222 bool isDisplay() const { return display_; }
224 bool forceLocalFontSwitch() const { return forcelocalfontswitch_; }
226 docstring const & obsoleted_by() const { return obsoleted_by_; }
228 bool addToToc() const { return add_to_toc_; }
230 std::string tocType() const { return toc_type_; }
232 bool isTocCaption() const { return is_toc_caption_; }
234 bool editExternally () const { return edit_external_; }
237 void makeDefaultCSS() const;
239 std::string defaultCSSClass() const;
241 void readArgument(Lexer &);
243 docstring name_ = from_ascii("undefined");
245 * This is only used (at present) to decide where to put them on the menus.
246 * Values are 'charstyle', 'custom' (things that by default look like a
247 * footnote), 'standard'.
249 InsetLyXType lyxtype_ = STANDARD;
251 docstring labelstring_ = from_ascii("UNDEFINED");
253 docstring menustring_;
255 bool contentaslabel_ = false;
257 InsetDecoration decoration_ = DEFAULT;
259 InsetLaTeXType latextype_ = NOLATEXTYPE;
261 std::string latexname_;
263 std::string latexparam_;
265 docstring leftdelim_;
267 docstring rightdelim_;
269 FontInfo font_ = inherit_font;
271 FontInfo labelfont_ = sane_font;
273 ColorCode bgcolor_ = Color_error;
278 /// Language dependent macro definitions needed for this inset
279 docstring langpreamble_;
280 /// Language and babel dependent macro definitions needed for this inset
281 docstring babelpreamble_;
283 bool fixedwidthpreambleencoding_ = false;
285 docstring refprefix_;
287 mutable std::string htmltag_;
289 mutable std::string htmlattr_;
291 std::string htmlinnertag_;
293 mutable std::string htmlinnerattr_;
295 std::string htmllabel_;
297 docstring htmlstyle_;
298 /// Cache for default CSS info for this inset.
299 mutable docstring htmldefaultstyle_;
300 /// Cache for default CSS class.
301 mutable std::string defaultcssclass_;
302 /// Whether to force generation of default CSS even if some is given.
303 /// False by default.
304 bool htmlforcecss_ = false;
306 docstring htmlpreamble_;
308 bool htmlisblock_ = true;
310 std::string docbooktag_;
312 mutable std::string docbooktagtype_;
314 std::string docbookattr_;
316 mutable std::string docbookininfo_;
318 bool docbooknotinpara_ = false;
320 bool docbookargumentbeforemaintag_ = false;
322 bool docbooksection_ = false;
324 std::string docbookwrappertag_;
326 mutable std::string docbookwrappertagtype_;
328 std::string docbookwrapperattr_;
330 std::string docbookitemtag_;
332 mutable std::string docbookitemtagtype_;
334 std::string docbookitemattr_;
336 std::string docbookitemwrappertag_;
338 mutable std::string docbookitemwrappertagtype_;
340 std::string docbookitemwrapperattr_;
342 std::set<std::string> required_;
344 bool multipar_ = true;
346 bool custompars_ = true;
348 bool forceplain_ = false;
350 bool passthru_ = false;
352 docstring passthru_chars_;
354 std::string newline_cmd_;
356 bool parbreakisnewline_ = false;
358 bool parbreakignored_ = false;
360 bool freespacing_ = false;
362 bool keepempty_ = false;
364 bool forceltr_ = false;
366 bool forceownlines_ = false;
368 bool needprotect_ = false;
370 bool needcprotect_ = false;
372 bool needmboxprotect_ = false;
373 /// should the contents be written to TOC strings?
375 /// check spelling of this inset?
376 bool spellcheck_ = true;
378 bool resetsfont_ = false;
380 bool display_ = true;
382 bool forcelocalfontswitch_ = false;
383 /** Name of an insetlayout that has replaced this insetlayout.
384 This is used to rename an insetlayout, while keeping backward
387 docstring obsoleted_by_;
389 Layout::LaTeXArgMap latexargs_;
391 Layout::LaTeXArgMap postcommandargs_;
393 bool add_to_toc_ = false;
395 std::string toc_type_;
397 bool is_toc_caption_ = false;
399 bool edit_external_ = false;
403 InsetLayout::InsetLyXType translateLyXType(std::string const & str);
404 InsetLayout::InsetDecoration translateDecoration(std::string const & str);