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"
31 * Loads a LyX file \c filename into \c Buffer
32 * and \return success status.
34 bool loadLyXFile(Buffer *, std::string const & filename);
36 /* Make a new file (buffer) with name \c filename based on a template
37 * named \c templatename
39 Buffer * newFile(std::string const & filename, std::string const & templatename,
40 bool isNamed = false);
42 ///return the format of the buffer on a string
43 std::string const bufferFormat(Buffer const & buffer);
45 /// Fill in the ErrorList with the TeXErrors
46 void bufferErrors(Buffer const &, TeXErrors const &, ErrorList &);
48 /// Count the number of words in the text between these two iterators
49 int countWords(DocIterator const & from, DocIterator const & to);
51 /// Expand the counters for the labelstring of \c layout
52 lyx::docstring expandLabel(Buffer const & buf,
53 LyXLayout_ptr const & layout,
57 /// update labels at "iter".
59 A full updateLabels(Buffer const &) will be called if not possible.
61 void updateLabels(Buffer const & buf, ParIterator & it, bool childonly = false);
63 /// update labels between "from" and "to" if possible.
65 A full updateLabels(Buffer const &) will be called if not possible.
67 void updateLabels(Buffer const & buf,
68 ParIterator & from, ParIterator & to, bool childonly = false);
70 /// updates all counters
71 void updateLabels(Buffer const &, bool childonly = false);
76 #endif // BUFFER_FUNCS_H