4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Angus Leeming
9 * Full author contact details are available in file CREDITS.
12 #ifndef OUTPUTPARAMS_H
13 #define OUTPUTPARAMS_H
16 #include "support/shared_ptr.h"
59 OutputParams(Encoding const *);
62 /** The file that we export depends occasionally on what is to
66 /// is it some flavor of LaTeX?
69 /// Same, but for math output, which only matter is XHTML output.
70 MathFlavor math_flavor;
72 /** Are we to write a 'nice' LaTeX file or not.
73 This esentially seems to mean whether InsetInclude, InsetGraphics
74 and InsetExternal should add the absolute path to any external
79 /** moving_arg == true means that the environment in which the inset
80 is typeset is a moving argument. The inset should take care about
81 fragile commands by preceding the latex with \\protect.
85 /** intitle == true means that the environment in which the
86 inset is typeset is part of a title (before a \\maketitle).
87 Footnotes in such environments have moving arguments.
91 /** inulemcmd == true means that the environment in which the
92 inset is typeset is part of a ulem command (\uline, \uuline,
93 \uwave, or \sout). Insets that output latex commands relying
94 on local assignments (such as \cite) should enclose such
95 commands in \mbox{} in order to avoid breakage.
97 mutable bool inulemcmd;
99 /** the font at the point where the inset is
101 Font const * local_font;
103 /** Document language babel name
105 mutable std::string document_language;
107 /** The master language. Non-null only for child documents.
109 mutable Language const * master_language;
111 /** Current stream encoding. Only used for LaTeX.
112 This must be set to the document encoding (via the constructor)
113 before output starts. Afterwards it must be kept up to date for
114 each single character (\sa Paragraph::latex).
115 This does also mean that you need to set it back if you use a
116 copy (e.g. in insets): \code
117 int InsetFoo::latex(..., OutputParams const & runparams_in) const
119 OutputParams runparams(runparams_in);
120 runparams.inComment = true;
122 InsetBla::latex(..., runparams);
124 runparams_in.encoding = runparams.encoding;
128 mutable Encoding const * encoding;
130 /** free_spacing == true means that the inset is in a free-spacing
135 /** This var is set by the return value from BufferParams::writeLaTeX
139 /** Are we generating multiple indices?
143 /** Are we using japanese (pLaTeX)?
147 /** Customized bibtex_command
149 mutable std::string bibtex_command;
151 /** Customized index_command
153 mutable std::string index_command;
155 /** Line length to use with plaintext or LaTeX export.
159 /** The depth of the current paragraph, set for plaintext
160 * export and used by InsetTabular
164 /** Export data filled in by the latex(), docbook() etc methods.
165 This is a hack: Make it possible to add stuff to constant
166 OutputParams instances.
168 shared_ptr<ExportData> exportdata;
170 /** Whether we are inside a comment inset. Insets that are including
171 * external files like InsetGraphics, InsetInclude and InsetExternal
172 * may only write the usual output and must not attempt to do
173 * something with the included files (e.g. copying, converting)
174 * if this flag is true, since they may not exist.
178 /** Whether we are in a table cell.
179 * For newline, it matters whether its content is aligned or not.
181 TableCell inTableCell;
183 /** Whether we are inside a float or subfloat.
184 * Needed for subfloat detection on the command line.
188 /** Whether we are inside an index inset.
189 * ERT needs to know this, due to the active chars.
193 /** Whether we are inside an inset that is logically deleted.
194 * A value > 0 indicates a deleted inset.
198 /** The change information of the outermost logically deleted inset.
199 * changeOfDeletedInset shall only be evaluated if inDeletedInset > 0.
201 Change changeOfDeletedInset;
203 /** allow output of only part of the top-level paragraphs
204 * par_begin: beginning paragraph
208 /** allow output of only part of the top-level paragraphs
209 * par_end: par_end-1 is the ending paragraph
210 * if par_begin=par_end, output all paragraphs
214 /// is this the last paragraph in the current buffer/inset?
218 /** whether or not do actual file copying and image conversion
219 * This mode will be used to preview the source code
223 /// Should we output verbatim or escape LaTeX's special chars?
226 /// Should we output captions?
227 bool html_disable_captions;
229 /// Are we already in a paragraph?
232 /// Does the present context even permit paragraphs?
235 /// Are we generating this material for inclusion in a TOC-like entity?
238 /// Include all children notwithstanding the use of \includeonly
245 #endif // NOT OUTPUTPARAMS_H