* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
* \author Jean-Marc Lasgouttes
* \author John Levon
- * \author André Pönitz
+ * \author André Pönitz
*
* Full author contact details are available in file CREDITS.
*/
#ifndef BUFFERPARAMS_H
#define BUFFERPARAMS_H
+#include "Citation.h"
#include "Font.h"
-#include "BiblioInfo.h"
+#include "LayoutModuleList.h"
#include "paper.h"
#include "insets/InsetQuotes.h"
#include "support/copied_ptr.h"
+#include <list>
#include <vector>
namespace lyx {
/// read a header token, if unrecognised, return it or an unknown class name
std::string readToken(Lexer & lex,
std::string const & token, ///< token to read.
- support::FileName const & filepath,
- support::FileName const & temppath); ///< where to look for local layout file.
+ support::FileName const & filepath);
///
void writeFile(std::ostream &) const;
DocumentClass const & documentClass() const;
/// \return A pointer to the DocumentClass currently in use: the BaseClass
/// as modified by modules.
- DocumentClass * documentClassPtr() const;
+ DocumentClass const * 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);
/// List of modules in use
- std::vector<std::string> const & getModules() const;
- /// Add a module to the list of modules in use.
- /// Returns true if module was successfully added.
- /// The makeClass variable signals whether to call makeDocumentClass. This
- /// need not be done if we know this isn't the final time through, or if
- /// the BufferParams do not represent the parameters for an actual buffer
- /// (as in GuiDocument).
+ LayoutModuleList const & getModules() const { return layoutModules_; }
+ /// List of default modules the user has removed
+ std::list<std::string> const & getRemovedModules() const
+ { return removedModules_; }
+ ///
+ /// 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.
+ /// \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;
+ ///
+ void addRemovedModule(std::string const & modName)
+ { removedModules_.push_back(modName); }
/// Clear the list
- void clearLayoutModules();
+ void clearLayoutModules() { layoutModules_.clear(); }
+ /// Clear the removed module list
+ void clearRemovedModules() { removedModules_.clear(); }
/// returns the main font for the buffer (document)
Font const getFont() const;
int fontsSansScale;
/// the scale factor of the tt font
int fontsTypewriterScale;
+ /// the font used by the CJK command
+ std::string fontsCJK;
///
Spacing & spacing();
Spacing const & spacing() const;
///
std::string preamble;
///
+ std::string local_layout;
+ ///
std::string options;
+ /// use the class options defined in the layout?
+ bool use_default_options;
+ ///
+ std::string master;
///
std::string float_placement;
///
bool outputChanges;
///
bool compressed;
- ///
- bool embedded;
- ///
- std::vector<std::string> & extraEmbeddedFiles();
- std::vector<std::string> const & extraEmbeddedFiles() const;
/// the author list for the document
AuthorList & authors();
std::string paperSizeName(PapersizePurpose purpose) const;
/// set up if and how babel is called
std::string babelCall(std::string const & lang_opts) const;
+ /// return supported drivers for specific packages
+ docstring getGraphicsDriver(std::string const & package) const;
/// handle inputenc etc.
void writeEncodingPreamble(odocstream & os, LaTeXFeatures & features,
TexRow & texrow) const;
int const & sfscale, int const & ttscale) const;
/// get the appropriate cite engine (natbib handling)
- biblio::CiteEngine citeEngine() const;
+ CiteEngine citeEngine() const;
///
- void setCiteEngine(biblio::CiteEngine const);
+ void setCiteEngine(CiteEngine const);
/// options for pdf output
PDFOptions & pdfoptions();
///
void readPreamble(Lexer &);
///
+ void readLocalLayout(Lexer &);
+ ///
void readLanguage(Lexer &);
///
void readGraphicsDriver(Lexer &);
void readBulletsLaTeX(Lexer &);
///
void readModules(Lexer &);
-
+ ///
+ void readRemovedModules(Lexer &);
/// for use with natbib
- biblio::CiteEngine cite_engine_;
+ CiteEngine cite_engine_;
///
DocumentClass * doc_class_;
- ///
- typedef std::vector<std::string> LayoutModuleList;
///
LayoutModuleList layoutModules_;
+ /// this is for modules that are required by the document class but that
+ /// the user has chosen not to use
+ std::list<std::string> removedModules_;
/** Use the Pimpl idiom to hide those member variables that would otherwise
* drag in other header files.