Use const ref instead of passing by value.

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

diff --git a/src/insets/InsetTOC.h b/src/insets/InsetTOC.h
index b95c9c4ebbc377005a663ff3a2351399bf8db0e1..074ad535dbf6e8f4b6de193670af8d00f224eee7 100644 (file)
--- a/src/insets/InsetTOC.h
+++ b/src/insets/InsetTOC.h
@@ -17,31 +17,70 @@
 
 namespace lyx {
 
+class Paragraph;
+class Toc;
 
 /// 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 screenLabel() const;
+       InsetTOC(Buffer * buf, InsetCommandParams const &);
+
+       /// \name Public functions inherited from Inset class
+       //@{
        ///
        InsetCode lyxCode() const { return TOC_CODE; }
        ///
+       docstring layoutName() const;
+       ///
        DisplayType display() const { return AlignCenter; }
        ///
-       int plaintext(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(int, int) const { 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:
+       ///
+       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;
+       //@}
 };