src/insets/InsetCitation.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetCitation.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  * \author Herbert Voß
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef INSET_CITE_H
  14 #define INSET_CITE_H
  15
  16
  17 #include "InsetCommand.h"
  18 #include "InsetCode.h"
  19
  20 #include "BiblioInfo.h"
  21
  22
  23 namespace lyx {
  24
  25
  26 /** Used to insert citations
  27  */
  28 class InsetCitation : public InsetCommand {
  29 public:
  30         ///
  31         InsetCitation(InsetCommandParams const &);
  32         ///
  33         bool isLabeled() const { return true; }
  34         ///
  35         docstring screenLabel() const;
  36         ///
  37         EDITABLE editable() const { return IS_EDITABLE; }
  38         ///
  39         InsetCode lyxCode() const { return CITE_CODE; }
  40         ///
  41         int latex(odocstream &, OutputParams const &) const;
  42         ///
  43         int plaintext(odocstream &, OutputParams const &) const;
  44         ///
  45         int docbook(odocstream &, OutputParams const &) const;
  46         /// the string that is passed to the TOC
  47         void textString(odocstream &) const;
  48         ///
  49         void validate(LaTeXFeatures &) const;
  50         ///
  51         void updateLabels(ParIterator const & it);
  52         ///
  53         void addToToc(ParConstIterator const &) const;
  54
  55         ///
  56         static ParamInfo const & findInfo(std::string const &);
  57         //FIXME This is the locus of the design problem we have.
  58         //It really ought to do what default_cite_command() does,
  59         //but to do that it needs to know what CiteEngine we are
  60         //using.
  61         ///
  62         static std::string defaultCommand() { return "cite"; };
  63         ///
  64         static bool isCompatibleCommand(std::string const & cmd);
  65 private:
  66         ///
  67         Inset * clone() const { return new InsetCitation(*this); }
  68         /// we'll eventually want to be able to get info on this from the
  69         /// various CiteEngines
  70         static ParamInfo param_info_;
  71         /// This function does the donkey work of creating the pretty label
  72         docstring generateLabel() const;
  73
  74         ///
  75         class Cache {
  76         public:
  77                 ///
  78                 Cache() : engine(biblio::ENGINE_BASIC), params(CITE_CODE) {}
  79                 ///
  80                 biblio::CiteEngine engine;
  81                 ///
  82                 InsetCommandParams params;
  83                 ///
  84                 docstring generated_label;
  85                 ///
  86                 docstring screen_label;
  87         };
  88         ///
  89         mutable Cache cache;
  90 };
  91
  92
  93 } // namespace lyx
  94
  95 #endif // INSET_CITE_H