#define BUFFERPARAMS_H
#include "Citation.h"
+#include "DocumentClassPtr.h"
#include "Format.h"
#include "LayoutModuleList.h"
#include "OutputParams.h"
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
{ return removed_modules_; }
///
/// Add a module to the list of modules in use. This checks only that the
- /// module is not already in the list, so use moduleIsCompatible first if
- /// you want to check for compatibility.
+ /// module is not already in the list, so use layoutModuleCanBeAdeed first
+ /// if you want to check for compatibility.
/// \return true if module was successfully added.
bool addLayoutModule(std::string const & modName);
/// checks to make sure module's requriements are satisfied, that it does
/// not conflict with already-present modules, isn't already loaded, etc.
- bool moduleCanBeAdded(std::string const & modName) const;
+ bool layoutModuleCanBeAdded(std::string const & modName) const;
+ /// same, but for citaton modules.
+ bool citationModuleCanBeAdded(std::string const & modName) const;
///
void addRemovedModule(std::string const & modName)
{ removed_modules_.push_back(modName); }
std::vector<Format const *> 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<std::string> backends() const;
/// List of included children (for includeonly)
/// 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;
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
///
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<std::string> 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<std::string> const &);
+ /// set the cite engine type
+ void setCiteEngineType(CiteEngineType const & engine_type)
+ { cite_engine_type_ = engine_type; }
+
+ /// the available citation commands
+ std::vector<std::string> citeCommands() const;
+ /// the available citation styles
+ std::vector<CitationStyle> 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();
typedef std::map<std::string, OutputParams::FLAVOR> 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
typedef std::map<std::string, Package> PackageMap;
/** Whether and how to load packages like amsmath, esint, mhchem,
- * mathdots and undertilde.
+ * mathdots, stackrel, stmaryrd and undertilde.
*/
PackageMap use_packages;
projects / lyx.git / blobdiff