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