Add Qt's Svg module to the list of used modules. This is required to allow the use...

[lyx.git] / src / TocBackend.h

diff --git a/src/TocBackend.h b/src/TocBackend.h
index 9704352922e8ef80bfe5261ab99de9e5144e9975..15a800d990347ad8ed6e71b51a9db01eb84c3e5a 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,18 @@ 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,
+               bool output_active,
+               docstring const & t = docstring()
                );
        ///
        ~TocItem() {}
@@ -52,25 +55,43 @@ public:
        ///
        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.
-       ParConstIterator par_it_;
-
+       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;
 
@@ -90,9 +111,9 @@ public:
        ///
        void setBuffer(Buffer const * buffer) { buffer_ = buffer; }
        ///
-       void update();
-       ///
-       void updateItem(ParConstIterator 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_; }
@@ -105,11 +126,12 @@ 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;
 
        ///
-       void writePlaintextTocList(std::string const & type, odocstream & os) const;
+       void writePlaintextTocList(std::string const & type,
+               odocstringstream & os, size_t max_length) const;
 
 private:
        ///