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>
52 OutputParams(Encoding const *);
55 /** The latex that we export depends occasionally on what is to
60 /** Are we to write a 'nice' LaTeX file or not.
61 This esentially seems to mean whether InsetInclude, InsetGraphics
62 and InsetExternal should add the absolute path to any external
67 /** moving_arg == true means that the environment in which the inset
68 is typeset is a moving argument. The inset should take care about
69 fragile commands by preceding the latex with \\protect.
73 /** intitle == true means that the environment in which the
74 inset is typeset is part of a title (before a \\maketitle).
75 Footnotes in such environments have moving arguments.
79 /** inulemcmd == true means that the environment in which the
80 inset is typeset is part of a ulem command (\uline, \uuline,
81 \uwave, or \sout). Insets that output latex commands relying
82 on local assignments (such as \cite) should enclose such
83 commands in \mbox{} in order to avoid breakage.
85 mutable bool inulemcmd;
87 /** the font at the point where the inset is
89 Font const * local_font;
91 /** Document language babel name
93 mutable std::string document_language;
95 /** The master language. Non-null only for child documents.
97 mutable Language const * master_language;
99 /** Current stream encoding. Only used for LaTeX.
100 This must be set to the document encoding (via the constructor)
101 before output starts. Afterwards it must be kept up to date for
102 each single character (\sa Paragraph::latex).
103 This does also mean that you need to set it back if you use a
104 copy (e.g. in insets): \code
105 int InsetFoo::latex(..., OutputParams const & runparams_in) const
107 OutputParams runparams(runparams_in);
108 runparams.inComment = true;
110 InsetBla::latex(..., runparams);
112 runparams_in.encoding = runparams.encoding;
116 mutable Encoding const * encoding;
118 /** free_spacing == true means that the inset is in a free-spacing
123 /** This var is set by the return value from BufferParams::writeLaTeX
127 /** Are we generating multiple indices?
131 /** Are we using japanese (pLaTeX)?
135 /** Customized bibtex_command
137 mutable std::string bibtex_command;
139 /** Customized index_command
141 mutable std::string index_command;
143 /** Line length to use with plaintext or LaTeX export.
147 /** The depth of the current paragraph, set for plaintext
148 * export and used by InsetTabular
152 /** Export data filled in by the latex(), docbook() etc methods.
153 This is a hack: Make it possible to add stuff to constant
154 OutputParams instances.
156 boost::shared_ptr<ExportData> exportdata;
158 /** Whether we are inside a comment inset. Insets that are including
159 * external files like InsetGraphics, InsetInclude and InsetExternal
160 * may only write the usual output and must not attempt to do
161 * something with the included files (e.g. copying, converting)
162 * if this flag is true, since they may not exist.
166 /** Whether we are in a table cell.
167 * For newline, it matters whether its content is aligned or not.
169 TableCell inTableCell;
171 /** Whether we are inside a float or subfloat.
172 * Needed for subfloat detection on the command line.
176 /** Whether we are inside an index inset.
177 * ERT needs to know this, due to the active chars.
181 /** Whether we are inside an inset that is logically deleted.
182 * A value > 0 indicates a deleted inset.
186 /** The change information of the outermost logically deleted inset.
187 * changeOfDeletedInset shall only be evaluated if inDeletedInset > 0.
189 Change changeOfDeletedInset;
191 /** allow output of only part of the top-level paragraphs
192 * par_begin: beginning paragraph
196 /** allow output of only part of the top-level paragraphs
197 * par_end: par_end-1 is the ending paragraph
198 * if par_begin=par_end, output all paragraphs
202 /// is this the last paragraph in the current buffer/inset?
205 /** whether or not do actual file copying and image conversion
206 * This mode will be used to preview the source code
209 /// Should we output verbatim or escape LaTeX's special chars?
211 /// Should we output captions? (Used in HTML output.)
212 bool disable_captions;
218 #endif // NOT OUTPUTPARAMS_H