Add Qt's Svg module to the list of used modules. This is required to allow the use...

[lyx.git] / src / Buffer.h

diff --git a/src/Buffer.h b/src/Buffer.h
index 4e5565449003dbdd82474a65238d30c2bffa8d30..b50d5f408a7251c717f238595a2bccf9aa39b464 100644 (file)
--- a/src/Buffer.h
+++ b/src/Buffer.h
@@ -15,8 +15,6 @@
 #include "OutputEnums.h"
 #include "OutputParams.h"
 
-#include "insets/InsetCode.h"
-
 #include "support/strfwd.h"
 #include "support/types.h"
 
@@ -136,7 +134,10 @@ public:
                ExportTexPathHasSpaces,
                ExportConverterError,
                // preview
+               // Implies ExportSuccess.
                PreviewSuccess,
+               // The exported file exists but there was an error when opening
+               // it in a viewer.
                PreviewError
        };
 
@@ -232,13 +233,14 @@ public:
        /// read a new document from a string
        bool readString(std::string const &);
        /// Reloads the LyX file
-       /// \param clearUndo if false, leave alone the undo stack.
-       ReadStatus reload(bool clearUndo = true);
+       ReadStatus reload();
 //FIXME: The following function should be private
 //private:
        /// read the header, returns number of unknown tokens
        int readHeader(Lexer & lex);
 
+       double fontScalingFactor() const;
+
 private:
        ///
        typedef std::map<Buffer const *, Buffer *> BufferMap;
@@ -401,6 +403,25 @@ public:
        /// It is always an absolute path.
        std::string filePath() const;
 
+       /** Returns the path where the document was last saved.
+        *  It may be different from filePath() if the document was later
+        *  manually moved to a different location.
+        *  It is always an absolute path.
+        */
+       std::string originFilePath() const;
+
+       /** Returns the path where a local layout file lives.
+        *  An empty string is returned for standard system and user layouts.
+        *  If possible, it is always relative to the buffer path.
+        */
+       std::string layoutPos() const;
+
+       /** Set the path to a local layout file.
+        *  This must be an absolute path but, if possible, it is always
+        *  stored as relative to the buffer path.
+        */
+       void setLayoutPos(std::string const & path);
+
        /** A transformed version of the file name, adequate for LaTeX.
            \param no_path optional if \c true then the path is stripped.
        */
@@ -513,6 +534,8 @@ public:
        ///
        BufferParams & params();
        BufferParams const & params() const;
+       ///
+       BufferParams const & masterParams() const;
 
        /** The list of paragraphs.
            This is a linked list of paragraph, this list holds the
@@ -595,7 +618,7 @@ public:
 
        /// get source code (latex/docbook) for some paragraphs, or all paragraphs
        /// including preamble
-       void getSourceCode(odocstream & os, std::string const format,
+       void getSourceCode(odocstream & os, std::string const & format,
                           pit_type par_begin, pit_type par_end, OutputWhat output,
                           bool master) const;
 
@@ -641,21 +664,22 @@ public:
 
        ///
        ExportStatus doExport(std::string const & target, bool put_in_tempdir) const;
-       ///
-       ExportStatus doExport(std::string const & target, bool put_in_tempdir,
-               std::string & result_file) const;
-       ///
+       /// Export buffer to format \p format and open the result in a suitable viewer.
+       /// Note: This has nothing to do with preview of graphics or math formulas.
        ExportStatus preview(std::string const & format) const;
+       /// true if there was a previous preview this session of this buffer and
+       /// there was an error on the previous preview of this buffer.
+       bool lastPreviewError() const;
 
 private:
+       ///
+       ExportStatus doExport(std::string const & target, bool put_in_tempdir,
+               std::string & result_file) const;
        /// target is a format name optionally followed by a space
        /// and a destination file-name
        ExportStatus doExport(std::string const & target, bool put_in_tempdir,
                bool includeall, std::string & result_file) const;
        ///
-       ExportStatus doExport(std::string const & target, bool put_in_tempdir,
-               bool includeall) const;
-       ///
        ExportStatus preview(std::string const & format, bool includeall = false) const;
        ///
        void setMathFlavor(OutputParams & op) const;
@@ -708,6 +732,18 @@ public:
        ///
        void checkMasterBuffer();
 
+       /// If the document is being saved to a new location and the named file
+       /// exists at the old location, return its updated path relative to the
+       /// new buffer path if possible, otherwise return its absolute path.
+       /// In all other cases, this is a no-op and name is returned unchanged.
+       /// If a non-empty ext is given, the existence of name.ext is checked
+       /// but the returned path will not contain this extension.
+       /// Similarly, when loading a document that was moved from the location
+       /// where it was saved, return the correct path relative to the new
+       /// location.
+       std::string includedFilePath(std::string const & name,
+                               std::string const & ext = empty_string()) const;
+
        /// compute statistics between \p from and \p to
        /// \p from initial position
        /// \p to points to the end position