Better TOC output for XHTML, per Rob and Pavel.

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

diff --git a/src/insets/InsetCitation.h b/src/insets/InsetCitation.h
index 4567077a423d5e5693d1a2c4f1eb10aa7c277534..49104924cd2d00f0cc31a8e56640ee2b322f0680 100644 (file)
--- a/src/insets/InsetCitation.h
+++ b/src/insets/InsetCitation.h
@@ -14,10 +14,8 @@
 #define INSET_CITATION_H
 
 #include "InsetCommand.h"
-#include "InsetCode.h"
-
-#include "BiblioInfo.h"
 
+#include "Citation.h"
 
 namespace lyx {
 
@@ -32,32 +30,42 @@ class InsetCitation : public InsetCommand
 {
 public:
        ///
-       explicit InsetCitation(InsetCommandParams const &);
+       InsetCitation(Buffer * buf, InsetCommandParams const &);
+
+       /// \name Public functions inherited from Inset class
+       //@{
        ///
        bool isLabeled() const { return true; }
        ///
-       docstring screenLabel() const;
-       ///
        bool hasSettings() const { return true; }
        ///
        docstring toolTip(BufferView const & bv, int x, int y) const;
        ///
        InsetCode lyxCode() const { return CITE_CODE; }
        ///
-       int latex(odocstream &, OutputParams const &) const;
+       void latex(otexstream &, OutputParams const &) const;
        ///
        int plaintext(odocstream &, OutputParams const &) const;
        ///
        int docbook(odocstream &, OutputParams const &) const;
-       /// the string that is passed to the TOC
-       void tocString(odocstream &) const;
+       ///
+       docstring xhtml(XHTMLStream &, OutputParams const &) const;
+       ///
+       void toString(odocstream &) const;
+       ///
+       void forToc(docstring &, size_t) const;
        ///
        void validate(LaTeXFeatures &) const;
        ///
-       void updateLabels(ParIterator const & it);
+       void updateBuffer(ParIterator const & it, UpdateType);
+       ///
+       void addToToc(DocIterator const &) const;
        ///
-       void addToToc(DocIterator const &);
+       docstring contextMenuName() const;
+       //@}
 
+       /// \name Static public methods obligated for InsetCommand derived classes
+       //@{
        ///
        static ParamInfo const & findInfo(std::string const &);
        // FIXME This is the locus of the design problem we have.
@@ -67,16 +75,31 @@ public:
        static std::string defaultCommand() { return "cite"; }
        ///
        static bool isCompatibleCommand(std::string const & cmd);
-       ///
-       virtual docstring contextMenu(BufferView const & bv, int x, int y) const;
+       //@}
+
 private:
+       /// tries to make a pretty label and makes a basic one if not
+       docstring generateLabel(bool for_xhtml = false) const;
+       /// makes a pretty label
+       docstring complexLabel(bool for_xhtml = false) const;
+       /// makes a very basic label, in case we can't make a pretty one
+       docstring basicLabel(bool for_xhtml = false) const;
+
+       /// \name Private functions inherited from Inset class
+       //@{
        ///
        Inset * clone() const { return new InsetCitation(*this); }
+       //@}
+
+       /// \name Private functions inherited from InsetCommand class
+       //@{
+       ///
+       docstring screenLabel() const;
+       //@}
+
        /// we'll eventually want to be able to get info on this from the 
        /// various CiteEngines
        static ParamInfo param_info_;
-       /// This function does the donkey work of creating the pretty label
-       docstring generateLabel() const;
 
        ///
        class Cache {
@@ -96,6 +119,7 @@ private:
        mutable Cache cache;
 };
 
+
 } // namespace lyx
 
 #endif // INSET_CITATION_H