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>
37 OutputParams(Encoding const *);
40 /** The latex that we export depends occasionally on what is to
45 /** Are we to write a 'nice' LaTeX file or not.
46 This esentially seems to mean whether InsetInclude, InsetGraphics
47 and InsetExternal should add the absolute path to any external
52 /** moving_arg == true means that the environment in which the inset
53 is typeset is a moving argument. The inset should take care about
54 fragile commands by preceding the latex with \\protect.
58 /** intitle == true means that the environment in which the
59 inset is typeset is part of a title (before a \\maketitle).
60 Footnotes in such environments have moving arguments.
64 /** the font at the point where the inset is
66 LyXFont const * local_font;
68 /** Document language babel name
70 mutable std::string document_language;
72 /** Current stream encoding. Only used for LaTeX.
73 This must be set to the document encoding (via the constructor)
74 before output starts. Afterwards it must be kept up to date for
75 each single character (\see Paragraph::simpleTeXOnePar).
76 This does also mean that you need to set it back if you use a
77 copy (e.g. in insets): \code
78 int InsetFoo::latex(..., OutputParams const & runparams_in) const
80 OutputParams runparams(runparams_in);
81 runparams.inComment = true;
83 InsetBla::latex(..., runparams);
85 runparams_in.encoding = runparams.encoding;
89 mutable Encoding const * encoding;
91 /** free_spacing == true means that the inset is in a free-spacing
96 /** This var is set by the return value from BufferParams::writeLaTeX
100 /** Line length to use with plaintext export.
104 /** The depth of the current paragraph, set for plaintext
105 * export and used by InsetTabular
109 /** Export data filled in by the latex(), docbook() etc methods.
110 This is a hack: Make it possible to add stuff to constant
111 OutputParams instances.
113 boost::shared_ptr<ExportData> exportdata;
115 /** Whether we are inside a comment inset. Insets that are including
116 * external files like InsetGraphics, InsetInclude and InsetExternal
117 * may only write the usual output and must not attempt to do
118 * something with the included files (e.g. copying, converting)
119 * if this flag is true, since they may not exist.
123 /** allow output of only part of the top-level paragraphs
124 * par_begin: beginning paragraph
128 /** allow output of only part of the top-level paragraphs
129 * par_end: par_end-1 is the ending paragraph
130 * if par_begin=par_end, output all paragraphs
134 /** whether or not do actual file copying and image conversion
135 * This mode will be used to preview the source code
143 #endif // NOT OUTPUTPARAMS_H