X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FTocBackend.h;h=9704352922e8ef80bfe5261ab99de9e5144e9975;hb=e01e14872d60935908ad42bc164bff1342277b22;hp=ba8f9f8f385a4298763400acc57b45fd5a4baa5f;hpb=61dde5d7976b37b22c5ceac63fc168c3afedfabf;p=lyx.git

diff --git a/src/TocBackend.h b/src/TocBackend.h
index ba8f9f8f38..9704352922 100644
--- 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 const id() const;
+	int 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,45 +86,45 @@ class TocBackend
 {
 public:
 	///
-	TocBackend(Buffer const * buffer = NULL): buffer_(buffer) {}
-	///
-	~TocBackend() {}
+	TocBackend(Buffer const * buffer) : buffer_(buffer) {}
 	///
-	void setBuffer(Buffer const * buffer)
-	{ buffer_ = buffer; }
+	void setBuffer(Buffer const * buffer) { buffer_ = buffer; }
 	///
 	void update();
 	///
 	void updateItem(ParConstIterator const & pit);
 
 	///
-	TocList const & tocs() const
-	{ return tocs_; }
+	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_;
 	///
 	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);
 }