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
17 #include "support/types.h"
18 #include <boost/shared_ptr.hpp>
53 OutputParams(Encoding const *);
56 /** The latex that we export depends occasionally on what is to
61 /** Are we to write a 'nice' LaTeX file or not.
62 This esentially seems to mean whether InsetInclude, InsetGraphics
63 and InsetExternal should add the absolute path to any external
68 /** moving_arg == true means that the environment in which the inset
69 is typeset is a moving argument. The inset should take care about
70 fragile commands by preceding the latex with \\protect.
74 /** intitle == true means that the environment in which the
75 inset is typeset is part of a title (before a \\maketitle).
76 Footnotes in such environments have moving arguments.
80 /** inulemcmd == true means that the environment in which the
81 inset is typeset is part of a ulem command (\uline, \uuline,
82 \uwave, or \sout). Insets that output latex commands relying
83 on local assignments (such as \cite) should enclose such
84 commands in \mbox{} in order to avoid breakage.
86 mutable bool inulemcmd;
88 /** the font at the point where the inset is
90 Font const * local_font;
92 /** Document language babel name
94 mutable std::string document_language;
96 /** The master language. Non-null only for child documents.
98 mutable Language const * master_language;
100 /** Current stream encoding. Only used for LaTeX.
101 This must be set to the document encoding (via the constructor)
102 before output starts. Afterwards it must be kept up to date for
103 each single character (\sa Paragraph::latex).
104 This does also mean that you need to set it back if you use a
105 copy (e.g. in insets): \code
106 int InsetFoo::latex(..., OutputParams const & runparams_in) const
108 OutputParams runparams(runparams_in);
109 runparams.inComment = true;
111 InsetBla::latex(..., runparams);
113 runparams_in.encoding = runparams.encoding;
117 mutable Encoding const * encoding;
119 /** free_spacing == true means that the inset is in a free-spacing
124 /** This var is set by the return value from BufferParams::writeLaTeX
128 /** Are we generating multiple indices?
132 /** Are we using japanese (pLaTeX)?
136 /** Customized bibtex_command
138 mutable std::string bibtex_command;
140 /** Customized index_command
142 mutable std::string index_command;
144 /** Line length to use with plaintext or LaTeX export.
148 /** The depth of the current paragraph, set for plaintext
149 * export and used by InsetTabular
153 /** Export data filled in by the latex(), docbook() etc methods.
154 This is a hack: Make it possible to add stuff to constant
155 OutputParams instances.
157 boost::shared_ptr<ExportData> exportdata;
159 /** Whether we are inside a comment inset. Insets that are including
160 * external files like InsetGraphics, InsetInclude and InsetExternal
161 * may only write the usual output and must not attempt to do
162 * something with the included files (e.g. copying, converting)
163 * if this flag is true, since they may not exist.
167 /** Whether we are in a table cell.
168 * For newline, it matters whether its content is aligned or not.
170 TableCell inTableCell;
172 /** Whether we are inside a float or subfloat.
173 * Needed for subfloat detection on the command line.
177 /** Whether we are inside an index inset.
178 * ERT needs to know this, due to the active chars.
182 /** Whether we are inside an inset that is logically deleted.
183 * A value > 0 indicates a deleted inset.
187 /** The change information of the outermost logically deleted inset.
188 * changeOfDeletedInset shall only be evaluated if inDeletedInset > 0.
190 Change changeOfDeletedInset;
192 /** allow output of only part of the top-level paragraphs
193 * par_begin: beginning paragraph
197 /** allow output of only part of the top-level paragraphs
198 * par_end: par_end-1 is the ending paragraph
199 * if par_begin=par_end, output all paragraphs
203 /// is this the last paragraph in the current buffer/inset?
206 /** whether or not do actual file copying and image conversion
207 * This mode will be used to preview the source code
210 /// Should we output verbatim or escape LaTeX's special chars?
212 /// Should we output captions?
213 bool html_disable_captions;
214 /// Are we already in a paragraph?
221 #endif // NOT OUTPUTPARAMS_H