X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBufferParams.h;h=dac9a4aef6c4c9d913710cce9aa2b81ec5a7a290;hb=837869452ad8d917615aa4bca77402dc49ba094e;hp=2c4828e1c48ecae4a03a6813da4ce6f1579940cf;hpb=5db4b7eb168b65335e66fd8f5fc90973592753bb;p=lyx.git diff --git a/src/BufferParams.h b/src/BufferParams.h index 2c4828e1c4..dac9a4aef6 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" @@ -117,27 +118,31 @@ public: /// LayoutFileIndex const & baseClassID() const; /// Set the LyX layout file this document is using. - /// NOTE: This does not call makeDocumentClass() to update the local + /// NOTE: This does not call makeDocumentClass() to update the local /// DocumentClass. That needs to be done manually. /// \param filename the name of the layout file 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; + /// \return A pointer to the DocumentClass currently in use: the BaseClass + /// as modified by modules. + 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 - std::list const & getRemovedModules() const + std::list const & getRemovedModules() const { return removed_modules_; } /// /// Add a module to the list of modules in use. This checks only that the @@ -149,7 +154,7 @@ public: /// not conflict with already-present modules, isn't already loaded, etc. bool moduleCanBeAdded(std::string const & modName) const; /// - void addRemovedModule(std::string const & modName) + void addRemovedModule(std::string const & modName) { removed_modules_.push_back(modName); } /// Clear the list void clearLayoutModules() { layout_modules_.clear(); } @@ -176,14 +181,15 @@ 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) - std::list const & getIncludedChildren() const + std::list const & getIncludedChildren() const { return included_children_; } /// - void addIncludedChildren(std::string const & child) + void addIncludedChildren(std::string const & child) { included_children_.push_back(child); } /// Clear the list of included children void clearIncludedChildren() { included_children_.clear(); } @@ -305,6 +311,8 @@ public: std::string float_placement; /// unsigned int columns; + /// + bool justification; /// parameters for the listings package std::string listings_params; /// @@ -341,14 +349,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 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? @@ -404,10 +410,37 @@ public: bool const & use_nonlatexfonts, LaTeXFeatures & features) const; - /// get the appropriate cite engine (natbib handling) - CiteEngine citeEngine() const; - /// - void setCiteEngine(CiteEngine 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(); @@ -467,11 +500,13 @@ 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_; + /// + DocumentClassPtr doc_class_; /// - DocumentClass * doc_class_; - /// LayoutModuleList layout_modules_; /// this is for modules that are required by the document class but that /// the user has chosen not to use @@ -480,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. */