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"
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;
102 unsigned int optArgs() const;
104 unsigned 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 docbookattr() const { return docbookattr_; }
155 std::set<std::string> required() const { return required_; }
157 bool isMultiPar() const { return multipar_; }
159 bool forcePlainLayout() const { return forceplain_; }
161 bool allowParagraphCustomization() const { return custompars_; }
163 bool isPassThru() const { return passthru_; }
165 docstring passThruChars() const { return passthru_chars_; }
167 std::string newlineCmd() const { return newline_cmd_; }
169 bool parbreakIsNewline() const { return parbreakisnewline_; }
171 bool parbreakIgnored() const { return parbreakignored_; }
173 bool isNeedProtect() const { return needprotect_; }
175 bool needsCProtect() const { return needcprotect_; }
176 /// Protection of some elements such as \ref and \cite
177 /// in \mbox (needed by commands building on soul or ulem)
178 bool isNeedMBoxProtect() const { return needmboxprotect_; }
180 bool isFreeSpacing() const { return freespacing_; }
182 bool isKeepEmpty() const { return keepempty_; }
184 bool forceLTR() const { return forceltr_; }
186 bool forceOwnlines() const { return forceownlines_; }
188 bool isInToc() const { return intoc_; }
190 bool spellcheck() const { return spellcheck_; }
192 bool resetsFont() const { return resetsfont_; }
194 bool isDisplay() const { return display_; }
196 bool forcelocalfontswitch() const { return forcelocalfontswitch_; }
198 docstring const & obsoleted_by() const { return obsoleted_by_; }
200 bool addToToc() const { return add_to_toc_; }
202 std::string tocType() const { return toc_type_; }
204 bool isTocCaption() const { return is_toc_caption_; }
206 bool editExternally () const { return edit_external_; }
209 void makeDefaultCSS() const;
211 std::string defaultCSSClass() const;
213 void readArgument(Lexer &);
217 * This is only used (at present) to decide where to put them on the menus.
218 * Values are 'charstyle', 'custom' (things that by default look like a
219 * footnote), 'standard'.
221 InsetLyXType lyxtype_;
223 docstring labelstring_;
225 docstring menustring_;
227 bool contentaslabel_;
229 InsetDecoration decoration_;
231 InsetLaTeXType latextype_;
233 std::string latexname_;
235 std::string latexparam_;
237 docstring leftdelim_;
239 docstring rightdelim_;
250 /// Language dependent macro definitions needed for this inset
251 docstring langpreamble_;
252 /// Language and babel dependent macro definitions needed for this inset
253 docstring babelpreamble_;
255 bool fixedwidthpreambleencoding_;
257 docstring refprefix_;
259 mutable std::string htmltag_;
261 mutable std::string htmlattr_;
263 std::string htmlinnertag_;
265 mutable std::string htmlinnerattr_;
267 std::string htmllabel_;
269 docstring htmlstyle_;
270 /// Cache for default CSS info for this inset.
271 mutable docstring htmldefaultstyle_;
272 /// Cache for default CSS class.
273 mutable std::string defaultcssclass_;
274 /// Whether to force generation of default CSS even if some is given.
275 /// False by default.
278 docstring htmlpreamble_;
282 std::string docbooktag_;
284 std::string docbookattr_;
286 std::set<std::string> required_;
296 docstring passthru_chars_;
298 std::string newline_cmd_;
300 bool parbreakisnewline_;
302 bool parbreakignored_;
316 bool needmboxprotect_;
317 /// should the contents be written to TOC strings?
319 /// check spelling of this inset?
326 bool forcelocalfontswitch_;
327 /** Name of an insetlayout that has replaced this insetlayout.
328 This is used to rename an insetlayout, while keeping backward
331 docstring obsoleted_by_;
333 Layout::LaTeXArgMap latexargs_;
335 Layout::LaTeXArgMap postcommandargs_;
339 std::string toc_type_;
341 bool is_toc_caption_;
347 InsetLayout::InsetLyXType translateLyXType(std::string const & str);
348 InsetLayout::InsetDecoration translateDecoration(std::string const & str);