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 {
59 bool read(Lexer & lexrc, TextClass const & tclass);
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 bool contentaslabel() const { return contentaslabel_; }
71 InsetDecoration decoration() const { return decoration_; }
73 InsetLaTeXType latextype() const { return latextype_; }
75 std::string latexname() const { return latexname_; }
77 std::string latexparam() const { return latexparam_; }
79 docstring leftdelim() const { return leftdelim_; }
81 docstring rightdelim() const { return rightdelim_; }
83 FontInfo font() const { return font_; }
85 FontInfo labelfont() const { return labelfont_; }
87 ColorCode bgcolor() const { return bgcolor_; }
89 Layout::LaTeXArgMap const & latexargs() const { return latexargs_; }
91 Layout::LaTeXArgMap const & postcommandargs() const { return postcommandargs_; }
92 /// Returns latexargs() + postcommandargs().
93 /// But note that it returns a *copy*, not a reference, so do not do
95 /// Layout::LaTeXArgMap::iterator it = args().begin();
96 /// Layout::LaTeXArgMap::iterator en = args().end();
97 /// Those are iterators for different containers.
98 Layout::LaTeXArgMap args() const;
100 unsigned int optArgs() const;
102 unsigned int requiredArgs() const;
104 docstring preamble() const { return preamble_; }
105 /// Get language dependent macro definitions needed for this inset
106 docstring const langpreamble() const { return langpreamble_; }
107 /// Get language and babel dependent macro definitions needed for
109 docstring const babelpreamble() const { return babelpreamble_; }
111 bool fixedwidthpreambleencoding() const { return fixedwidthpreambleencoding_; }
113 docstring counter() const { return counter_; }
115 docstring refprefix() const { return refprefix_; }
116 /// The tag enclosing all the material in this inset. Default is "span".
117 std::string const & htmltag() const;
118 /// Additional attributes for inclusion with the start tag. Default (if
119 /// a tag is provided) is: class="name".
120 std::string const & htmlattr() const;
121 /// Tag for individual paragraphs in the inset. Default is none.
122 std::string const & htmlinnertag() const { return htmlinnertag_; }
123 /// Attributes for that tag. Default (if a tag is provided) is:
124 /// class="name_inner".
125 std::string const & htmlinnerattr() const;
126 /// A label for this environment, possibly including a reference
127 /// to a counter. E.g., for footnote, it might be:
128 /// \arabic{footnote}
130 /// FIXME Could we get this from the layout?
131 std::string const & htmllabel() const { return htmllabel_; }
133 inline std::string htmllabeltag() const { return "span"; }
135 std::string htmllabelattr() const
136 { return "class=\"" + defaultCSSClass() + "_label\""; }
137 /// CSS associated with this inset.
138 docstring htmlstyle() const;
139 /// Additional material for the header.
140 docstring htmlpreamble() const { return htmlpreamble_; }
141 /// Whether this inset represents a "block" of material, i.e., a set
142 /// of paragraphs of its own (true), or should be run into the previous
143 /// paragraph (false). Examples:
144 /// For branches, this is false.
145 /// For footnotes, this is true.
146 /// Defaults to true.
147 bool htmlisblock() const { return htmlisblock_; }
149 std::set<std::string> requires() const { return requires_; }
151 bool isMultiPar() const { return multipar_; }
153 bool forcePlainLayout() const { return forceplain_; }
155 bool allowParagraphCustomization() const { return custompars_; }
157 bool isPassThru() const { return passthru_; }
159 docstring passThruChars() const { return passthru_chars_; }
161 bool parbreakIsNewline() const { return parbreakisnewline_; }
163 bool isNeedProtect() const { return needprotect_; }
165 bool needsCProtect() const { return needcprotect_; }
167 bool isFreeSpacing() const { return freespacing_; }
169 bool isKeepEmpty() const { return keepempty_; }
171 bool forceLTR() const { return forceltr_; }
173 bool forceOwnlines() const { return forceownlines_; }
175 bool isInToc() const { return intoc_; }
177 bool spellcheck() const { return spellcheck_; }
179 bool resetsFont() const { return resetsfont_; }
181 bool isDisplay() const { return display_; }
183 bool forcelocalfontswitch() const { return forcelocalfontswitch_; }
185 docstring const & obsoleted_by() const { return obsoleted_by_; }
187 bool addToToc() const { return add_to_toc_; }
189 std::string tocType() const { return toc_type_; }
191 bool isTocCaption() const { return is_toc_caption_; }
194 void makeDefaultCSS() const;
196 std::string defaultCSSClass() const;
198 void readArgument(Lexer &);
202 * This is only used (at present) to decide where to put them on the menus.
203 * Values are 'charstyle', 'custom' (things that by default look like a
204 * footnote), 'element' (docbook), 'standard'.
206 InsetLyXType lyxtype_;
208 docstring labelstring_;
210 bool contentaslabel_;
212 InsetDecoration decoration_;
214 InsetLaTeXType latextype_;
216 std::string latexname_;
218 std::string latexparam_;
220 docstring leftdelim_;
222 docstring rightdelim_;
233 /// Language dependent macro definitions needed for this inset
234 docstring langpreamble_;
235 /// Language and babel dependent macro definitions needed for this inset
236 docstring babelpreamble_;
238 bool fixedwidthpreambleencoding_;
240 docstring refprefix_;
242 mutable std::string htmltag_;
244 mutable std::string htmlattr_;
246 std::string htmlinnertag_;
248 mutable std::string htmlinnerattr_;
250 std::string htmllabel_;
252 docstring htmlstyle_;
253 /// Cache for default CSS info for this inset.
254 mutable docstring htmldefaultstyle_;
255 /// Cache for default CSS class.
256 mutable std::string defaultcssclass_;
257 /// Whether to force generation of default CSS even if some is given.
258 /// False by default.
261 docstring htmlpreamble_;
265 std::set<std::string> requires_;
275 docstring passthru_chars_;
277 bool parbreakisnewline_;
290 /// should the contents be written to TOC strings?
292 /// check spelling of this inset?
299 bool forcelocalfontswitch_;
300 /** Name of an insetlayout that has replaced this insetlayout.
301 This is used to rename an insetlayout, while keeping backward
304 docstring obsoleted_by_;
306 Layout::LaTeXArgMap latexargs_;
308 Layout::LaTeXArgMap postcommandargs_;
312 std::string toc_type_;
314 bool is_toc_caption_;
318 InsetLayout::InsetLyXType translateLyXType(std::string const & str);
319 InsetLayout::InsetDecoration translateDecoration(std::string const & str);