4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
9 * Full author contact details are available in file CREDITS.
15 #include "InsetCommand.h"
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 {
28 InsetTOC(Buffer * buf, InsetCommandParams const &);
30 /// \name Public functions inherited from Inset class
33 InsetCode lyxCode() const { return TOC_CODE; }
35 DisplayType display() const { return AlignCenter; }
37 int plaintext(odocstream &, OutputParams const &) const;
39 int docbook(odocstream &, OutputParams const &) const;
41 docstring xhtml(XHTMLStream & xs, OutputParams const &) const;
44 /// \name Static public methods obligated for InsetCommand derived classes
47 static ParamInfo const & findInfo(std::string const &);
49 static std::string defaultCommand() { return "tableofcontents"; }
51 static bool isCompatibleCommand(std::string const & cmd)
52 { return cmd == defaultCommand(); }
56 /// \name Private functions inherited from Inset class
59 Inset * clone() const { return new InsetTOC(*this); }
62 /// \name Private functions inherited from InsetCommand class
65 docstring screenLabel() const;