lyx_mirror/src/insets/InsetBibitem.h
2020-10-13 09:57:36 +03:00

114 lines
2.8 KiB
C++

// -*- C++ -*-
/**
* \file InsetBibitem.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Alejandro Aguilar Sierra
*
* Full author contact details are available in file CREDITS.
*/
#ifndef INSET_BIBITEM_H
#define INSET_BIBITEM_H
#include "InsetCommand.h"
namespace lyx {
/////////////////////////////////////////////////////////////////////////
//
// InsetBibItem
//
/////////////////////////////////////////////////////////////////////////
/// Used to insert bibitem's information (key and label)
// Must be automatically inserted as the first object in a
// bibliography paragraph.
class InsetBibitem : public InsetCommand
{
public:
///
InsetBibitem(Buffer *, InsetCommandParams const &);
///
~InsetBibitem();
///
void updateCommand(docstring const & new_key, bool dummy = false);
/// \name Public functions inherited from Inset class
//@{
///
InsetCode lyxCode() const override { return BIBITEM_CODE; }
///
bool hasSettings() const override { return true; }
/// \copydoc Inset::initView()
/// verify label and update references.
void initView() override;
///
bool isLabeled() const override { return true; }
///
void read(Lexer & lex) override;
///
int plaintext(odocstringstream &, OutputParams const &,
size_t max_length = INT_MAX) const override;
///
docstring xhtml(XMLStream &, OutputParams const &) const override;
///
void docbook(XMLStream &, OutputParams const &) const override;
///
void collectBibKeys(InsetIterator const &, support::FileNameList &) const override;
/// update the counter of this inset
void updateBuffer(ParIterator const &, UpdateType, bool const deleted = false) override;
///@}
/// \name Static public methods obligated for InsetCommand derived classes
//@{
///
static ParamInfo const & findInfo(std::string const &);
///
static std::string defaultCommand() { return "bibitem"; }
///
static bool isCompatibleCommand(std::string const & s)
{ return s == "bibitem"; }
///
docstring bibLabel() const;
///@}
private:
/// \name Private functions inherited from Inset class
//@{
///
void doDispatch(Cursor & cur, FuncRequest & cmd) override;
///
Inset * clone() const override { return new InsetBibitem(*this); }
/// Is the content of this inset part of the immediate (visible) text sequence?
bool isPartOfTextSequence() const override { return false; }
///@}
/// \name Private functions inherited from InsetCommand class
//@{
///
docstring screenLabel() const override;
//@}
friend docstring bibitemWidest(Buffer const & buffer, OutputParams const &);
/// The label that is set by updateBuffer
docstring autolabel_;
///
static int key_counter;
};
/// Return the widest label in the Bibliography.
docstring bibitemWidest(Buffer const &, OutputParams const &);
} // namespace lyx
#endif // INSET_BIBITEM_H