src/frontends/controllers/ControlCitation.h

   1 // -*- C++ -*-
   2 /**
   3  * \file ControlCitation.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Angus Leeming
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef CONTROLCITATION_H
  13 #define CONTROLCITATION_H
  14
  15
  16 #include "ControlCommand.h"
  17 #include "biblio.h"
  18
  19 /** A controller for Citation dialogs.
  20  */
  21 class ControlCitation : public ControlCommand {
  22 public:
  23         ///
  24         ControlCitation(Dialog &);
  25
  26         ///
  27         virtual bool initialiseParams(std::string const & data);
  28         /// clean-up on hide.
  29         virtual void clearParams();
  30
  31         /** Disconnect from the inset when the Apply button is pressed.
  32          *  Allows easy insertion of multiple citations.
  33          */
  34         virtual bool disconnectOnApply() const { return true; }
  35
  36         /// Returns a reference to the map of stored keys
  37         biblio::InfoMap const & bibkeysInfo() const;
  38
  39         ///
  40         biblio::CiteEngine_enum getEngine() const;
  41
  42         /// Possible citations based on this key
  43         std::vector<std::string> const getCiteStrings(std::string const & key) const;
  44
  45         /// available CiteStyle-s (depends on availability of Natbib/Jurabib)
  46         static std::vector<biblio::CiteStyle> const & getCiteStyles() {
  47                 return citeStyles_;
  48         }
  49 private:
  50         /// The info associated with each key
  51         biblio::InfoMap bibkeysInfo_;
  52
  53         ///
  54         static std::vector<biblio::CiteStyle> citeStyles_;
  55 };
  56
  57
  58 #endif // CONTROLCITATION_H