#include "support/copied_ptr.h"
#include "support/types.h"
+#include "frontends/controllers/biblio.h"
+
#include <vector>
+namespace lyx {
+
class AuthorList;
class BranchList;
class Bullet;
+class Encoding;
class LyXLex;
class LatexFeatures;
class Spacing;
class TexRow;
class VSpace;
-struct Language;
-
-
-namespace lyx {
-namespace biblio {
-
-enum CiteEngine {
- ENGINE_BASIC,
- ENGINE_NATBIB_AUTHORYEAR,
- ENGINE_NATBIB_NUMERICAL,
- ENGINE_JURABIB
-};
-
-class CiteEngine_enum {
- CiteEngine val_;
-public:
- CiteEngine_enum(CiteEngine val) : val_(val) {}
- operator CiteEngine() const{ return val_; }
-};
-
-} // namespace biblio
-} // namespace lyx
+class Language;
/** Buffer parameters.
* the BufferParams and a LyXRC variable).
* This returned value can then be passed to the insets...
*/
- bool writeLaTeX(std::ostream &, LaTeXFeatures &, TexRow &) const;
-
- ///
- void setPaperStuff();
+ bool writeLaTeX(odocstream &, LaTeXFeatures &, TexRow &) const;
///
void useClassDefaults();
///
std::string fontsize;
///
- lyx::textclass_type textclass;
+ textclass_type textclass;
///
LyXTextClass const & getLyXTextClass() const;
+ /// returns the main font for the buffer (document)
+ LyXFont const getFont() const;
+
/* this are for the PaperLayout */
- /// the general papersize (papersize2 or paperpackage
+ /// the papersize
PAPER_SIZE papersize;
- /// the selected Geometry papersize
- VMARGIN_PAPER_TYPE papersize2;
- /// a special paperpackage .sty-file
- PAPER_PACKAGES paperpackage;
///
PAPER_ORIENTATION orientation;
- ///
+ /// use custom margins
bool use_geometry;
///
std::string paperwidth;
/* some LaTeX options */
/// The graphics driver
std::string graphicsDriver;
- ///
- std::string fonts;
+ /// the rm font
+ std::string fontsRoman;
+ /// the sf font
+ std::string fontsSans;
+ /// the tt font
+ std::string fontsTypewriter;
+ /// the default family (rm, sf, tt)
+ std::string fontsDefaultFamily;
+ /// use expert Small Caps
+ bool fontsSC;
+ /// use Old Style Figures
+ bool fontsOSF;
+ /// the scale factor of the sf font
+ int fontsSansScale;
+ /// the scale factor of the tt font
+ int fontsTypewriterScale;
///
Spacing & spacing();
Spacing const & spacing() const;
/// BranchList:
BranchList & branchlist();
BranchList const & branchlist() const;
- ///
+ /**
+ * The input encoding for LaTeX. This can be one of
+ * - \c auto: find out the input encoding from the used languages
+ * - \c default: ditto
+ * - any encoding supported by the inputenc package
+ * The encoding of the LyX file is always utf8 and has nothing to
+ * do with this setting.
+ * The difference between \c auto and \c default is that \c auto also
+ * causes loading of the inputenc package, while \c default does not.
+ * \c default will not work unless the user takes additional measures
+ * (such as using special environments like the CJK environment from
+ * CJK.sty).
+ * \c default can be seen as an unspecified 8bit encoding, since LyX
+ * does not interpret it in any way apart from display on screen.
+ */
std::string inputenc;
+ /// The main encoding used by this buffer for LaTeX output.
+ /// Individual pieces of text can use different encodings.
+ Encoding const & encoding() const;
///
std::string preamble;
///
///
std::string pagestyle;
/// \param index should lie in the range 0 <= \c index <= 3.
- Bullet & temp_bullet(lyx::size_type index);
- Bullet const & temp_bullet(lyx::size_type index) const;
+ Bullet & temp_bullet(size_type index);
+ Bullet const & temp_bullet(size_type index) const;
/// \param index should lie in the range 0 <= \c index <= 3.
- Bullet & user_defined_bullet(lyx::size_type index);
- Bullet const & user_defined_bullet(lyx::size_type index) const;
+ Bullet & user_defined_bullet(size_type index);
+ Bullet const & user_defined_bullet(size_type index) const;
///
void readPreamble(LyXLex &);
///
void readLanguage(LyXLex &);
///
void readGraphicsDriver(LyXLex &);
+ ///
+ void readBullets(LyXLex &);
+ ///
+ void readBulletsLaTeX(LyXLex &);
- /// use AMS package, not, or auto
- enum AMS {
- AMS_OFF,
- AMS_AUTO,
- AMS_ON
+ /// Whether to load a package such as amsmath or esint.
+ /// The enum values must not be changed (file format!)
+ enum Package {
+ /// Don't load the package. For experts only.
+ package_off = 0,
+ /// Load the package if needed (recommended)
+ package_auto = 1,
+ /// Always load the package (e.g. if the document contains
+ /// some ERT that needs the package)
+ package_on = 2
};
- AMS use_amsmath;
- ///
- lyx::biblio::CiteEngine cite_engine;
+ /// Whether and how to load amsmath
+ Package use_amsmath;
+ /// Whether and how to load esint
+ Package use_esint;
///
bool use_bibtopic;
/// revision tracking for this buffer ?
- bool tracking_changes;
+ bool trackChanges;
+ /** This param decides whether change tracking marks should be output
+ * (using the dvipost package) or if the current "state" of the
+ * document should be output instead. Since dvipost needs dvi
+ * specials, it only works with dvi/ps output (the param will be
+ * ignored with other output flavors and disabled when dvipost is
+ * not installed).
+ */
+ bool outputChanges;
/// Time ago we agreed that this was a buffer property [ale990407]
std::string parentname;
///
AuthorList const & authors() const;
/// map of the file's author IDs to buffer author IDs
- std::vector<int> author_map;
+ std::vector<unsigned int> author_map;
///
std::string const dvips_options() const;
///
std::string const paperSizeName() const;
///
std::string const babelCall(std::string const & lang_opts) const;
+ /// set up the document fonts
+ std::string const loadFonts(std::string const & rm,
+ std::string const & sf, std::string const & tt,
+ bool const & sc, bool const & osf,
+ int const & sfscale, int const & ttscale) const;
+ /// path of the current buffer
+ std::string filepath;
+ /// get the appropriate cite engine (natbib handling)
+ biblio::CiteEngine getEngine() const;
+
+ ///
+ void setCiteEngine(biblio::CiteEngine const);
private:
/** Use the Pimpl idiom to hide those member variables that would otherwise
* drag in other header files.
*/
class Impl;
- struct MemoryTraits {
+ class MemoryTraits {
+ public:
static Impl * clone(Impl const *);
static void destroy(Impl *);
};
- lyx::support::copied_ptr<Impl, MemoryTraits> pimpl_;
+ support::copied_ptr<Impl, MemoryTraits> pimpl_;
+
+ ///
+ biblio::CiteEngine cite_engine_;
};
+} // namespace lyx
+
#endif