#ifndef BUFFERPARAMS_H
#define BUFFERPARAMS_H
-#include "BiblioInfo.h"
#include "Font.h"
+#include "Citation.h"
#include "paper.h"
#include "insets/InsetQuotes.h"
#include "support/copied_ptr.h"
-#include "support/types.h"
+#include <set>
#include <vector>
namespace lyx {
-namespace support {
-class FileName;
-}
+namespace support { class FileName; }
class AuthorList;
class BranchList;
class Bullet;
+class DocumentClass;
class Encoding;
class Language;
-class Lexer;
class LatexFeatures;
+class LayoutFile;
+class LayoutFileIndex;
+class Lexer;
class PDFOptions;
class Spacing;
-class TextClass;
-class TextClassIndex;
class TexRow;
class VSpace;
class BufferParams {
public:
///
- enum PARSEP {
+ typedef std::vector<std::string> LayoutModuleList;
+ ///
+ enum ParagraphSeparation {
///
- PARSEP_INDENT,
+ ParagraphIndentSeparation,
///
- PARSEP_SKIP
+ ParagraphSkipSeparation
};
///
BufferParams();
- ~BufferParams();
/// get l10n translated to the buffers language
- docstring const B_(std::string const & l10n) const;
+ docstring 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 readToken(Lexer & lex,
std::string const & token, ///< token to read.
- support::FileName const & filepath); ///< where to look for local layout file.
+ support::FileName const & filepath);
///
void writeFile(std::ostream &) const;
///
void useClassDefaults();
-
///
bool hasClassDefaults() const;
///
VSpace const & getDefSkip() const;
-
///
void setDefSkip(VSpace const & vs);
/** Whether paragraphs are separated by using a indent like in
* articles or by using a little skip like in letters.
*/
- PARSEP paragraph_separation;
+ ParagraphSeparation paragraph_separation;
///
- InsetQuotes::quote_language quotes_language;
+ InsetQuotes::QuoteLanguage quotes_language;
///
- InsetQuotes::quote_times quotes_times;
+ InsetQuotes::QuoteTimes quotes_times;
///
std::string fontsize;
- /// Get the LyX TextClass (that is, the layout file) this document is using.
- TextClassIndex baseClass() const;
- /// Set the LyX TextClass (that is, the layout file) this document is using.
- /// NOTE: This does not call makeTextClass() to update the local TextClass.
- /// That needs to be done manually.
- bool setBaseClass(TextClassIndex const & index);
+ ///Get the LayoutFile this document is using.
+ LayoutFile const * baseClass() const;
+ ///
+ LayoutFileIndex const & baseClassID() const;
+ /// Set the LyX layout file this document is using.
+ /// 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 TextClass.
- void makeTextClass();
- /// Returns the TextClass currently in use: the BaseClass as modified
+ /// create our local DocumentClass.
+ void makeDocumentClass();
+ /// Returns the DocumentClass currently in use: the BaseClass as modified
/// by modules.
- TextClass const & textClass() const;
- /// Returns a pointer to the TextClass currently in use: the BaseClass
- /// as modified by modules. (See \file TextClass.h for the definition.)
- TextClassIndex textClassIndex() const;
+ DocumentClass const & documentClass() const;
+ /// \return A pointer to the DocumentClass currently in use: the BaseClass
+ /// as modified by modules.
+ 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 setTextClass(TextClassIndex const & index);
+ void setDocumentClass(DocumentClass const * const);
/// List of modules in use
- std::vector<std::string> const & getModules() const;
+ LayoutModuleList const & getModules() const { return layoutModules_; }
+ /// List of default modules the user has removed
+ std::set<std::string> const & getRemovedModules() const
+ { return removedModules_; }
+ ///
/// Add a module to the list of modules in use.
/// Returns true if module was successfully added.
- /// The makeClass variable signals whether to call makeTextClass. This
+ /// 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).
bool addLayoutModule(std::string const & modName);
+ ///
+ void addRemovedModule(std::string const & modName)
+ { removedModules_.insert(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;
/// the author list for the document
AuthorList & authors();
* purpose for which the paper size is needed, since they
* support different subsets of paper sizes.
*/
- enum Papersize_Purpose {
+ enum PapersizePurpose {
///
DVIPS,
///
XDVI
};
///
- std::string const paperSizeName(Papersize_Purpose const & purpose) const;
- /// set up if and how babel is called
- std::string const babelCall(std::string const & lang_opts) const;
+ std::string paperSizeName(PapersizePurpose purpose) 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 getEngine() 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_;
///
- typedef std::vector<std::string> LayoutModuleList;
+ DocumentClass * doc_class_;
///
LayoutModuleList layoutModules_;
+ /// this is for modules that are required by the document class but that
+ /// the user has chosen not to use
+ std::set<std::string> removedModules_;
/** Use the Pimpl idiom to hide those member variables that would otherwise
* drag in other header files.
projects / lyx.git / blobdiff