X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetTOC.h;h=4d48c3220f5ce40acf031689966539ca7290e3c0;hb=b7ec3d8515b539260a16e9c5987c4116f4d1257c;hp=b020f0b9abd0fc098b0a85012376adde78ad0668;hpb=ed858d73e57ce7aa89e38c1bc4d799362edb0227;p=lyx.git diff --git a/src/insets/InsetTOC.h b/src/insets/InsetTOC.h index b020f0b9ab..4d48c3220f 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,31 +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 &); - /// - docstring const getScreenLabel(Buffer const &) const; + InsetTOC(Buffer * buf, InsetCommandParams const &); + + /// \name Public functions inherited from Inset class + //@{ /// - EDITABLE editable() const { return IS_EDITABLE; } + InsetCode lyxCode() const { return TOC_CODE; } /// - Inset::Code lyxCode() const; + docstring layoutName() const; /// DisplayType display() const { return AlignCenter; } /// - int plaintext(Buffer const &, odocstream &, - OutputParams const &) const; + virtual void validate(LaTeXFeatures &) const; + /// + int plaintext(odocstringstream & ods, OutputParams const & op, + size_t max_length = INT_MAX) const; + /// + int docbook(odocstream &, OutputParams const &) const; + /// + docstring xhtml(XHTMLStream & xs, OutputParams const &) const; + /// + void doDispatch(Cursor & cur, FuncRequest & cmd); + /// + bool clickable(BufferView const &, int, int) const { return true; } + //@} + + /// \name Static public methods obligated for InsetCommand derived classes + //@{ + /// + static ParamInfo const & findInfo(std::string const &); /// - int docbook(Buffer const &, odocstream &, - OutputParams const &) const; + static std::string defaultCommand() { return "tableofcontents"; } + /// + static bool isCompatibleCommand(std::string const & cmd); + //@} + private: - virtual Inset * clone() const; + /// + void makeTOCWithDepth(XHTMLStream & xs, Toc const & toc, const OutputParams & op) const; + /// + void makeTOCNoDepth(XHTMLStream & xs, Toc const & toc, const OutputParams & op) const; + /// + void makeTOCEntry(XHTMLStream & xs, Paragraph const & par, OutputParams const & op) const; + + /// \name Private functions inherited from Inset class + //@{ + /// + Inset * clone() const { return new InsetTOC(*this); } + //@} + + /// \name Private functions inherited from InsetCommand class + //@{ + /// + docstring screenLabel() const; + //@} };