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"
20 /////////////////////////////////////////////////////////////////////////
24 /////////////////////////////////////////////////////////////////////////
26 /// Used to insert citations
27 class InsetCitation : public InsetCommand
31 InsetCitation(Buffer * buf, InsetCommandParams const &);
36 bool addKey(std::string const & key);
38 /// \name Public functions inherited from Inset class
41 bool isLabeled() const { return true; }
43 bool hasSettings() const { return true; }
45 docstring toolTip(BufferView const & bv, int x, int y) const;
47 void doDispatch(Cursor & cur, FuncRequest & cmd);
49 bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
51 InsetCode lyxCode() const { return CITE_CODE; }
53 void latex(otexstream &, OutputParams const &) const;
55 int plaintext(odocstringstream & ods, OutputParams const & op,
56 size_t max_length = INT_MAX) const;
58 int docbook(odocstream &, OutputParams const &) const;
60 docstring xhtml(XHTMLStream &, OutputParams const &) const;
62 void toString(odocstream &) const;
64 void forOutliner(docstring &, size_t const, bool const) const;
66 void validate(LaTeXFeatures &) const {}
68 void updateBuffer(ParIterator const & it, UpdateType);
70 void addToToc(DocIterator const & di, bool output_active,
71 UpdateType utype) const;
73 std::string contextMenuName() const;
76 /// \name Static public methods obligated for InsetCommand derived classes
79 static ParamInfo const & findInfo(std::string const &);
81 static std::string defaultCommand() { return "cite"; }
83 static bool isCompatibleCommand(std::string const &);
87 /// tries to make a pretty label and makes a basic one if not
88 docstring generateLabel(bool for_xhtml = false) const;
89 /// makes a pretty label
90 docstring complexLabel(bool for_xhtml = false) const;
91 /// makes a very basic label, in case we can't make a pretty one
92 docstring basicLabel(bool for_xhtml = false) const;
94 /// \name Private functions inherited from Inset class
97 Inset * clone() const { return new InsetCitation(*this); }
100 /// \name Private functions inherited from InsetCommand class
103 docstring screenLabel() const;
106 /// we'll eventually want to be able to get info on this from the
107 /// various CiteEngines
108 static ParamInfo param_info_;
112 Cache() : recalculate(true) {}
116 docstring generated_label;
118 docstring screen_label;
127 #endif // INSET_CITATION_H