* BufferView::updateMetrics(): split up the method in two for the SinglePar case.

[lyx.git] / src / BufferParams.h

diff --git a/src/BufferParams.h b/src/BufferParams.h
index 11049c3380f1da54579c12aac0c51a4e5ca66043..bf3968ecb08aa8df15fa261ce99c045d2510fd0e 100644 (file)
--- a/src/BufferParams.h
+++ b/src/BufferParams.h
@@ -15,19 +15,18 @@
 #ifndef BUFFERPARAMS_H
 #define BUFFERPARAMS_H
 
+#include "BiblioInfo.h"
 #include "TextClass.h"
 #include "paper.h"
 
 #include "insets/InsetQuotes.h"
 
 #include "support/copied_ptr.h"
+#include "support/FileName.h"
 #include "support/types.h"
 
-#include "frontends/controllers/frontend_helpers.h"
-
 #include <vector>
 
-
 namespace lyx {
 
 class AuthorList;
@@ -40,10 +39,10 @@ class Spacing;
 class TexRow;
 class VSpace;
 class Language;
-
+class PDFOptions;
 
 /** Buffer parameters.
- *  This class contains all the parameters for this a buffer uses. Some
+ *  This class contains all the parameters for this buffer's use. Some
  *  work needs to be done on this class to make it nice. Now everything
  *  is in public.
  */
@@ -87,7 +86,7 @@ public:
        ///
        void setDefSkip(VSpace const & vs);
 
-       /** Wether paragraphs are separated by using a indent like in
+       /** Whether paragraphs are separated by using a indent like in
         *  articles or by using a little skip like in letters.
         */
        PARSEP paragraph_separation;
@@ -97,10 +96,40 @@ public:
        InsetQuotes::quote_times quotes_times;
        ///
        std::string fontsize;
-       ///
-       textclass_type textclass;
-       ///
+       ///Get the LyX TextClass (that is, the layout file) this document is using.
+       textclass_type getBaseClass() const;
+       ///Set the LyX TextClass (that is, the layout file) this document is using.
+       ///NOTE This also calls makeTextClass(), to update the local
+       ///TextClass.
+       bool setBaseClass(textclass_type);
+       ///Returns the TextClass currently in use: the BaseClass as modified
+       ///by modules.
        TextClass const & getTextClass() const;
+       ///Returns a pointer to the TextClass currently in use: the BaseClass 
+       ///as modified by modules. (See \file TextClass.h for the typedef.)
+       TextClassPtr getTextClassPtr() const;
+       ///Set the LyX TextClass---layout file---this document is using.
+       ///This does NOT call makeTextClass() and so should be used with
+       ///care. This is most likely not what you want if you are operating on 
+       ///BufferParams that are actually associatd with a Buffer. If, on the
+       ///other hand, you are using a temporary set of BufferParams---say, in
+       ///a controller, it may well be, since in that case the local TextClass
+       ///has nothing to do.
+       void setJustBaseClass(textclass_type);
+       /// 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(TextClassPtr);
+       /// 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.
+       bool addLayoutModule(std::string modName, bool makeClass = true);
+       /// Add a list of modules.
+       /// Returns true if all modules were successfully added.
+       bool addLayoutModules(std::vector<std::string>modNames);
+       /// Clear the list
+       void clearLayoutModules();
 
        /// returns the main font for the buffer (document)
        Font const getFont() const;
@@ -201,16 +230,6 @@ public:
        /// \param index should lie in the range 0 <= \c index <= 3.
        Bullet & user_defined_bullet(size_type index);
        Bullet const & user_defined_bullet(size_type index) const;
-       ///
-       void readPreamble(Lexer &);
-       ///
-       void readLanguage(Lexer &);
-       ///
-       void readGraphicsDriver(Lexer &);
-       ///
-       void readBullets(Lexer &);
-       ///
-       void readBulletsLaTeX(Lexer &);
 
        /// Whether to load a package such as amsmath or esint.
        /// The enum values must not be changed (file format!)
@@ -240,6 +259,8 @@ public:
        std::string parentname;
        ///
        bool compressed;
+       ///
+       bool embedded;
 
        /// the author list for the document
        AuthorList & authors();
@@ -254,7 +275,7 @@ public:
        /// set up if and how babel is called
        std::string const babelCall(std::string const & lang_opts) const;
        /// handle inputenc etc.
-       docstring const writeEncodingPreamble(LaTeXFeatures & features,
+       void writeEncodingPreamble(odocstream & os, LaTeXFeatures & features,
                                              TexRow & texrow) const;
        /// set up the document fonts
        std::string const loadFonts(std::string const & rm,
@@ -269,7 +290,39 @@ public:
        ///
        void setCiteEngine(biblio::CiteEngine const);
 
+       /// options for pdf output
+       PDFOptions & pdfoptions();
+       PDFOptions const & pdfoptions() const;
+
 private:
+       ///
+       void readPreamble(Lexer &);
+       ///
+       void readLanguage(Lexer &);
+       ///
+       void readGraphicsDriver(Lexer &);
+       ///
+       void readBullets(Lexer &);
+       ///
+       void readBulletsLaTeX(Lexer &);
+       ///
+       void readModules(Lexer &);
+       /// Adds the module information to the baseClass information to
+       /// create our local TextClass.
+       void makeTextClass();
+
+       
+       /// for use with natbib
+       biblio::CiteEngine cite_engine_;
+       /// the base TextClass associated with the document
+       textclass_type baseClass_;
+       /// the possibly modular TextClass actually in use
+       TextClassPtr textClass_;
+       ///
+       typedef std::vector<std::string> LayoutModuleList;
+       /// 
+       LayoutModuleList layoutModules_;
+
        /** Use the Pimpl idiom to hide those member variables that would otherwise
         *  drag in other header files.
         */
@@ -281,8 +334,6 @@ private:
        };
        support::copied_ptr<Impl, MemoryTraits> pimpl_;
 
-       ///
-       biblio::CiteEngine cite_engine_;
 };
 
 } // namespace lyx