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 docstring screenLabel() const;
32 InsetCode lyxCode() const { return TOC_CODE; }
34 DisplayType display() const { return AlignCenter; }
36 int plaintext(odocstream &, OutputParams const &) const;
38 int docbook(odocstream &, OutputParams const &) const;
40 docstring xhtml(XHTMLStream & xs, OutputParams const &) const;
42 static ParamInfo const & findInfo(std::string const &);
44 static std::string defaultCommand() { return "tableofcontents"; }
46 static bool isCompatibleCommand(std::string const & cmd)
47 { return cmd == defaultCommand(); }
49 Inset * clone() const { return new InsetTOC(*this); }