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"
17 #include "InsetCode.h"
19 #include "BiblioInfo.h"
24 /////////////////////////////////////////////////////////////////////////
28 /////////////////////////////////////////////////////////////////////////
30 /// Used to insert citations
31 class InsetCitation : public InsetCommand
35 explicit InsetCitation(Buffer * buf, InsetCommandParams const &);
37 bool isLabeled() const { return true; }
39 docstring screenLabel() const;
41 bool hasSettings() const { return true; }
43 docstring toolTip(BufferView const & bv, int x, int y) const;
45 InsetCode lyxCode() const { return CITE_CODE; }
47 int latex(odocstream &, OutputParams const &) const;
49 int plaintext(odocstream &, OutputParams const &) const;
51 int docbook(odocstream &, OutputParams const &) const;
53 docstring xhtml(XHTMLStream &, OutputParams const &) const;
54 /// the string that is passed to the TOC
55 void tocString(odocstream &) const;
57 void validate(LaTeXFeatures &) const;
59 void updateBuffer(ParIterator const & it, UpdateType);
61 void addToToc(DocIterator const &);
64 static ParamInfo const & findInfo(std::string const &);
65 // FIXME This is the locus of the design problem we have.
66 // It really ought to do what default_cite_command() does,
67 // but to do that it needs to know what CiteEngine we are
69 static std::string defaultCommand() { return "cite"; }
71 static bool isCompatibleCommand(std::string const & cmd);
73 virtual docstring contextMenu(BufferView const & bv, int x, int y) const;
76 Inset * clone() const { return new InsetCitation(*this); }
77 /// tries to make a pretty label and makes a basic one if not
78 docstring generateLabel(bool for_xhtml = false) const;
79 /// makes a pretty label
80 docstring complexLabel(bool for_xhtml = false) const;
81 /// makes a very basic label, in case we can't make a pretty one
82 docstring basicLabel(bool for_xhtml = false) const;
83 /// we'll eventually want to be able to get info on this from the
84 /// various CiteEngines
85 static ParamInfo param_info_;
91 Cache() : engine(ENGINE_BASIC), params(CITE_CODE) {}
95 InsetCommandParams params;
97 docstring generated_label;
99 docstring screen_label;
107 #endif // INSET_CITATION_H