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 /// returns the main font for the buffer (document)
119 LyXFont const getFont() const;
121 /* this are for the PaperLayout */
123 PAPER_SIZE papersize;
125 PAPER_ORIENTATION orientation;
126 /// use custom margins
129 std::string paperwidth;
131 std::string paperheight;
133 std::string leftmargin;
135 std::string topmargin;
137 std::string rightmargin;
139 std::string bottommargin;
141 std::string headheight;
145 std::string footskip;
147 /* some LaTeX options */
148 /// The graphics driver
149 std::string graphicsDriver;
154 Spacing const & spacing() const;
160 Language const * language;
162 BranchList & branchlist();
163 BranchList const & branchlist() const;
165 std::string inputenc;
167 std::string preamble;
171 std::string float_placement;
173 unsigned int columns;
175 LyXTextClass::PageSides sides;
177 std::string pagestyle;
178 /// \param index should lie in the range 0 <= \c index <= 3.
179 Bullet & temp_bullet(lyx::size_type index);
180 Bullet const & temp_bullet(lyx::size_type index) const;
181 /// \param index should lie in the range 0 <= \c index <= 3.
182 Bullet & user_defined_bullet(lyx::size_type index);
183 Bullet const & user_defined_bullet(lyx::size_type index) const;
185 void readPreamble(LyXLex &);
187 void readLanguage(LyXLex &);
189 void readGraphicsDriver(LyXLex &);
191 void readBullets(LyXLex &);
193 void readBulletsLaTeX(LyXLex &);
195 /// use AMS package, not, or auto
203 lyx::biblio::CiteEngine cite_engine;
206 /// revision tracking for this buffer ?
207 bool tracking_changes;
208 /** This param decides whether change tracking marks should be output
209 * (using the dvipost package) or if the current "state" of the
210 * document should be output instead. Since dvipost needs dvi
211 * specials, it only works with dvi/ps output (the param will be
212 * ignored with other output flavors and disabled when dbipost is
216 /// Time ago we agreed that this was a buffer property [ale990407]
217 std::string parentname;
221 /// the author list for the document
222 AuthorList & authors();
223 AuthorList const & authors() const;
225 /// map of the file's author IDs to buffer author IDs
226 std::vector<unsigned int> author_map;
228 std::string const dvips_options() const;
230 std::string const paperSizeName() const;
232 std::string const babelCall(std::string const & lang_opts) const;
233 /// path of the current buffer
234 std::string filepath;
237 /** Use the Pimpl idiom to hide those member variables that would otherwise
238 * drag in other header files.
243 static Impl * clone(Impl const *);
244 static void destroy(Impl *);
246 lyx::support::copied_ptr<Impl, MemoryTraits> pimpl_;