4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Alejandro Aguilar Sierra
9 * Full author contact details are available in file CREDITS.
12 #ifndef INSET_BIBITEM_H
13 #define INSET_BIBITEM_H
16 #include "InsetCommand.h"
23 /////////////////////////////////////////////////////////////////////////
27 /////////////////////////////////////////////////////////////////////////
29 /// Used to insert bibitem's information (key and label)
31 // Must be automatically inserted as the first object in a
32 // bibliography paragraph.
33 class InsetBibitem : public InsetCommand
37 InsetBibitem(Buffer *, InsetCommandParams const &);
42 void updateCommand(docstring const & new_key, bool dummy = false);
44 /// \name Public functions inherited from Inset class
47 InsetCode lyxCode() const { return BIBITEM_CODE; }
49 bool hasSettings() const { return true; }
50 /// \copydoc Inset::initView()
51 /// verify label and update references.
54 bool isLabeled() const { return true; }
56 void read(Lexer & lex);
58 int plaintext(odocstringstream &, OutputParams const &,
59 size_t max_length = INT_MAX) const;
61 docstring xhtml(XMLStream &, OutputParams const &) const;
63 void collectBibKeys(InsetIterator const &, support::FileNameList &) const;
64 /// update the counter of this inset
65 void updateBuffer(ParIterator const &, UpdateType, bool const deleted = false);
68 /// \name Static public methods obligated for InsetCommand derived classes
71 static ParamInfo const & findInfo(std::string const &);
73 static std::string defaultCommand() { return "bibitem"; }
75 static bool isCompatibleCommand(std::string const & s)
76 { return s == "bibitem"; }
81 docstring bibLabel() const;
83 /// \name Private functions inherited from Inset class
86 void doDispatch(Cursor & cur, FuncRequest & cmd);
88 Inset * clone() const { return new InsetBibitem(*this); }
89 /// Is the content of this inset part of the immediate (visible) text sequence?
90 bool isPartOfTextSequence() const { return false; }
93 /// \name Private functions inherited from InsetCommand class
96 docstring screenLabel() const;
99 friend docstring bibitemWidest(Buffer const & buffer, OutputParams const &);
101 /// The label that is set by updateBuffer
102 docstring autolabel_;
104 static int key_counter;
108 /// Return the widest label in the Bibliography.
109 docstring bibitemWidest(Buffer const &, OutputParams const &);
114 #endif // INSET_BIBITEM_H