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"
60 OutputParams(Encoding const *);
63 /** The file that we export depends occasionally on what is to
67 /// is it some flavor of LaTeX?
69 /// does this flavour support full unicode?
70 bool isFullUnicode() const;
72 /// Same, but for math output, which only matter is XHTML output.
73 MathFlavor math_flavor;
75 /** Are we to write a 'nice' LaTeX file or not.
76 This esentially seems to mean whether InsetInclude, InsetGraphics
77 and InsetExternal should add the absolute path to any external
82 /** moving_arg == true means that the environment in which the inset
83 is typeset is a moving argument. The inset should take care about
84 fragile commands by preceding the latex with \\protect.
88 /** intitle == true means that the environment in which the
89 inset is typeset is part of a title (before a \\maketitle).
90 Footnotes in such environments have moving arguments.
94 /** inulemcmd == true means that the environment in which the
95 inset is typeset is part of a ulem command (\uline, \uuline,
96 \uwave, or \sout). Insets that output latex commands relying
97 on local assignments (such as \cite) should enclose such
98 commands in \mbox{} in order to avoid breakage.
100 mutable bool inulemcmd;
102 /** the font at the point where the inset is
104 Font const * local_font;
106 /** Document language babel name
108 mutable std::string document_language;
110 /** The master language. Non-null only for child documents.
112 mutable Language const * master_language;
114 /** Current stream encoding. Only used for LaTeX.
115 This must be set to the document encoding (via the constructor)
116 before output starts. Afterwards it must be kept up to date for
117 each single character (\sa Paragraph::latex).
118 This does also mean that you need to set it back if you use a
119 copy (e.g. in insets): \code
120 int InsetFoo::latex(..., OutputParams const & runparams_in) const
122 OutputParams runparams(runparams_in);
123 runparams.inComment = true;
125 InsetBla::latex(..., runparams);
127 runparams_in.encoding = runparams.encoding;
131 mutable Encoding const * encoding;
133 /** free_spacing == true means that the inset is in a free-spacing
138 /** This var is set by the return value from BufferParams::writeLaTeX
142 /** Do we use polyglossia (instead of babel)?
144 bool use_polyglossia;
146 /** Are we generating multiple indices?
150 /** Are we using japanese (pLaTeX)?
154 /** Customized bibtex_command
156 mutable std::string bibtex_command;
158 /** Customized index_command
160 mutable std::string index_command;
162 /** Line length to use with plaintext or LaTeX export.
166 /** The depth of the current paragraph, set for plaintext
167 * export and used by InsetTabular
171 /** Export data filled in by the latex(), docbook() etc methods.
172 This is a hack: Make it possible to add stuff to constant
173 OutputParams instances.
175 shared_ptr<ExportData> exportdata;
177 /** Whether we are inside a comment inset. Insets that are including
178 * external files like InsetGraphics, InsetInclude and InsetExternal
179 * may only write the usual output and must not attempt to do
180 * something with the included files (e.g. copying, converting)
181 * if this flag is true, since they may not exist.
185 /** Whether we are in a table cell.
186 * For newline, it matters whether its content is aligned or not.
188 TableCell inTableCell;
190 /** Whether we are inside a float or subfloat.
191 * Needed for subfloat detection on the command line.
195 /** Whether we are inside an index inset.
196 * ERT needs to know this, due to the active chars.
200 /** Whether we are inside an inset that is logically deleted.
201 * A value > 0 indicates a deleted inset.
205 /** The change information of the outermost logically deleted inset.
206 * changeOfDeletedInset shall only be evaluated if inDeletedInset > 0.
208 Change changeOfDeletedInset;
210 /** allow output of only part of the top-level paragraphs
211 * par_begin: beginning paragraph
215 /** allow output of only part of the top-level paragraphs
216 * par_end: par_end-1 is the ending paragraph
217 * if par_begin=par_end, output all paragraphs
221 /// is this the last paragraph in the current buffer/inset?
225 /** whether or not do actual file copying and image conversion
226 * This mode will be used to preview the source code
230 /// Should we output verbatim or escape LaTeX's special chars?
233 /// Should we output captions?
234 bool html_disable_captions;
236 /// Are we already in a paragraph?
239 /// Does the present context even permit paragraphs?
242 /// Are we generating this material for inclusion in a TOC-like entity?
245 /// Include all children notwithstanding the use of \includeonly
252 #endif // NOT OUTPUTPARAMS_H