remove unused CursorSlice::invalidate & isValid methods

[lyx.git] / src / TocBackend.h

diff --git a/src/TocBackend.h b/src/TocBackend.h
index 4a03493db888aa79a6731ff466d6c843178ccf25..25b39c953876ee331e67e987a97bf1d862c965fd 100644 (file)
--- a/src/TocBackend.h
+++ b/src/TocBackend.h
@@ -20,7 +20,7 @@
 #include <vector>
 #include <string>
 
-#include "pariterator.h"
+#include "ParIterator.h"
 
 #include "support/docstream.h"
 
@@ -28,63 +28,64 @@
 namespace lyx {
 
 class Buffer;
-class Paragraph;
 class FuncRequest;
-class LCursor;
 
 ///
 /**
 */
-class TocBackend
+class TocItem
 {
+       friend class TocBackend;
+
 public:
+       /// Default constructor for STL containers.
+       TocItem() {}
        ///
-       /**
-       */
-       class Item
-       {
-               friend class TocBackend;
-               friend bool operator==(Item const & a, Item const & b);
-
-       public:
-               ///
-               Item(
-                       ParConstIterator const & par_it = ParConstIterator(),
-                       int d = -1,
-                       docstring const & s = docstring());
-               ///
-               ~Item() {}
-               ///
-               bool const isValid() const;
-               ///
-               int const id() const;
-               ///
-               int const depth() const;
-               ///
-               docstring const & str() const;
-               ///
-               docstring const asString() const;
-
-               /// the action corresponding to the goTo above
-               FuncRequest action() const;
-               
-       protected:
-               /// Current position of item.
-               ParConstIterator par_it_;
-
-               /// nesting depth
-               int depth_;
-
-               /// Full item string
-               docstring str_;
-       };
-
+       TocItem(ParConstIterator const & par_it,
+               int depth,
+               docstring const & s
+               );
+       ///
+       ~TocItem() {}
        ///
-       typedef std::vector<Item> Toc;
-       typedef std::vector<Item>::const_iterator TocIterator;
+       int const id() const;
        ///
-       typedef std::map<std::string, Toc> TocList;
+       int const depth() const;
+       ///
+       docstring const & str() const;
+       ///
+       docstring const asString() const;
+
+       /// the action corresponding to the goTo above
+       FuncRequest action() const;
+
+protected:
+       /// Current position of item.
+       ParConstIterator par_it_;
+
+       /// nesting depth
+       int depth_;
+
+       /// Full item string
+       docstring str_;
+};
+
+
+///
+typedef std::vector<TocItem> Toc;
+typedef Toc::const_iterator TocIterator;
+/// The ToC list.
+/// A class and no typedef because we want to forward declare it.
+class TocList : public std::map<std::string, Toc>
+{
+};
 
+
+///
+/**
+*/
+class TocBackend
+{
 public:
        ///
        TocBackend(Buffer const * buffer = NULL): buffer_(buffer) {}
@@ -94,41 +95,41 @@ public:
        void setBuffer(Buffer const * buffer)
        { buffer_ = buffer; }
        ///
-       bool addType(std::string const & type);
-       ///
        void update();
+       ///
+       void updateItem(ParConstIterator const & pit);
+
        ///
        TocList const & tocs() const
        { return tocs_; }
-       ///
-       std::vector<std::string> const & types() const
-       { return types_; }
+
        ///
        Toc const & toc(std::string const & type) const;
        /// Return the first Toc Item before the cursor
-       TocIterator const item(std::string const & type, ParConstIterator const &) const;
+       TocIterator const item(
+               std::string const & type, ///< Type of Toc.
+               ParConstIterator const & ///< The cursor location in the document.
+               ) const;
 
-       void asciiTocList(std::string const & type, odocstream & os) const;
+       void writePlaintextTocList(std::string const & type, odocstream & os) const;
 
 private:
-       /// 
-       TocList tocs_;
        ///
-       std::vector<std::string> types_;
+       TocList tocs_;
        ///
        Buffer const * buffer_;
 
 }; // TocBackend
 
 inline
-bool operator==(TocBackend::Item const & a, TocBackend::Item const & b)
+bool operator==(TocItem const & a, TocItem const & b)
 {
        return a.id() == b.id() && a.str() == b.str() && a.depth() == b.depth();
 }
 
 
 inline
-bool operator!=(TocBackend::Item const & a, TocBackend::Item const & b)
+bool operator!=(TocItem const & a, TocItem const & b)
 {
        return !(a == b);
 }