listerrors.lyx : Update a link.

[lyx.git] / src / insets / InsetTOC.h

diff --git a/src/insets/InsetTOC.h b/src/insets/InsetTOC.h
index 334a0a33e0e31438b2db7f49b26674516ff11eea..cb32c66ac3f18c85b1df6313a151c12f3cba773f 100644 (file)
--- 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.
  */
@@ -19,26 +19,53 @@ namespace lyx {
 
 
 /// Used to insert table of contents and similar lists
+/// at present, supports only \tableofcontents. 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 { return TOC_CODE; }
+       ///
+       DisplayType display() const { return AlignCenter; }
        ///
-       docstring const getScreenLabel(Buffer const &) const;
+       int plaintext(odocstream &, OutputParams const &) const;
        ///
-       EDITABLE editable() const { return IS_EDITABLE; }
+       int docbook(odocstream &, OutputParams const &) const;
        ///
-       InsetBase::Code lyxCode() const;
+       docstring xhtml(XHTMLStream & xs, OutputParams const &) const;
+       ///
+       void doDispatch(Cursor & cur, FuncRequest & cmd);
+       //@}
+
+       /// \name Static public methods obligated for InsetCommand derived classes
+       //@{
        ///
-       bool display() const { return true; }
+       static ParamInfo const & findInfo(std::string const &);
        ///
-       int plaintext(Buffer const &, odocstream &,
-                     OutputParams const &) const;
+       static std::string defaultCommand() { return "tableofcontents"; }
        ///
-       int docbook(Buffer const &, odocstream &,
-                   OutputParams const &) const;
+       static bool isCompatibleCommand(std::string const & cmd)
+               { return cmd == defaultCommand(); }
+       //@}
+
 private:
-       virtual std::auto_ptr<InsetBase> doClone() 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;
+       //@}
 };