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>
38 OutputParams(Encoding const *);
41 /** The latex that we export depends occasionally on what is to
46 /** Are we to write a 'nice' LaTeX file or not.
47 This esentially seems to mean whether InsetInclude, InsetGraphics
48 and InsetExternal should add the absolute path to any external
53 /** moving_arg == true means that the environment in which the inset
54 is typeset is a moving argument. The inset should take care about
55 fragile commands by preceding the latex with \\protect.
59 /** intitle == true means that the environment in which the
60 inset is typeset is part of a title (before a \\maketitle).
61 Footnotes in such environments have moving arguments.
65 /** the font at the point where the inset is
67 Font const * local_font;
69 /** Document language babel name
71 mutable std::string document_language;
73 /** Current stream encoding. Only used for LaTeX.
74 This must be set to the document encoding (via the constructor)
75 before output starts. Afterwards it must be kept up to date for
76 each single character (\sa Paragraph::latex).
77 This does also mean that you need to set it back if you use a
78 copy (e.g. in insets): \code
79 int InsetFoo::latex(..., OutputParams const & runparams_in) const
81 OutputParams runparams(runparams_in);
82 runparams.inComment = true;
84 InsetBla::latex(..., runparams);
86 runparams_in.encoding = runparams.encoding;
90 mutable Encoding const * encoding;
92 /** free_spacing == true means that the inset is in a free-spacing
97 /** This var is set by the return value from BufferParams::writeLaTeX
101 /** Are we using japanese (pLaTeX)?
105 /** Line length to use with plaintext export.
109 /** The depth of the current paragraph, set for plaintext
110 * export and used by InsetTabular
114 /** Export data filled in by the latex(), docbook() etc methods.
115 This is a hack: Make it possible to add stuff to constant
116 OutputParams instances.
118 boost::shared_ptr<ExportData> exportdata;
120 /** Whether we are inside a comment inset. Insets that are including
121 * external files like InsetGraphics, InsetInclude and InsetExternal
122 * may only write the usual output and must not attempt to do
123 * something with the included files (e.g. copying, converting)
124 * if this flag is true, since they may not exist.
128 /** Whether we are inside an inset that is logically deleted.
129 * A value > 0 indicates a deleted inset.
133 /** The change information of the outermost logically deleted inset.
134 * changeOfDeletedInset shall only be evaluated if inDeletedInset > 0.
136 Change changeOfDeletedInset;
138 /** allow output of only part of the top-level paragraphs
139 * par_begin: beginning paragraph
143 /** allow output of only part of the top-level paragraphs
144 * par_end: par_end-1 is the ending paragraph
145 * if par_begin=par_end, output all paragraphs
149 /** whether or not do actual file copying and image conversion
150 * This mode will be used to preview the source code
153 /// Should we output verbatim or escape LaTeX's special chars?
160 #endif // NOT OUTPUTPARAMS_H