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_CITATION_H
  14 #define INSET_CITATION_H
  15
  16 #include "InsetCommand.h"
  17
  18 #include "Citation.h"
  19
  20 namespace lyx {
  21
  22 /////////////////////////////////////////////////////////////////////////
  23 //
  24 // InsetCitation
  25 //
  26 /////////////////////////////////////////////////////////////////////////
  27
  28 /// Used to insert citations
  29 class InsetCitation : public InsetCommand
  30 {
  31 public:
  32         ///
  33         InsetCitation(Buffer * buf, InsetCommandParams const &);
  34
  35         /// \name Public functions inherited from Inset class
  36         //@{
  37         ///
  38         bool isLabeled() const { return true; }
  39         ///
  40         bool hasSettings() const { return true; }
  41         ///
  42         docstring toolTip(BufferView const & bv, int x, int y) const;
  43         ///
  44         void doDispatch(Cursor & cur, FuncRequest & cmd);
  45         ///
  46         InsetCode lyxCode() const { return CITE_CODE; }
  47         ///
  48         void latex(otexstream &, OutputParams const &) const;
  49         ///
  50         int plaintext(odocstream &, OutputParams const &) const;
  51         ///
  52         int docbook(odocstream &, OutputParams const &) const;
  53         ///
  54         docstring xhtml(XHTMLStream &, OutputParams const &) const;
  55         ///
  56         void toString(odocstream &) const;
  57         ///
  58         void forToc(docstring &, size_t) const;
  59         ///
  60         void validate(LaTeXFeatures &) const {}
  61         ///
  62         void updateBuffer(ParIterator const & it, UpdateType);
  63         ///
  64         void addToToc(DocIterator const &) const;
  65         ///
  66         std::string contextMenuName() const;
  67         //@}
  68
  69         /// \name Static public methods obligated for InsetCommand derived classes
  70         //@{
  71         ///
  72         static ParamInfo const & findInfo(std::string const &);
  73         ///
  74         static std::string defaultCommand() { return "cite"; }
  75         ///
  76         static bool isCompatibleCommand(std::string const & cmd);
  77         //@}
  78
  79 private:
  80         /// tries to make a pretty label and makes a basic one if not
  81         docstring generateLabel(bool for_xhtml = false) const;
  82         /// makes a pretty label
  83         docstring complexLabel(bool for_xhtml = false) const;
  84         /// makes a very basic label, in case we can't make a pretty one
  85         docstring basicLabel(bool for_xhtml = false) const;
  86
  87         /// \name Private functions inherited from Inset class
  88         //@{
  89         ///
  90         Inset * clone() const { return new InsetCitation(*this); }
  91         //@}
  92
  93         /// \name Private functions inherited from InsetCommand class
  94         //@{
  95         ///
  96         docstring screenLabel() const;
  97         //@}
  98
  99         /// we'll eventually want to be able to get info on this from the
 100         /// various CiteEngines
 101         static ParamInfo param_info_;
 102
 103         ///
 104         struct Cache {
 105                 Cache() : recalculate(true) {};
 106                 ///
 107                 bool recalculate;
 108                 ///
 109                 docstring generated_label;
 110                 ///
 111                 docstring screen_label;
 112         };
 113         ///
 114         mutable Cache cache;
 115 };
 116
 117
 118 } // namespace lyx
 119
 120 #endif // INSET_CITATION_H