2 /* \file buffer_funcs.h
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Alfredo Braunstein
9 * Full author contact details are available in file CREDITS.
12 #ifndef BUFFER_FUNCS_H
13 #define BUFFER_FUNCS_H
15 #include "lyxlayout_ptr_fwd.h"
16 #include "support/docstring.h"
28 * Loads a LyX file \c filename into \c Buffer
29 * and \return success status.
31 bool loadLyXFile(Buffer *, std::string const & filename);
33 /* Make a new file (buffer) with name \c filename based on a template
34 * named \c templatename
36 Buffer * newFile(std::string const & filename, std::string const & templatename,
37 bool isNamed = false);
39 ///return the format of the buffer on a string
40 std::string const bufferFormat(Buffer const & buffer);
42 /// Fill in the ErrorList with the TeXErrors
43 void bufferErrors(Buffer const &, TeXErrors const &, ErrorList &);
45 /// Count the number of words in the text between these two iterators
46 int countWords(DocIterator const & from, DocIterator const & to);
48 /// Expand the counters for the labelstring of \c layout
49 lyx::docstring expandLabel(Buffer const & buf,
50 LyXLayout_ptr const & layout,
54 /// update labels at "iter".
56 A full updateLabels(Buffer const &) will be called if not possible.
58 void updateLabels(Buffer const & buf, ParIterator & it);
60 /// update labels between "from" and "to" if possible.
62 A full updateLabels(Buffer const &) will be called if not possible.
64 void updateLabels(Buffer const & buf,
65 ParIterator & from, ParIterator & to);
67 /// updates all counters
68 void updateLabels(Buffer const &);
70 #endif // BUFFER_FUNCS_H