doxygen fixes

[lyx.git] / src / frontends / xforms / FormCitation.h

diff --git a/src/frontends/xforms/FormCitation.h b/src/frontends/xforms/FormCitation.h
index 48e176eca00a632b9521feffb05edf4d6b5fa7d7..1797c13e05a3956eb55c92e72a478e83c1602427 100644 (file)
--- a/src/frontends/xforms/FormCitation.h
+++ b/src/frontends/xforms/FormCitation.h
@@ -1,12 +1,10 @@
 // -*- C++ -*-
-/* This file is part of
- * ====================================================== 
+/**
+ * \file xforms/FormCitation.h
+ * Copyright 2000-2002 the LyX Team
+ * Read the file COPYING
  *
- *           LyX, The Document Processor
- *
- *           Copyright 2000 The LyX Team.
- *
- * ======================================================
+ * \author Angus Leeming, a.leeming@ic.ac.uk
  */
 
 #ifndef FORMCITATION_H
@@ -16,39 +14,44 @@
 #pragma interface
 #endif
 
-#include "FormInset.h"
-struct FD_form_citation;
+#include "FormBase.h"
+#include "biblio.h"
 
-/** This class provides an XForms implementation of the FormCitation Dialog.
+/** This class provides an XForms implementation of the Citation Dialog.
  */
-class FormCitation : public FormCommand {
+class ControlCitation;
+struct FD_form_citation;
+
+class FormCitation : public FormCB<ControlCitation, FormDB<FD_form_citation> > {
 public:
        ///
-       FormCitation(LyXView *, Dialogs *);
-       ///
-       ~FormCitation();
+       FormCitation(ControlCitation &);
+
 private:
        ///
        enum State {
+               ///
                ON,
                ///
                OFF
        };
-       /// Connect signals etc. Set form's max size.
-       virtual void connect();
-       /// Disconnect signals. Also perform any necessary housekeeping.
-       virtual void disconnect();
 
-       /// Build the dialog
+       /// Set the Params variable for the Controller.
+       virtual void apply();
+       /// Build the dialog.
        virtual void build();
-       /// Filter the inputs
-       virtual bool input(FL_OBJECT *, long);
-       /// Update dialog before showing it
+       /// Hide the dialog.
+       virtual void hide();
+       /// Update dialog before/whilst showing it.
        virtual void update();
-       /// Apply from dialog (modify or create inset)
-       virtual void apply();
-       /// Pointer to the actual instantiation of the xforms form
-       virtual FL_FORM * form() const;
+       /// Filter the inputs on callback from xforms
+       virtual ButtonPolicy::SMInput input(FL_OBJECT *, long);
+
+       /// Fdesign generated method
+       FD_form_citation * build_citation();
+
+       /// search for a citation
+       void findBiblio(biblio::Direction const dir);
 
        ///
        void updateBrowser(FL_OBJECT *, std::vector<string> const &) const;
@@ -56,19 +59,11 @@ private:
        void setBibButtons(State) const;
        ///
        void setCiteButtons(State) const;
-       ///
-       void setSize(int, bool) const;
-       /// Type definition from the fdesign produced header file.
-       FD_form_citation * build_citation();
 
-       /// Real GUI implementation.
-       FD_form_citation * dialog_;
        ///
        std::vector<string> citekeys;
        ///
        std::vector<string> bibkeys;
-       ///
-       std::vector<string> bibkeysInfo;
 };
 
-#endif
+#endif // FORMCITATION_H