*/
class TocItem
{
+ friend class Toc;
friend class TocBackend;
public:
/// Default constructor for STL containers.
- TocItem() {}
+ TocItem() : dit_(0) {}
///
TocItem(DocIterator const & dit,
int depth,
- docstring const & s
+ docstring const & s,
+ bool output_active,
+ docstring const & t = docstring()
);
///
~TocItem() {}
///
docstring const & str() const;
///
+ docstring const & tooltip() const;
+ ///
docstring const asString() const;
+ ///
+ DocIterator const & dit() const;
+ ///
+ bool isOutput() const { return output_; }
/// the action corresponding to the goTo above
FuncRequest action() const;
protected:
/// Current position of item.
DocIterator dit_;
-
/// nesting depth
int depth_;
-
/// Full item string
docstring str_;
+ /// The tooltip string
+ docstring tooltip_;
+ /// Is this item in a note, inactive branch, etc?
+ bool output_;
};
///
-class Toc : public std::vector<TocItem> {};
+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;
///
void setBuffer(Buffer const * buffer) { buffer_ = buffer; }
///
- void update();
- ///
- void updateItem(DocIterator const & pit);
+ void update(bool output_active);
+ /// \return true if the item was updated.
+ bool updateItem(DocIterator const & pit);
///
TocList const & tocs() const { return tocs_; }
) const;
///
- void writePlaintextTocList(std::string const & type, odocstream & os) const;
+ void writePlaintextTocList(std::string const & type,
+ odocstringstream & os, size_t max_length) const;
private:
///