X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBufferList.h;h=242eff03bea24d34d5750b670bd9511767055b64;hb=b8f04ae29ad0e484ae010dd2364f61164cffca56;hp=c703cd2a04cddd83ae7840336cc3d76de0d30567;hpb=c5487a368239775893ec4ac85cb81aaa477e0cc7;p=lyx.git diff --git a/src/BufferList.h b/src/BufferList.h index c703cd2a04..242eff03be 100644 --- a/src/BufferList.h +++ b/src/BufferList.h @@ -19,6 +19,7 @@ namespace lyx { +class Author; class Buffer; class OutputParams; @@ -46,9 +47,13 @@ public: iterator end(); const_iterator end() const; - /// create a new buffer + /// create a new buffer and add it to the buffer list + /// \return 0 if the Buffer creation is not possible for whatever reason. + Buffer * newBuffer(std::string const & s); + + /// create an internal buffer and add it to the internal buffer list /// \return 0 if the Buffer creation is not possible for whatever reason. - Buffer * newBuffer(std::string const & s, bool ronly = false); + Buffer * newInternalBuffer(std::string const & s); /// delete a buffer void release(Buffer * b); @@ -61,13 +66,7 @@ public: void closeAll(); /// returns a vector with all the buffers filenames - support::FileNameList const & fileNames() const; - - /// FIXME - void updateIncludedTeXfiles(std::string const &, OutputParams const &); - - /// emergency save for all buffers - void emergencyWriteAll(); + support::FileNameList fileNames() const; /// return true if no buffers loaded bool empty() const; @@ -84,14 +83,21 @@ public: /// returns true if the buffer is loaded bool isLoaded(Buffer const * b) const; - /// return index of named buffer in buffer list + /// \return index of named buffer in buffer list int bufferNum(support::FileName const & name) const; - /// returns a pointer to the buffer with the given name. - Buffer * getBuffer(support::FileName const &) const; - /// returns a pointer to the buffer with the given number. + + /** returns a pointer to the buffer with the given name + * + * \param internal + * If true, the buffer is searched also among internal buffers + */ + Buffer * getBuffer(support::FileName const & name, bool internal = false) const; + + /// \return a pointer to the buffer with the given number Buffer * getBuffer(unsigned int); - /// returns a pointer to the buffer whose temppath matches the string - Buffer * getBufferFromTmp(std::string const &); + + /// \return a pointer to the buffer whose temppath matches the given path + Buffer * getBufferFromTmp(std::string const & path); /** returns a pointer to the buffer that follows argument in * buffer list. The buffer following the last in list is the @@ -105,10 +111,25 @@ public: */ Buffer * previous(Buffer const *) const; + /// \name Functions that just operate on all buffers + //@{ /// reset current author for all buffers - void setCurrentAuthor(docstring const & name, docstring const & email); + void recordCurrentAuthor(Author const & author); + /// update previews for all buffers, e.g. for Prefs update + void updatePreviews(); + /// Call changed() on all buffers, internal or not + void changed(bool update_metrics) const; + /// emergency save for all buffers + void emergencyWriteAll(); + /// FIXME + void updateIncludedTeXfiles(std::string const &, OutputParams const &); + //@} private: + /// create a new buffer + /// \return 0 if the Buffer creation is not possible for whatever reason. + Buffer * createNewBuffer(std::string const & s); + /// noncopiable BufferList(BufferList const &); void operator=(BufferList const &);