public:
/// Default constructor for STL containers.
- TocItem() {}
+ TocItem() : dit_(0) {}
///
TocItem(DocIterator const & dit,
int depth,
- docstring const & s
+ docstring const & s,
+ docstring const & t = docstring()
);
///
~TocItem() {}
///
docstring const & str() const;
///
+ docstring const & tooltip() const;
+ ///
docstring const asString() const;
+ ///
+ DocIterator const & dit() const;
/// the action corresponding to the goTo above
FuncRequest action() const;
/// Full item string
docstring str_;
+
+ /// The tooltip string
+ docstring tooltip_;
};
///
-class Toc : public std::vector<TocItem> {
+class Toc : public std::vector<TocItem>
+{
public:
typedef std::vector<TocItem>::const_iterator const_iterator;
- const_iterator Toc::item(DocIterator const & dit) const;
+ 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;
void setBuffer(Buffer const * buffer) { buffer_ = buffer; }
///
void update();
- ///
- void updateItem(DocIterator const & pit);
+ /// \return true if the item was updated.
+ bool updateItem(DocIterator const & pit);
///
TocList const & tocs() const { return tocs_; }