src/insets/insettoc.h

   1 // -*- C++ -*-
   2 /**
   3  * \file insettoc.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef INSET_TOC_H
  13 #define INSET_TOC_H
  14
  15
  16 #include "insetcommand.h"
  17
  18 class MetricsInfo;
  19
  20
  21 /** Used to insert table of contents
  22  */
  23 class InsetTOC : public InsetCommand {
  24 public:
  25         ///
  26         explicit InsetTOC(InsetCommandParams const &);
  27         ///
  28         ~InsetTOC();
  29         ///
  30         std::auto_ptr<InsetBase> clone() const;
  31         ///
  32         void metrics(MetricsInfo &, Dimension &) const;
  33         ///
  34         void draw(PainterInfo & pi, int x, int y) const;
  35         ///
  36         std::string const getScreenLabel(Buffer const &) const;
  37         ///
  38         EDITABLE editable() const { return IS_EDITABLE; }
  39         ///
  40         InsetOld::Code lyxCode() const;
  41         ///
  42         bool display() const { return true; }
  43         ///
  44         int plaintext(Buffer const &, std::ostream &,
  45                   OutputParams const &) const;
  46         ///
  47         int linuxdoc(Buffer const &, std::ostream &,
  48                      OutputParams const &) const;
  49         ///
  50         int docbook(Buffer const &, std::ostream &,
  51                     OutputParams const &) const;
  52 protected:
  53         ///
  54         virtual
  55         DispatchResult
  56         priv_dispatch(FuncRequest const & cmd, idx_type &, pos_type &);
  57 };
  58
  59 #endif