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.
17 #include "InsetCommand.h"
18 #include "InsetCode.h"
20 #include "BiblioInfo.h"
26 /** Used to insert citations
28 class InsetCitation : public InsetCommand {
31 InsetCitation(InsetCommandParams const &);
33 docstring screenLabel() const;
35 EDITABLE editable() const { return IS_EDITABLE; }
37 InsetCode lyxCode() const { return CITE_CODE; }
39 int latex(odocstream &, OutputParams const &) const;
41 int plaintext(odocstream &, OutputParams const &) const;
43 int docbook(odocstream &, OutputParams const &) const;
44 /// the string that is passed to the TOC
45 void textString(odocstream &) const;
47 void validate(LaTeXFeatures &) const;
49 static ParamInfo const & findInfo(std::string const &);
50 //FIXME This is the locus of the design problem we have.
51 //It really ought to do what default_cite_command() does,
52 //but to do that it needs to know what CiteEngine we are
55 static std::string defaultCommand() { return "cite"; };
57 static bool isCompatibleCommand(std::string const & cmd);
60 Inset * clone() const { return new InsetCitation(params()); }
61 /// we'll eventually want to be able to get info on this from the
62 /// various CiteEngines
63 static ParamInfo param_info_;
64 /// This function does the donkey work of creating the pretty label
65 docstring generateLabel() const;
71 Cache() : engine(biblio::ENGINE_BASIC), params(CITE_CODE) {}
73 biblio::CiteEngine engine;
75 InsetCommandParams params;
77 docstring generated_label;
79 docstring screen_label;
88 #endif // INSET_CITE_H