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"
21 /////////////////////////////////////////////////////////////////////////
25 /////////////////////////////////////////////////////////////////////////
27 /// Used to insert citations
28 class InsetCitation : public InsetCommand
32 InsetCitation(Buffer * buf, InsetCommandParams const &);
37 bool addKey(std::string const & key);
39 /// \name Public functions inherited from Inset class
42 bool isLabeled() const { return true; }
44 bool hasSettings() const { return true; }
46 docstring toolTip(BufferView const & bv, int x, int y) const;
48 void doDispatch(Cursor & cur, FuncRequest & cmd);
50 bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
52 InsetCode lyxCode() const { return CITE_CODE; }
54 void latex(otexstream &, OutputParams const &) const;
56 int plaintext(odocstringstream & ods, OutputParams const & op,
57 size_t max_length = INT_MAX) const;
59 int docbook(odocstream &, OutputParams const &) const;
61 docstring xhtml(XMLStream &, OutputParams const &) const;
63 void toString(odocstream &) const;
65 void forOutliner(docstring &, size_t const, bool const) const;
67 void updateBuffer(ParIterator const & it, UpdateType, bool const deleted = false);
69 void addToToc(DocIterator const & di, bool output_active,
70 UpdateType utype, TocBackend & backend) const;
72 std::string contextMenuName() const;
74 bool forceLTR(OutputParams const &) const;
77 /// \name Static public methods obligated for InsetCommand derived classes
80 static ParamInfo const & findInfo(std::string const &);
82 static std::string defaultCommand() { return "cite"; }
84 static bool isCompatibleCommand(std::string const &);
87 typedef std::vector<std::pair<docstring, docstring>> QualifiedList;
89 void redoLabel() { cache.recalculate = true; }
91 CitationStyle getCitationStyle(BufferParams const & bp, std::string const & input,
92 std::vector<CitationStyle> const & valid_styles) const;
94 QualifiedList getQualifiedLists(docstring const & p) const;
96 static bool last_literal;
99 /// tries to make a pretty label and makes a basic one if not
100 docstring generateLabel(bool for_xhtml = false) const;
101 /// makes a pretty label
102 docstring complexLabel(bool for_xhtml = false) const;
103 /// makes a very basic label, in case we can't make a pretty one
104 docstring basicLabel(bool for_xhtml = false) const;
106 /// \name Private functions inherited from Inset class
109 Inset * clone() const { return new InsetCitation(*this); }
112 /// \name Private functions inherited from InsetCommand class
115 docstring screenLabel() const;
120 Cache() : recalculate(true) {}
124 docstring generated_label;
126 docstring screen_label;
135 #endif // INSET_CITATION_H