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 docstring counter() const { return counter_; }
113 docstring refprefix() const { return refprefix_; }
114 /// The tag enclosing all the material in this inset. Default is "span".
115 std::string const & htmltag() const;
116 /// Additional attributes for inclusion with the start tag. Default (if
117 /// a tag is provided) is: class="name".
118 std::string const & htmlattr() const;
119 /// Tag for individual paragraphs in the inset. Default is none.
120 std::string const & htmlinnertag() const { return htmlinnertag_; }
121 /// Attributes for that tag. Default (if a tag is provided) is:
122 /// class="name_inner".
123 std::string const & htmlinnerattr() const;
124 /// A label for this environment, possibly including a reference
125 /// to a counter. E.g., for footnote, it might be:
126 /// \arabic{footnote}
128 /// FIXME Could we get this from the layout?
129 std::string const & htmllabel() const { return htmllabel_; }
131 inline std::string htmllabeltag() const { return "span"; }
133 std::string htmllabelattr() const
134 { return "class=\"" + defaultCSSClass() + "_label\""; }
135 /// CSS associated with this inset.
136 docstring htmlstyle() const;
137 /// Additional material for the header.
138 docstring htmlpreamble() const { return htmlpreamble_; }
139 /// Whether this inset represents a "block" of material, i.e., a set
140 /// of paragraphs of its own (true), or should be run into the previous
141 /// paragraph (false). Examples:
142 /// For branches, this is false.
143 /// For footnotes, this is true.
144 /// Defaults to true.
145 bool htmlisblock() const { return htmlisblock_; }
147 std::set<std::string> requires() const { return requires_; }
149 bool isMultiPar() const { return multipar_; }
151 bool forcePlainLayout() const { return forceplain_; }
153 bool allowParagraphCustomization() const { return custompars_; }
155 bool isPassThru() const { return passthru_; }
157 bool parbreakIsNewline() const { return parbreakisnewline_; }
159 bool isNeedProtect() const { return needprotect_; }
161 bool isFreeSpacing() const { return freespacing_; }
163 bool isKeepEmpty() const { return keepempty_; }
165 bool forceLTR() const { return forceltr_; }
167 bool forceOwnlines() const { return forceownlines_; }
169 bool isInToc() const { return intoc_; }
171 bool spellcheck() const { return spellcheck_; }
173 bool resetsFont() const { return resetsfont_; }
175 bool isDisplay() const { return display_; }
177 bool forcelocalfontswitch() const { return forcelocalfontswitch_; }
179 docstring const & obsoleted_by() const { return obsoleted_by_; }
182 void makeDefaultCSS() const;
184 std::string defaultCSSClass() const;
186 void readArgument(Lexer &);
190 * This is only used (at present) to decide where to put them on the menus.
191 * Values are 'charstyle', 'custom' (things that by default look like a
192 * footnote), 'element' (docbook), 'standard'.
194 InsetLyXType lyxtype_;
196 docstring labelstring_;
198 bool contentaslabel_;
200 InsetDecoration decoration_;
202 InsetLaTeXType latextype_;
204 std::string latexname_;
206 std::string latexparam_;
208 docstring leftdelim_;
210 docstring rightdelim_;
221 /// Language dependent macro definitions needed for this inset
222 docstring langpreamble_;
223 /// Language and babel dependent macro definitions needed for this inset
224 docstring babelpreamble_;
226 docstring refprefix_;
228 mutable std::string htmltag_;
230 mutable std::string htmlattr_;
232 std::string htmlinnertag_;
234 mutable std::string htmlinnerattr_;
236 std::string htmllabel_;
238 docstring htmlstyle_;
239 /// Cache for default CSS info for this inset.
240 mutable docstring htmldefaultstyle_;
241 /// Cache for default CSS class.
242 mutable std::string defaultcssclass_;
243 /// Whether to force generation of default CSS even if some is given.
244 /// False by default.
247 docstring htmlpreamble_;
251 std::set<std::string> requires_;
261 bool parbreakisnewline_;
272 /// should the contents be written to TOC strings?
274 /// check spelling of this inset?
281 bool forcelocalfontswitch_;
282 /** Name of an insetlayout that has replaced this insetlayout.
283 This is used to rename an insetlayout, while keeping backward
286 docstring obsoleted_by_;
288 Layout::LaTeXArgMap latexargs_;
290 Layout::LaTeXArgMap postcommandargs_;
294 InsetLayout::InsetLyXType translateLyXType(std::string const & str);
295 InsetLayout::InsetDecoration translateDecoration(std::string const & str);