3 * \file InsetCitation.h
4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Angus Leeming
10 * Full author contact details are available in file CREDITS.
13 #ifndef INSET_CITATION_H
14 #define INSET_CITATION_H
16 #include "InsetCommand.h"
22 /////////////////////////////////////////////////////////////////////////
26 /////////////////////////////////////////////////////////////////////////
28 /// Used to insert citations
29 class InsetCitation : public InsetCommand
33 InsetCitation(Buffer * buf, InsetCommandParams const &);
35 /// \name Public functions inherited from Inset class
38 bool isLabeled() const { return true; }
40 bool hasSettings() const { return true; }
42 docstring toolTip(BufferView const & bv, int x, int y) const;
44 InsetCode lyxCode() const { return CITE_CODE; }
46 int latex(odocstream &, OutputParams const &) const;
48 int plaintext(odocstream &, OutputParams const &) const;
50 int docbook(odocstream &, OutputParams const &) const;
52 docstring xhtml(XHTMLStream &, OutputParams const &) const;
54 void tocString(odocstream &) const;
56 void validate(LaTeXFeatures &) const;
58 void updateBuffer(ParIterator const & it, UpdateType);
60 void addToToc(DocIterator const &);
62 docstring contextMenu(BufferView const & bv, int x, int y) const;
65 /// \name Static public methods obligated for InsetCommand derived classes
68 static ParamInfo const & findInfo(std::string const &);
69 // FIXME This is the locus of the design problem we have.
70 // It really ought to do what default_cite_command() does,
71 // but to do that it needs to know what CiteEngine we are
73 static std::string defaultCommand() { return "cite"; }
75 static bool isCompatibleCommand(std::string const & cmd);
79 /// tries to make a pretty label and makes a basic one if not
80 docstring generateLabel(bool for_xhtml = false) const;
81 /// makes a pretty label
82 docstring complexLabel(bool for_xhtml = false) const;
83 /// makes a very basic label, in case we can't make a pretty one
84 docstring basicLabel(bool for_xhtml = false) const;
86 /// \name Private functions inherited from Inset class
89 Inset * clone() const { return new InsetCitation(*this); }
92 /// \name Private functions inherited from InsetCommand class
95 docstring screenLabel() const;
98 /// we'll eventually want to be able to get info on this from the
99 /// various CiteEngines
100 static ParamInfo param_info_;
106 Cache() : engine(ENGINE_BASIC), params(CITE_CODE) {}
110 InsetCommandParams params;
112 docstring generated_label;
114 docstring screen_label;
123 #endif // INSET_CITATION_H