#ifndef TOC_BACKEND_H
#define TOC_BACKEND_H
-#include "ParIterator.h"
+#include "DocIterator.h"
#include "support/strfwd.h"
*/
class TocItem
{
+ friend class Toc;
friend class TocBackend;
public:
/// Default constructor for STL containers.
TocItem() {}
///
- TocItem(ParConstIterator const & par_it,
+ TocItem(DocIterator const & dit,
int depth,
docstring const & s
);
protected:
/// Current position of item.
- ParConstIterator par_it_;
+ DocIterator dit_;
/// nesting depth
int depth_;
///
-typedef std::vector<TocItem> Toc;
+class Toc : public std::vector<TocItem>
+{
+public:
+ typedef std::vector<TocItem>::const_iterator const_iterator;
+ typedef std::vector<TocItem>::iterator iterator;
+ const_iterator item(DocIterator const & dit) const;
+ /// Look for a TocItem given its depth and string.
+ /// \return The first matching item.
+ /// \retval end() if no item was found.
+ iterator item(int depth, docstring const & str);
+};
+
typedef Toc::const_iterator TocIterator;
/// The ToC list.
{
public:
///
- TocBackend(Buffer const * buffer = NULL) : buffer_(buffer) {}
+ TocBackend(Buffer const * buffer) : buffer_(buffer) {}
///
void setBuffer(Buffer const * buffer) { buffer_ = buffer; }
///
void update();
- ///
- void updateItem(ParConstIterator const & pit);
+ /// \return true if the item was updated.
+ bool updateItem(DocIterator const & pit);
///
TocList const & tocs() const { return tocs_; }
/// Return the first Toc Item before the cursor
TocIterator item(
std::string const & type, ///< Type of Toc.
- ParConstIterator const & ///< The cursor location in the document.
+ DocIterator const & dit ///< The cursor location in the document.
) const;
///