X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetTOC.h;h=ca3f463c5ad610d8aa9c63ebde127296a034d561;hb=eb294eadb5e7f22880da399ae082f74567bbfc4e;hp=102ff1d403d9d05a8a8504c961ba5e34f9d2ff0c;hpb=db8c16d554ebb1dcb319e44d318572de6eff024b;p=lyx.git diff --git a/src/insets/InsetTOC.h b/src/insets/InsetTOC.h index 102ff1d403..ca3f463c5a 100644 --- a/src/insets/InsetTOC.h +++ b/src/insets/InsetTOC.h @@ -4,7 +4,7 @@ * This file is part of LyX, the document processor. * Licence details can be found in the file COPYING. * - * \author Lars Gullik Bjønnes + * \author Lars Gullik Bjønnes * * Full author contact details are available in file CREDITS. */ @@ -14,36 +14,74 @@ #include "InsetCommand.h" +#include "Toc.h" + namespace lyx { +class Paragraph; /// Used to insert table of contents and similar lists +/// at present, supports only \tableofcontents and \listoflistings. +/// Other such commands, such as \listoffigures, are supported +/// by InsetFloatList. class InsetTOC : public InsetCommand { public: /// - explicit InsetTOC(InsetCommandParams const &); + InsetTOC(Buffer * buf, InsetCommandParams const &); + + /// \name Public functions inherited from Inset class + //@{ + /// + InsetCode lyxCode() const override { return TOC_CODE; } + /// + docstring layoutName() const override; /// - docstring screenLabel() const; + int rowFlags() const override { return Display; } /// - EDITABLE editable() const { return IS_EDITABLE; } + void validate(LaTeXFeatures &) const override; /// - InsetCode lyxCode() const { return TOC_CODE; } + int plaintext(odocstringstream & ods, OutputParams const & op, + size_t max_length = INT_MAX) const override; /// - DisplayType display() const { return AlignCenter; } + void docbook(XMLStream &, OutputParams const &) const override; /// - int plaintext(odocstream &, OutputParams const &) const; + docstring xhtml(XMLStream & xs, OutputParams const &) const override; /// - int docbook(odocstream &, OutputParams const &) const; + void doDispatch(Cursor & cur, FuncRequest & cmd) override; + /// + bool clickable(BufferView const &, int, int) const override { return true; } + //@} + + /// \name Static public methods obligated for InsetCommand derived classes + //@{ /// static ParamInfo const & findInfo(std::string const &); /// - static std::string defaultCommand() { return "tableofcontents"; }; + static std::string defaultCommand() { return "tableofcontents"; } /// - static bool isCompatibleCommand(std::string const & cmd) - {return cmd == defaultCommand(); } + static bool isCompatibleCommand(std::string const & cmd); + //@} + private: - virtual Inset * clone() const; + /// + void makeTOCWithDepth(XMLStream & xs, Toc const & toc, const OutputParams & op) const; + /// + void makeTOCNoDepth(XMLStream & xs, Toc const & toc, const OutputParams & op) const; + /// + void makeTOCEntry(XMLStream & xs, Paragraph const & par, OutputParams const & op) const; + + /// \name Private functions inherited from Inset class + //@{ + /// + Inset * clone() const override { return new InsetTOC(*this); } + //@} + + /// \name Private functions inherited from InsetCommand class + //@{ + /// + docstring screenLabel() const override; + //@} };