Update my email and status.

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

diff --git a/src/insets/InsetCitation.h b/src/insets/InsetCitation.h
index aff08945602cc1efe9c1b23036afc64eddedb237..0cdde7b2ee7ece7666fcaa85ffcece71dc95a36c 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,67 +30,81 @@ class InsetCitation : public InsetCommand
 {
 public:
        ///
-       explicit InsetCitation(Buffer * buf, 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;
        ///
+       void doDispatch(Cursor & cur, FuncRequest & cmd);
+       ///
        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;
        ///
        docstring xhtml(XHTMLStream &, OutputParams const &) const;
-       /// the string that is passed to the TOC
-       void tocString(odocstream &) const;
        ///
-       void validate(LaTeXFeatures &) const;
+       void toString(odocstream &) const;
+       ///
+       void forToc(docstring &, size_t) const;
        ///
-       void updateLabels(ParIterator const & it, bool);
+       void validate(LaTeXFeatures &) const {}
        ///
-       void addToToc(DocIterator const &);
+       void updateBuffer(ParIterator const & it, UpdateType);
+       ///
+       void addToToc(DocIterator const &) const;
+       ///
+       std::string 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.
-       // It really ought to do what default_cite_command() does,
-       // but to do that it needs to know what CiteEngine we are
-       // using.
+       ///
        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:
-       ///
-       Inset * clone() const { return new InsetCitation(*this); }
        /// 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;
-       /// we'll eventually want to be able to get info on this from the 
+
+       /// \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_;
 
        ///
-       class Cache {
-       public:
-               ///
-               Cache() : engine(ENGINE_BASIC), params(CITE_CODE) {}
+       struct Cache {
+               Cache() : recalculate(true) {};
                ///
-               CiteEngine engine;
-               ///
-               InsetCommandParams params;
+               bool recalculate;
                ///
                docstring generated_label;
                ///
@@ -102,6 +114,7 @@ private:
        mutable Cache cache;
 };
 
+
 } // namespace lyx
 
 #endif // INSET_CITATION_H