* \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 "DocIterator.h"
+
+#include "support/strfwd.h"
+
#include <map>
#include <vector>
#include <string>
-#include "pariterator.h"
-
-#include "support/docstream.h"
-
namespace lyx {
*/
class TocItem
{
+ friend class Toc;
friend class TocBackend;
public:
+ /// Default constructor for STL containers.
+ TocItem() : dit_(0) {}
///
- TocItem(ParConstIterator const & par_it = ParConstIterator(),
- int d = -1,
- docstring const & s = docstring());
+ TocItem(DocIterator const & dit,
+ int depth,
+ docstring const & s,
+ docstring const & t = docstring()
+ );
///
~TocItem() {}
///
- bool const isValid() const;
- ///
- int const id() const;
+ int id() const;
///
- int const depth() const;
+ int depth() const;
///
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;
-
+
protected:
/// Current position of item.
- ParConstIterator par_it_;
+ DocIterator dit_;
/// nesting depth
int depth_;
/// Full item string
docstring str_;
+
+ /// The tooltip string
+ docstring tooltip_;
};
///
-typedef std::vector<TocItem> Toc;
+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;
+
/// 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> {};
///
{
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);
+ /// \return true if the item was updated.
+ bool updateItem(DocIterator 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.
+ DocIterator const & dit ///< 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);
}