Embedding: saving inzip name to .lyx file so that embedded files can always be found...

[lyx.git] / src / TocBackend.h

diff --git a/src/TocBackend.h b/src/TocBackend.h
index 38d638ffedeff6531403365175b4925ae0422f60..30ed9de75fd84e8ca93224c89d40e7b49d25ce86 100644 (file)
--- a/src/TocBackend.h
+++ b/src/TocBackend.h
@@ -22,7 +22,7 @@
 
 #include "ParIterator.h"
 
-#include "support/docstream.h"
+#include "support/strfwd.h"
 
 
 namespace lyx {
@@ -38,18 +38,19 @@ class TocItem
        friend class TocBackend;
 
 public:
+       /// Default constructor for STL containers.
+       TocItem() {}
        ///
-       TocItem(ParConstIterator const & par_it = ParConstIterator(),
-               int d = -1,
-               docstring const & s = docstring());
+       TocItem(ParConstIterator const & par_it,
+               int depth,
+               docstring const & s
+               );
        ///
        ~TocItem() {}
        ///
-       bool const isValid() const;
+       int id() const;
        ///
-       int const id() const;
-       ///
-       int const depth() const;
+       int depth() const;
        ///
        docstring const & str() const;
        ///
@@ -57,7 +58,7 @@ public:
 
        /// the action corresponding to the goTo above
        FuncRequest action() const;
-       
+
 protected:
        /// Current position of item.
        ParConstIterator par_it_;
@@ -73,11 +74,10 @@ protected:
 ///
 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 TocList : public std::map<std::string, Toc> {};
 
 
 ///
@@ -105,12 +105,15 @@ public:
        ///
        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 writePlaintextTocList(std::string const & type, odocstream & os) const;
 
 private:
-       /// 
+       ///
        TocList tocs_;
        ///
        Buffer const * buffer_;