]> git.lyx.org Git - lyx.git/blobdiff - src/TocBackend.h
Update my email and status.
[lyx.git] / src / TocBackend.h
index 0e3d4f1f7e6b1e9a9ec5f095b325c0ccbf992608..40d2dbafe1b06992af9a3b3404dc8abd7687574a 100644 (file)
@@ -38,11 +38,12 @@ class TocItem
 
 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() {}
@@ -53,7 +54,11 @@ 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;
@@ -67,6 +72,9 @@ protected:
 
        /// Full item string
        docstring str_;
+
+       /// The tooltip string
+       docstring tooltip_;
 };
 
 
@@ -75,7 +83,12 @@ 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;
@@ -97,8 +110,8 @@ public:
        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_; }