Fix bug #3038: wish for lfuns for zoom-in and zoom-out

[lyx.git] / src / Buffer.h

diff --git a/src/Buffer.h b/src/Buffer.h
index 23ac227a8e3f5814242d80987c3c184ca3a52b58..e50076f221f70a38173f8cb9903b0ae876455a4a 100644 (file)
--- a/src/Buffer.h
+++ b/src/Buffer.h
@@ -26,6 +26,7 @@ namespace lyx {
 
 class BiblioInfo;
 class BufferParams;
+class BufferSet;
 class DocIterator;
 class ErrorItem;
 class ErrorList;
@@ -109,10 +110,13 @@ public:
                timestamp_method, ///< Use timestamp, and checksum if timestamp has changed
        };
 
-       /** Constructor
-           \param file
-           \param b  optional \c false by default
-       */
+       ///
+       enum UpdateScope {
+               UpdateMaster,
+               UpdateChildOnly
+       };
+
+       /// Constructor
        explicit Buffer(std::string const & file, bool b = false);
 
        /// Destructor
@@ -126,9 +130,6 @@ public:
        /// Maybe we know the function already by number...
        bool dispatch(FuncRequest const & func, bool * result = 0);
 
-       /// Load the autosaved file.
-       void loadAutoSaveFile();
-
        /// read a new document from a string
        bool readString(std::string const &);
        /// load a new file
@@ -139,7 +140,7 @@ public:
 
        /** Reads a file without header.
            \param par if != 0 insert the file.
-           \return \c false if file is not completely read.
+           \return \c true if file is not completely read.
        */
        bool readDocument(Lexer &);
 
@@ -166,7 +167,7 @@ public:
        /// Write file. Returns \c false if unsuccesful.
        bool writeFile(support::FileName const &) const;
 
-  /// Loads LyX file \c filename into buffer, *  and \return success
+       /// Loads LyX file \c filename into buffer, *  and \return success
        bool loadLyXFile(support::FileName const & s);
 
        /// Fill in the ErrorList with the TeXErrors
@@ -272,7 +273,10 @@ public:
 
        /// Set document's parent Buffer.
        void setParent(Buffer const *);
-       Buffer const * parent();
+       Buffer const * parent() const;
+
+       // Collect all relative buffer
+       std::vector<Buffer const *> allRelatives() const;
 
        /** Get the document's master (or \c this if this is not a
            child document)
@@ -281,6 +285,9 @@ public:
 
        /// \return true if \p child is a child of this \c Buffer.
        bool isChild(Buffer * child) const;
+       
+       /// return a vector with all children and grandchildren
+       std::vector<Buffer *> getChildren() const;
 
        /// Is buffer read-only?
        bool isReadonly() const;
@@ -308,12 +315,13 @@ public:
 
        /// Update the cache with all bibfiles in use (including bibfiles
        /// of loaded child documents).
-       void updateBibfilesCache() const;
+       void updateBibfilesCache(UpdateScope scope = UpdateMaster) const;
        ///
        void invalidateBibinfoCache();
        /// Return the cache with all bibfiles in use (including bibfiles
        /// of loaded child documents).
-       support::FileNameList const & getBibfilesCache() const;
+       support::FileNameList const & 
+               getBibfilesCache(UpdateScope scope = UpdateMaster) const;
        /// \return the bibliography information for this buffer's master,
        /// or just for it, if it isn't a child.
        BiblioInfo const & masterBibInfo() const;
@@ -359,6 +367,9 @@ public:
        ///
        ParConstIterator par_iterator_end() const;
 
+       // Position of the child buffer where it appears first in the master.
+       DocIterator firstChildPosition(Buffer const * child);
+
        /** \returns true only when the file is fully loaded.
         *  Used to prevent the premature generation of previews
         *  and by the citation inset.
@@ -438,10 +449,15 @@ public:
        ///
        void message(docstring const & msg) const;
 
+       ///
        void setGuiDelegate(frontend::GuiBufferDelegate * gui);
+       ///
+       bool hasGuiDelegate() const;
 
        ///
        void autoSave() const;
+       ///
+       void removeAutosaveFile() const;
 
        /// return the format of the buffer on a string
        std::string bufferFormat() const;
@@ -466,6 +482,24 @@ public:
        void setInsetLabel(docstring const & label, InsetLabel const * il);
        InsetLabel const * insetLabel(docstring const & label) const;
 
+       /// sets the buffer_ member for every inset in this buffer.
+       // FIXME This really shouldn't be needed, but at the moment it's not
+       // clear how to do it just for the individual pieces we need.
+       void setBuffersForInsets() const;
+       ///
+       void updateLabels(UpdateScope = UpdateMaster) const;
+       ///
+       void updateLabels(ParIterator & parit) const;
+
+       /// Find next word starting from \p from.
+       /// \p from initial position to search, will then points to the next
+       ///    word.
+       /// \p to will points to the end of the next word.
+       /// \p word will contain the found word if any.
+       /// \return true if a new word was found.
+       bool nextWord(DocIterator & from, DocIterator & to,
+               docstring & word) const;
+
 private:
        /// search for macro in local (buffer) table or in children
        MacroData const * getBufferMacro(docstring const & name,
@@ -476,6 +510,9 @@ private:
        void updateMacros(DocIterator & it,
                                     DocIterator & scope) const;
 
+       ///
+       void collectRelatives(BufferSet & bufs) const;
+
        ///
        bool readFileHelper(support::FileName const & s);
        ///
@@ -485,6 +522,8 @@ private:
        */
        ReadStatus readFile(Lexer &, support::FileName const & filename,
                            bool fromString = false);
+       ///
+       support::FileName getAutosaveFilename() const;
 
        /// Use the Pimpl idiom to hide the internals.
        class Impl;