- ///
- TocBackend(Buffer const * buffer = NULL): buffer_(buffer) {}
- ///
- ~TocBackend() {}
- ///
- void setBuffer(Buffer const * buffer)
- { buffer_ = buffer; }
- ///
- void update();
- ///
- void updateItem(ParConstIterator const & pit);
-
- ///
- TocList const & tocs() const
- { return tocs_; }
-
- ///
- Toc const & toc(std::string const & type) const;
- /// Return the first Toc Item before the cursor
- TocIterator const item(
- std::string const & type, ///< Type of Toc.
- ParConstIterator const & ///< The cursor location in the document.
- ) const;
-
- void writePlaintextTocList(std::string const & type, odocstream & os) const;
+ static Toc::const_iterator findItem(Toc const & toc,
+ DocIterator const & dit);
+ /// Look for a TocItem given its depth and string.
+ /// \return The first matching item.
+ /// \retval end() if no item was found.
+ static Toc::iterator findItem(Toc & toc, int depth, docstring const & str);
+ ///
+ TocBackend(Buffer const * buffer) : buffer_(buffer) {}
+ ///
+ void setBuffer(Buffer const * buffer) { buffer_ = buffer; }
+ ///
+ void update(bool output_active, UpdateType utype);
+ /// \return true if the item was updated.
+ bool updateItem(DocIterator const & pit);
+ ///
+ TocList const & tocs() const { return tocs_; }
+ /// never null
+ std::shared_ptr<Toc const> toc(std::string const & type) const;
+ /// never null
+ std::shared_ptr<Toc> toc(std::string const & type);
+ /// \return the current TocBuilder for the Toc of type \param type, or
+ /// creates one if it does not already exist.
+ TocBuilder & builder(std::string const & type);
+ /// \return the first Toc Item before the cursor.
+ /// \param type: Type of Toc.
+ /// \param dit: The cursor location in the document.
+ Toc::const_iterator
+ item(std::string const & type, DocIterator const & dit) const;
+
+ ///
+ void writePlaintextTocList(std::string const & type,
+ odocstringstream & os, size_t max_length) const;
+ /// Localised name for type
+ docstring outlinerName(std::string const & type) const;
+ /// Add a new (localised) name if yet unknown
+ void addName(std::string const & type, docstring const & name);
+ /// Whether a toc type is less important and appears in the "Other lists"
+ /// submenu
+ static bool isOther(std::string const & type);