#ifndef TOC_H
#define TOC_H
-#include <map>
-#include <iosfwd>
-#include <vector>
-#include <string>
-
-class Buffer;
-class LyXView;
-class Paragraph;
-class FuncRequest;
+class LCursor;
namespace lyx {
namespace toc {
-///
-class TocItem {
-public:
- TocItem(int par_id, int d, std::string const & s)
- : id_(par_id), depth(d), str(s) {}
- ///
- std::string const asString() const;
- /// set cursor in LyXView to this TocItem
- void goTo(LyXView & lv_) const;
- /// the action corresponding to the goTo above
- FuncRequest action() const;
- /// Paragraph ID containing this item
- int id_;
- /// nesting depth
- int depth;
- ///
- std::string str;
+/// the type of outline operation
+enum OutlineOp {
+ Up, // Move this header with text down
+ Down, // Move this header with text up
+ In, // Make this header deeper
+ Out // Make this header shallower
};
-///
-typedef std::vector<TocItem> Toc;
-///
-typedef std::map<std::string, Toc> TocList;
-
-///
-TocList const getTocList(Buffer const &);
-
-///
-std::vector<std::string> const getTypes(Buffer const &);
-
-///
-void asciiTocList(std::string const &, Buffer const &, std::ostream &);
-
-/** Given the cmdName of the TOC param, returns the type used
- by ControlToc::getContents() */
-std::string const getType(std::string const & cmdName);
-
-inline
-bool operator==(TocItem const & a, TocItem const & b)
-{
- return a.id_ == b.id_ && a.str == b.str;
- // No need to compare depth.
-}
-
-inline
-bool operator!=(TocItem const & a, TocItem const & b)
-{
- return !(a == b);
-}
+void outline(OutlineOp, LCursor &);
} // namespace toc