4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Jean-Marc Lasgouttes
8 * \author Angus Leeming
9 * \author Abdelrazak Younes
11 * Full author contact details are available in file CREDITS.
17 #include "DocIterator.h"
19 #include "support/strfwd.h"
37 friend class TocBackend;
40 /// Default constructor for STL containers.
41 TocItem() : dit_(0) {}
43 TocItem(DocIterator const & dit,
46 docstring const & t = docstring()
55 docstring const & str() const;
57 docstring const & tooltip() const;
59 docstring const asString() const;
61 DocIterator const & dit() const;
63 /// the action corresponding to the goTo above
64 FuncRequest action() const;
67 /// Current position of item.
76 /// The tooltip string
82 class Toc : public std::vector<TocItem>
85 typedef std::vector<TocItem>::const_iterator const_iterator;
86 typedef std::vector<TocItem>::iterator iterator;
87 const_iterator item(DocIterator const & dit) const;
88 /// Look for a TocItem given its depth and string.
89 /// \return The first matching item.
90 /// \retval end() if no item was found.
91 iterator item(int depth, docstring const & str);
94 typedef Toc::const_iterator TocIterator;
97 /// A class and no typedef because we want to forward declare it.
98 class TocList : public std::map<std::string, Toc> {};
108 TocBackend(Buffer const * buffer) : buffer_(buffer) {}
110 void setBuffer(Buffer const * buffer) { buffer_ = buffer; }
113 /// \return true if the item was updated.
114 bool updateItem(DocIterator const & pit);
117 TocList const & tocs() const { return tocs_; }
118 TocList & tocs() { return tocs_; }
121 Toc const & toc(std::string const & type) const;
122 Toc & toc(std::string const & type);
124 /// Return the first Toc Item before the cursor
126 std::string const & type, ///< Type of Toc.
127 DocIterator const & dit ///< The cursor location in the document.
131 void writePlaintextTocList(std::string const & type, odocstream & os) const;
137 Buffer const * buffer_;
140 inline bool operator==(TocItem const & a, TocItem const & b)
142 return a.id() == b.id() && a.str() == b.str() && a.depth() == b.depth();
146 inline bool operator!=(TocItem const & a, TocItem const & b)
154 #endif // TOC_BACKEND_H