X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBufferParams.h;h=306e5bc3d2691383193de70b95a5bf5db697b8f8;hb=e55aa4359f1c31065ead0de542fa134ee6acb6f7;hp=4a483b99483e156c8026bdab00ba812b1fe03b0c;hpb=5a7672adec7da591fe5c43ebcf8787a1fa11aa2c;p=lyx.git diff --git a/src/BufferParams.h b/src/BufferParams.h index 4a483b9948..306e5bc3d2 100644 --- a/src/BufferParams.h +++ b/src/BufferParams.h @@ -16,6 +16,7 @@ #define BUFFERPARAMS_H #include "Citation.h" +#include "DocumentClassPtr.h" #include "Format.h" #include "LayoutModuleList.h" #include "OutputParams.h" @@ -123,17 +124,21 @@ public: bool setBaseClass(std::string const & classname); /// Adds the module information to the baseClass information to /// create our local DocumentClass. + /// NOTE: This should NEVER be called externally unless one immediately goes + /// on to class BufferView::updateDocumentClass(). The exception, of course, + /// is in GuiDocument, where we use a BufferParams simply to hold a copy of + /// the parameters from the active Buffer. void makeDocumentClass(); /// Returns the DocumentClass currently in use: the BaseClass as modified /// by modules. DocumentClass const & documentClass() const; /// \return A pointer to the DocumentClass currently in use: the BaseClass /// as modified by modules. - DocumentClass const * documentClassPtr() const; + DocumentClassConstPtr documentClassPtr() const; /// 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 setDocumentClass(DocumentClass const * const); + void setDocumentClass(DocumentClassConstPtr); /// List of modules in use LayoutModuleList const & getModules() const { return layout_modules_; } /// List of default modules the user has removed @@ -176,7 +181,8 @@ public: std::vector exportableFormats(bool only_viewable) const; /// bool isExportableFormat(std::string const & format) const; - /// + /// the backends appropriate for use with this document. + /// so, e.g., latex is excluded , if we're using non-TeX fonts std::vector backends() const; /// List of included children (for includeonly) @@ -194,6 +200,9 @@ public: /// returns the main font for the buffer (document) Font const getFont() const; + /// translate quote style string to enum value + InsetQuotes::QuoteLanguage getQuoteStyle(std::string const qs) const; + /* these are for the PaperLayout */ /// the papersize PAPER_SIZE papersize; @@ -239,6 +248,8 @@ public: std::string fonts_sans; /// the tt font std::string fonts_typewriter; + /// the math font + std::string fonts_math; /// the default family (rm, sf, tt) std::string fonts_default_family; /// use the fonts of the OS (OpenType, True Type) directly @@ -343,16 +354,12 @@ public: /// some ERT that needs the package) package_on = 2 }; - /// Whether and how to load amsmath - Package use_amsmath; - /// Whether and how to load esint - Package use_esint; - /// Whether and how to load mhchem - Package use_mhchem; - /// Whether and how to load mathdots - Package use_mathdots; - /// Whether and how to load undertilde - Package use_undertilde; + /// Whether to load a package such as amsmath or esint. + Package use_package(std::string const & p) const; + /// Set whether to load a package such as amsmath or esint. + void use_package(std::string const & p, Package u); + /// All packages that can be switched on or off + static std::vector const & auto_packages(); /// Split bibliography? bool use_bibtopic; /// Split the index? @@ -401,17 +408,39 @@ public: /// std::string const parseFontName(std::string const & name) 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, - bool const & use_nonlatexfonts, - LaTeXFeatures & features) const; - - /// get the appropriate cite engine (natbib handling) - CiteEngine citeEngine() const; - /// - void setCiteEngine(CiteEngine const); + std::string const loadFonts(LaTeXFeatures & features) const; + + /// the cite engine modules + LayoutModuleList const & citeEngine() const + { return cite_engine_; } + /// the type of cite engine (authoryear or numerical) + CiteEngineType const & citeEngineType() const + { return cite_engine_type_; } + /// add the module to the cite engine modules + bool addCiteEngine(std::string const &); + /// add the modules to the cite engine modules + bool addCiteEngine(std::vector const &); + /// clear the list of cite engine modules + void clearCiteEngine() { cite_engine_.clear(); } + /// set the cite engine module + void setCiteEngine(std::string const &); + /// set the cite engine modules + void setCiteEngine(std::vector const &); + /// set the cite engine type + void setCiteEngineType(CiteEngineType const & engine_type) + { cite_engine_type_ = engine_type; } + + /// the available citation commands + std::vector citeCommands() const; + /// the available citation styles + std::vector citeStyles() const; + + /// the default BibTeX style file for the document + std::string biblio_style; + /// the default BibTeX style file from the TextClass + std::string const & defaultBiblioStyle() const; + /// whether the BibTeX style supports full author lists + bool const & fullAuthorList() const; /// options for pdf output PDFOptions & pdfoptions(); @@ -471,10 +500,12 @@ private: typedef std::map DefaultFlavorCache; /// mutable DefaultFlavorCache default_flavors_; - /// for use with natbib - CiteEngine cite_engine_; + /// the cite engine modules + LayoutModuleList cite_engine_; + /// the type of cite engine (authoryear or numerical) + CiteEngineType cite_engine_type_; /// - DocumentClass * doc_class_; + DocumentClassPtr doc_class_; /// LayoutModuleList layout_modules_; /// this is for modules that are required by the document class but that @@ -484,6 +515,12 @@ private: /// the list of included children (for includeonly) std::list included_children_; + typedef std::map PackageMap; + /** Whether and how to load packages like amsmath, esint, mhchem, + * mathdots and undertilde. + */ + PackageMap use_packages; + /** Use the Pimpl idiom to hide those member variables that would otherwise * drag in other header files. */