Free line setting in tabulars. FILE FORMAT CHANGE.

[lyx.git] / src / TocBackend.h

diff --git a/src/TocBackend.h b/src/TocBackend.h
index 20c87294a67647ac727de58f37aae80144806a02..9704352922e8ef80bfe5261ab99de9e5144e9975 100644 (file)
--- a/src/TocBackend.h
+++ b/src/TocBackend.h
@@ -9,28 +9,24 @@
  * \author Abdelrazak Younes
  *
  * Full author contact details are available in file CREDITS.
- *
- * TocBackend mainly used in toc.[Ch]
  */
 
 #ifndef TOC_BACKEND_H
 #define TOC_BACKEND_H
 
+#include "ParIterator.h"
+
+#include "support/strfwd.h"
+
 #include <map>
 #include <vector>
 #include <string>
 
-#include "pariterator.h"
-
-#include "support/docstream.h"
-
 
 namespace lyx {
 
 class Buffer;
-class Paragraph;
 class FuncRequest;
-class LCursor;
 
 ///
 /**
@@ -40,18 +36,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;
        ///
@@ -59,7 +56,7 @@ public:
 
        /// the action corresponding to the goTo above
        FuncRequest action() const;
-       
+
 protected:
        /// Current position of item.
        ParConstIterator par_it_;
@@ -73,13 +70,13 @@ protected:
 
 
 ///
-typedef std::vector<TocItem> Toc;
+class Toc : public std::vector<TocItem> {};
+
 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> {};
 
 
 ///
@@ -89,48 +86,45 @@ class TocBackend
 {
 public:
        ///
-       TocBackend(Buffer const * buffer = NULL): buffer_(buffer) {}
-       ///
-       ~TocBackend() {}
-       ///
-       void setBuffer(Buffer const * buffer)
-       { buffer_ = buffer; }
+       TocBackend(Buffer const * buffer) : buffer_(buffer) {}
        ///
-       bool addType(std::string const & type);
+       void setBuffer(Buffer const * buffer) { buffer_ = buffer; }
        ///
        void update();
        ///
-       TocList const & tocs() const
-       { return tocs_; }
+       void updateItem(ParConstIterator const & pit);
+
        ///
-       std::vector<std::string> const & types() const
-       { return types_; }
+       TocList const & tocs() const { return tocs_; }
+       TocList & tocs() { return tocs_; }
+
        ///
        Toc const & toc(std::string const & type) const;
+       Toc & toc(std::string const & type);
+
        /// Return the first Toc Item before the cursor
-       TocIterator const item(std::string const & type, ParConstIterator const &) const;
+       TocIterator 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_;
        ///
-       std::vector<std::string> types_;
+       TocList tocs_;
        ///
        Buffer const * buffer_;
-
 }; // TocBackend
 
-inline
-bool operator==(TocItem const & a, TocItem const & b)
+inline bool operator==(TocItem const & a, TocItem const & b)
 {
        return a.id() == b.id() && a.str() == b.str() && a.depth() == b.depth();
 }
 
 
-inline
-bool operator!=(TocItem const & a, TocItem const & b)
+inline bool operator!=(TocItem const & a, TocItem const & b)
 {
        return !(a == b);
 }