lyx_mirror/src/insets/InsetBibitem.h
Vincent van Ravesteijn c75d667e78 Organize header files in src\insets.
- Functions that inherit from the same baseclass are grouped together with a command;
- Functions that inherit should not have a doxy entry;
- Other functions are also grouped together as much as possible;
- Some function don't need to be implemented if they return the same as the baseclass;
- and more.

git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@35873 a592a061-630c-0410-9148-cb99ea01b6c8
2010-10-27 21:35:13 +00:00

110 lines
2.5 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 "BiblioInfo.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 { return BIBITEM_CODE; }
///
bool hasSettings() const { return true; }
/// \copydoc Inset::initView()
/// verify label and update references.
void initView();
///
bool isLabeled() const { return true; }
///
void read(Lexer & lex);
///
int plaintext(odocstream &, OutputParams const &) const;
///
docstring xhtml(XHTMLStream &, OutputParams const &) const;
///
void fillWithBibKeys(BiblioInfo &, InsetIterator const &) const;
/// update the counter of this inset
void updateBuffer(ParIterator const &, UpdateType);
///@}
/// \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"; }
///@}
private:
///
docstring bibLabel() const;
/// \name Private functions inherited from Inset class
//@{
///
void doDispatch(Cursor & cur, FuncRequest & cmd);
///
Inset * clone() const { return new InsetBibitem(*this); }
///@}
/// \name Private functions inherited from InsetCommand class
//@{
///
docstring screenLabel() const;
//@}
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