X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBufferParams.h;h=bf3968ecb08aa8df15fa261ce99c045d2510fd0e;hb=2417d9d911dbca181c48f45d1aad26d31c9aa815;hp=2ac436a7038f2af3260302eaaf02d4a7a120d129;hpb=39e79d8602920eefe36e898c9f415afb979521b2;p=lyx.git diff --git a/src/BufferParams.h b/src/BufferParams.h index 2ac436a703..bf3968ecb0 100644 --- a/src/BufferParams.h +++ b/src/BufferParams.h @@ -15,19 +15,18 @@ #ifndef BUFFERPARAMS_H #define BUFFERPARAMS_H -#include "LyXTextClass.h" +#include "BiblioInfo.h" +#include "TextClass.h" #include "paper.h" #include "insets/InsetQuotes.h" #include "support/copied_ptr.h" +#include "support/FileName.h" #include "support/types.h" -#include "frontends/controllers/frontend_helpers.h" - #include - namespace lyx { class AuthorList; @@ -40,10 +39,10 @@ class Spacing; class TexRow; class VSpace; class Language; - +class PDFOptions; /** Buffer parameters. - * This class contains all the parameters for this a buffer uses. Some + * This class contains all the parameters for this buffer's use. Some * work needs to be done on this class to make it nice. Now everything * is in public. */ @@ -60,6 +59,9 @@ public: BufferParams(); ~BufferParams(); + /// get l10n translated to the buffers language + docstring const B_(std::string const & l10n) const; + /// read a header token, if unrecognised, return it or an unknown class name std::string const readToken(Lexer & lex, std::string const & token); @@ -84,7 +86,7 @@ public: /// void setDefSkip(VSpace const & vs); - /** Wether paragraphs are separated by using a indent like in + /** Whether paragraphs are separated by using a indent like in * articles or by using a little skip like in letters. */ PARSEP paragraph_separation; @@ -94,13 +96,43 @@ public: InsetQuotes::quote_times quotes_times; /// std::string fontsize; - /// - textclass_type textclass; - /// - LyXTextClass const & getLyXTextClass() const; + ///Get the LyX TextClass (that is, the layout file) this document is using. + textclass_type getBaseClass() const; + ///Set the LyX TextClass (that is, the layout file) this document is using. + ///NOTE This also calls makeTextClass(), to update the local + ///TextClass. + bool setBaseClass(textclass_type); + ///Returns the TextClass currently in use: the BaseClass as modified + ///by modules. + TextClass const & getTextClass() const; + ///Returns a pointer to the TextClass currently in use: the BaseClass + ///as modified by modules. (See \file TextClass.h for the typedef.) + TextClassPtr getTextClassPtr() const; + ///Set the LyX TextClass---layout file---this document is using. + ///This does NOT call makeTextClass() and so should be used with + ///care. This is most likely not what you want if you are operating on + ///BufferParams that are actually associatd with a Buffer. If, on the + ///other hand, you are using a temporary set of BufferParams---say, in + ///a controller, it may well be, since in that case the local TextClass + ///has nothing to do. + void setJustBaseClass(textclass_type); + /// This bypasses the baseClass and sets the textClass directly. + /// Should be called with care and would be better not being here, + /// but it seems to be needed by CutAndPaste::putClipboard(). + void setTextClass(TextClassPtr); + /// List of modules in use + std::vector const & getModules() const; + /// Add a module to the list of modules in use. + /// Returns true if module was successfully added. + bool addLayoutModule(std::string modName, bool makeClass = true); + /// Add a list of modules. + /// Returns true if all modules were successfully added. + bool addLayoutModules(std::vectormodNames); + /// Clear the list + void clearLayoutModules(); /// returns the main font for the buffer (document) - LyXFont const getFont() const; + Font const getFont() const; /* this are for the PaperLayout */ /// the papersize @@ -186,8 +218,10 @@ public: std::string float_placement; /// unsigned int columns; + /// parameters for the listings package + std::string listings_params; /// - LyXTextClass::PageSides sides; + TextClass::PageSides sides; /// std::string pagestyle; /// \param index should lie in the range 0 <= \c index <= 3. @@ -196,16 +230,6 @@ public: /// \param index should lie in the range 0 <= \c index <= 3. Bullet & user_defined_bullet(size_type index); Bullet const & user_defined_bullet(size_type index) const; - /// - void readPreamble(Lexer &); - /// - void readLanguage(Lexer &); - /// - void readGraphicsDriver(Lexer &); - /// - void readBullets(Lexer &); - /// - void readBulletsLaTeX(Lexer &); /// Whether to load a package such as amsmath or esint. /// The enum values must not be changed (file format!) @@ -226,18 +250,17 @@ public: bool use_bibtopic; /// revision tracking for this buffer ? 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). + /** This param decides whether change tracking marks should be used + * in output (irrespective of how these marks are actually defined; + * for instance, they may differ for DVI and PDF generation) */ bool outputChanges; /// Time ago we agreed that this was a buffer property [ale990407] std::string parentname; /// bool compressed; + /// + bool embedded; /// the author list for the document AuthorList & authors(); @@ -249,8 +272,11 @@ public: std::string const dvips_options() const; /// std::string const paperSizeName() const; - /// + /// set up if and how babel is called std::string const babelCall(std::string const & lang_opts) const; + /// handle inputenc etc. + void writeEncodingPreamble(odocstream & os, LaTeXFeatures & features, + TexRow & texrow) const; /// set up the document fonts std::string const loadFonts(std::string const & rm, std::string const & sf, std::string const & tt, @@ -264,7 +290,39 @@ public: /// void setCiteEngine(biblio::CiteEngine const); + /// options for pdf output + PDFOptions & pdfoptions(); + PDFOptions const & pdfoptions() const; + private: + /// + void readPreamble(Lexer &); + /// + void readLanguage(Lexer &); + /// + void readGraphicsDriver(Lexer &); + /// + void readBullets(Lexer &); + /// + void readBulletsLaTeX(Lexer &); + /// + void readModules(Lexer &); + /// Adds the module information to the baseClass information to + /// create our local TextClass. + void makeTextClass(); + + + /// for use with natbib + biblio::CiteEngine cite_engine_; + /// the base TextClass associated with the document + textclass_type baseClass_; + /// the possibly modular TextClass actually in use + TextClassPtr textClass_; + /// + typedef std::vector LayoutModuleList; + /// + LayoutModuleList layoutModules_; + /** Use the Pimpl idiom to hide those member variables that would otherwise * drag in other header files. */ @@ -276,8 +334,6 @@ private: }; support::copied_ptr pimpl_; - /// - biblio::CiteEngine cite_engine_; }; } // namespace lyx