Fairly trivial change here: Just protect against inheriting limits to

[lyx.git] / src / TocBackend.h

diff --git a/src/TocBackend.h b/src/TocBackend.h
index 7dc9ec8d499b5f68f50f8009740cac1542ec3635..40d2dbafe1b06992af9a3b3404dc8abd7687574a 100644 (file)
--- a/src/TocBackend.h
+++ b/src/TocBackend.h
@@ -14,7 +14,7 @@
 #ifndef TOC_BACKEND_H
 #define TOC_BACKEND_H
 
-#include "ParIterator.h"
+#include "DocIterator.h"
 
 #include "support/strfwd.h"
 
@@ -33,15 +33,17 @@ class FuncRequest;
 */
 class TocItem
 {
+       friend class Toc;
        friend class TocBackend;
 
 public:
        /// Default constructor for STL containers.
-       TocItem() {}
+       TocItem() : dit_(0) {}
        ///
-       TocItem(ParConstIterator const & par_it,
+       TocItem(DocIterator const & dit,
                int depth,
-               docstring const & s
+               docstring const & s,
+               docstring const & t = docstring()
                );
        ///
        ~TocItem() {}
@@ -52,25 +54,43 @@ public:
        ///
        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;
 
 protected:
        /// Current position of item.
-       ParConstIterator par_it_;
+       DocIterator dit_;
 
        /// nesting depth
        int depth_;
 
        /// Full item string
        docstring str_;
+
+       /// The tooltip string
+       docstring tooltip_;
 };
 
 
 ///
-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.
@@ -90,8 +110,8 @@ public:
        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_; }
@@ -104,7 +124,7 @@ public:
        /// 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;
 
        ///