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