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 class InsetTOC : public InsetCommand {
  23 public:
  24         ///
  25         explicit InsetTOC(InsetCommandParams const &);
  26         ///
  27         docstring screenLabel() const;
  28         ///
  29         EDITABLE editable() const { return NOT_EDITABLE; }
  30         ///
  31         InsetCode lyxCode() const { return TOC_CODE; }
  32         ///
  33         DisplayType display() const { return AlignCenter; }
  34         ///
  35         int plaintext(odocstream &, OutputParams const &) const;
  36         ///
  37         int docbook(odocstream &, OutputParams const &) const;
  38         ///
  39         static ParamInfo const & findInfo(std::string const &);
  40         ///
  41         static std::string defaultCommand() { return "tableofcontents"; };
  42         ///
  43         static bool isCompatibleCommand(std::string const & cmd)
  44                 { return cmd == defaultCommand(); }
  45 private:
  46         Inset * clone() const { return new InsetTOC(*this); }
  47 };
  48
  49
  50 } // namespace lyx
  51
  52 #endif