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>
54 OutputParams(Encoding const *);
57 /** The latex that we export depends occasionally on what is to
62 /** Are we to write a 'nice' LaTeX file or not.
63 This esentially seems to mean whether InsetInclude, InsetGraphics
64 and InsetExternal should add the absolute path to any external
69 /** moving_arg == true means that the environment in which the inset
70 is typeset is a moving argument. The inset should take care about
71 fragile commands by preceding the latex with \\protect.
75 /** intitle == true means that the environment in which the
76 inset is typeset is part of a title (before a \\maketitle).
77 Footnotes in such environments have moving arguments.
81 /** inulemcmd == true means that the environment in which the
82 inset is typeset is part of a ulem command (\uline, \uuline,
83 \uwave, or \sout). Insets that output latex commands relying
84 on local assignments (such as \cite) should enclose such
85 commands in \mbox{} in order to avoid breakage.
87 mutable bool inulemcmd;
89 /** the font at the point where the inset is
91 Font const * local_font;
93 /** Document language babel name
95 mutable std::string document_language;
97 /** The master language. Non-null only for child documents.
99 mutable Language const * master_language;
101 /** Current stream encoding. Only used for LaTeX.
102 This must be set to the document encoding (via the constructor)
103 before output starts. Afterwards it must be kept up to date for
104 each single character (\sa Paragraph::latex).
105 This does also mean that you need to set it back if you use a
106 copy (e.g. in insets): \code
107 int InsetFoo::latex(..., OutputParams const & runparams_in) const
109 OutputParams runparams(runparams_in);
110 runparams.inComment = true;
112 InsetBla::latex(..., runparams);
114 runparams_in.encoding = runparams.encoding;
118 mutable Encoding const * encoding;
120 /** free_spacing == true means that the inset is in a free-spacing
125 /** This var is set by the return value from BufferParams::writeLaTeX
129 /** Are we generating multiple indices?
133 /** Are we using japanese (pLaTeX)?
137 /** Customized bibtex_command
139 mutable std::string bibtex_command;
141 /** Customized index_command
143 mutable std::string index_command;
145 /** Line length to use with plaintext or LaTeX export.
149 /** The depth of the current paragraph, set for plaintext
150 * export and used by InsetTabular
154 /** Export data filled in by the latex(), docbook() etc methods.
155 This is a hack: Make it possible to add stuff to constant
156 OutputParams instances.
158 boost::shared_ptr<ExportData> exportdata;
160 /** Whether we are inside a comment inset. Insets that are including
161 * external files like InsetGraphics, InsetInclude and InsetExternal
162 * may only write the usual output and must not attempt to do
163 * something with the included files (e.g. copying, converting)
164 * if this flag is true, since they may not exist.
168 /** Whether we are in a table cell.
169 * For newline, it matters whether its content is aligned or not.
171 TableCell inTableCell;
173 /** Whether we are inside a float or subfloat.
174 * Needed for subfloat detection on the command line.
178 /** Whether we are inside an index inset.
179 * ERT needs to know this, due to the active chars.
183 /** Whether we are inside an inset that is logically deleted.
184 * A value > 0 indicates a deleted inset.
188 /** The change information of the outermost logically deleted inset.
189 * changeOfDeletedInset shall only be evaluated if inDeletedInset > 0.
191 Change changeOfDeletedInset;
193 /** allow output of only part of the top-level paragraphs
194 * par_begin: beginning paragraph
198 /** allow output of only part of the top-level paragraphs
199 * par_end: par_end-1 is the ending paragraph
200 * if par_begin=par_end, output all paragraphs
204 /// is this the last paragraph in the current buffer/inset?
208 /** whether or not do actual file copying and image conversion
209 * This mode will be used to preview the source code
213 /// Should we output verbatim or escape LaTeX's special chars?
216 /// Should we output captions?
217 bool html_disable_captions;
219 /// Are we already in a paragraph?
222 /// Does the present context even permit paragraphs?
225 /// Are we generating this material for inclusion in a TOC-like entity?
228 /// Include all children notwithstanding the use of \includeonly
235 #endif // NOT OUTPUTPARAMS_H