X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Ftoc.h;h=19e3469ce44d725d18e9bf1c70927fe59074cd2a;hb=2417d9d911dbca181c48f45d1aad26d31c9aa815;hp=5af9e4959f894d29127ec602fca56c60948f4b08;hpb=16668d1632536894964c8ca624b3c90207ebe772;p=lyx.git diff --git a/src/toc.h b/src/toc.h index 5af9e4959f..19e3469ce4 100644 --- a/src/toc.h +++ b/src/toc.h @@ -1,96 +1,38 @@ // -*- 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 - * \author Jean-Marc Lasgouttes + * Nice functions and objects to handle TOCs */ #ifndef TOC_H #define TOC_H -#ifdef __GNUG__ -#pragma interface -#endif - -#include - -#include "support/LOstream.h" -#include "LString.h" - -#include -#include - -class Buffer; -class LyXView; -class Paragraph; +class Cursor; -/** Nice functions and objects to handle TOCs - */ -namespace toc -{ +namespace lyx { +namespace toc { -/// -struct TocItem { - TocItem(Paragraph * p, int d, string const & s) - : par(p), 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 * par; - /// - 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 Toc; -/// -typedef std::map TocList; - -/// -TocList const getTocList(Buffer const *); - -/// -std::vector 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.par == b.par && a.str == b.str; - // No need to compare depth. -} - -/// -inline -bool operator!=(TocItem const & a, TocItem const & b) -{ - return !(a == b); - // No need to compare depth. -} +void outline(OutlineOp, Cursor &); } // namespace toc +} // namespace lyx #endif // CONTROLTOC_H