]> git.lyx.org Git - lyx.git/blobdiff - src/toc.h
Fixed some lines that were too long. It compiled afterwards.
[lyx.git] / src / toc.h
index 7ee44a0a88274b0b2410504b8479ee70451c630f..19e3469ce44d725d18e9bf1c70927fe59074cd2a 100644 (file)
--- a/src/toc.h
+++ b/src/toc.h
@@ -1,87 +1,35 @@
 // -*- C++ -*-
-/* This file is part of
- * ======================================================
- *
- *           LyX, The Document Processor
+/**
+ * \file toc.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- *           Copyright 2002 The LyX Team.
+ * \author Jean-Marc Lasgouttes
+ * \author Angus Leeming
  *
- * ======================================================
+ * Full author contact details are available in file CREDITS.
  *
- * \file toc.h
- * \author Angus Leeming <a.leeming@ic.ac.uk>
- * \author Jean-Marc Lasgouttes <lasgouttes@freesurf.fr>
+ * Nice functions and objects to handle TOCs
  */
 
 #ifndef TOC_H
 #define TOC_H
 
-#include <config.h>
-
-#include "support/LOstream.h"
-#include "LString.h"
+class Cursor;
 
-#include <map>
-#include <vector>
-
-class Buffer;
-class LyXView;
-class Paragraph;
-
-/** Nice functions and objects to handle TOCs
- */
 namespace lyx {
 namespace toc {
 
-///
-struct TocItem {
-       TocItem(int par_id, int d, string const & s)
-               : id_(par_id), depth(d), str(s) {}
-       ///
-       string const asString() const;
-       /// set cursor in LyXView to this TocItem
-       void goTo(LyXView & lv_) const;
-       /// the action corresponding to the goTo above
-       int action() const;
-       /// Paragraph ID containing this item
-       int id_;
-       /// nesting depth
-       int depth;
-       ///
-       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<string, Toc> TocList;
-
-///
-TocList const getTocList(Buffer const *);
-
-///
-std::vector<string> const getTypes(Buffer const *);
-
-///
-void asciiTocList(string const &, Buffer const *, std::ostream &);
-
-/** Given the cmdName of the TOC param, returns the type used
-    by ControlToc::getContents() */
-string const getType(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, Cursor &);
 
 
 } // namespace toc