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 #include "InsetCommand.h"
  16
  17
  18 namespace lyx {
  19
  20
  21 /// Used to insert table of contents and similar lists
  22 /// at present, supports only \tableofcontents. Other
  23 /// such commands, such as \listoffigures, are supported
  24 /// by InsetFloatList.
  25 class InsetTOC : public InsetCommand {
  26 public:
  27         ///
  28         InsetTOC(Buffer * buf, InsetCommandParams const &);
  29         ///
  30         docstring screenLabel() const;
  31         ///
  32         InsetCode lyxCode() const { return TOC_CODE; }
  33         ///
  34         DisplayType display() const { return AlignCenter; }
  35         ///
  36         int plaintext(odocstream &, OutputParams const &) const;
  37         ///
  38         int docbook(odocstream &, OutputParams const &) const;
  39         ///
  40         docstring xhtml(XHTMLStream & xs, OutputParams const &) const;
  41         ///
  42         static ParamInfo const & findInfo(std::string const &);
  43         ///
  44         static std::string defaultCommand() { return "tableofcontents"; }
  45         ///
  46         static bool isCompatibleCommand(std::string const & cmd)
  47                 { return cmd == defaultCommand(); }
  48 private:
  49         Inset * clone() const { return new InsetTOC(*this); }
  50 };
  51
  52
  53 } // namespace lyx
  54
  55 #endif