4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
10 * \author André Pönitz
12 * Full author contact details are available in file CREDITS.
15 #ifndef BUFFERPARAMS_H
16 #define BUFFERPARAMS_H
18 #include "lyxtextclass.h"
21 #include "insets/insetquotes.h"
23 #include "support/copied_ptr.h"
24 #include "support/types.h"
45 ENGINE_NATBIB_AUTHORYEAR,
46 ENGINE_NATBIB_NUMERICAL,
50 class CiteEngine_enum {
53 CiteEngine_enum(CiteEngine val) : val_(val) {}
54 operator CiteEngine() const{ return val_; }
61 /** Buffer parameters.
62 * This class contains all the parameters for this a buffer uses. Some
63 * work needs to be done on this class to make it nice. Now everything
79 /// read a header token, if unrecognised, return it or an unknown class name
80 std::string const readToken(LyXLex & lex, std::string const & token);
83 void writeFile(std::ostream &) const;
85 /** \returns true if the babel package is used (interogates
86 * the BufferParams and a LyXRC variable).
87 * This returned value can then be passed to the insets...
89 bool writeLaTeX(std::ostream &, LaTeXFeatures &, TexRow &) const;
92 void useClassDefaults();
95 bool hasClassDefaults() const;
98 VSpace const & getDefSkip() const;
101 void setDefSkip(VSpace const & vs);
103 /** Wether paragraphs are separated by using a indent like in
104 * articles or by using a little skip like in letters.
106 PARSEP paragraph_separation;
108 InsetQuotes::quote_language quotes_language;
110 InsetQuotes::quote_times quotes_times;
112 std::string fontsize;
114 lyx::textclass_type textclass;
116 LyXTextClass const & getLyXTextClass() const;
118 /* this are for the PaperLayout */
120 PAPER_SIZE papersize;
121 /// a special paperpackage .sty-file
122 PAPER_PACKAGES paperpackage;
124 PAPER_ORIENTATION orientation;
125 /// use custom margins
128 std::string paperwidth;
130 std::string paperheight;
132 std::string leftmargin;
134 std::string topmargin;
136 std::string rightmargin;
138 std::string bottommargin;
140 std::string headheight;
144 std::string footskip;
146 /* some LaTeX options */
147 /// The graphics driver
148 std::string graphicsDriver;
153 Spacing const & spacing() const;
159 Language const * language;
161 BranchList & branchlist();
162 BranchList const & branchlist() const;
164 std::string inputenc;
166 std::string preamble;
170 std::string float_placement;
172 unsigned int columns;
174 LyXTextClass::PageSides sides;
176 std::string pagestyle;
177 /// \param index should lie in the range 0 <= \c index <= 3.
178 Bullet & temp_bullet(lyx::size_type index);
179 Bullet const & temp_bullet(lyx::size_type index) const;
180 /// \param index should lie in the range 0 <= \c index <= 3.
181 Bullet & user_defined_bullet(lyx::size_type index);
182 Bullet const & user_defined_bullet(lyx::size_type index) const;
184 void readPreamble(LyXLex &);
186 void readLanguage(LyXLex &);
188 void readGraphicsDriver(LyXLex &);
190 void readBullets(LyXLex &);
192 void readBulletsLaTeX(LyXLex &);
194 /// use AMS package, not, or auto
202 lyx::biblio::CiteEngine cite_engine;
205 /// revision tracking for this buffer ?
206 bool tracking_changes;
207 /** This param decides if change tracking marks should be output
208 * (using the dvipost package) or if the current "state" of the
209 * document should be output instead. Since dvipost needs dvi
210 * specials, it only works with dvi/ps output (the param will be
211 * ignored with other output flavors and disabled when dbipost is
215 /// Time ago we agreed that this was a buffer property [ale990407]
216 std::string parentname;
220 /// the author list for the document
221 AuthorList & authors();
222 AuthorList const & authors() const;
224 /// map of the file's author IDs to buffer author IDs
225 std::vector<int> author_map;
227 std::string const dvips_options() const;
229 std::string const paperSizeName() const;
231 std::string const babelCall(std::string const & lang_opts) const;
234 /** Use the Pimpl idiom to hide those member variables that would otherwise
235 * drag in other header files.
240 static Impl * clone(Impl const *);
241 static void destroy(Impl *);
243 lyx::support::copied_ptr<Impl, MemoryTraits> pimpl_;