src/insets/InsetBibitem.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetBibitem.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Alejandro Aguilar Sierra
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef INSET_BIBITEM_H
  13 #define INSET_BIBITEM_H
  14
  15
  16 #include "InsetCommand.h"
  17
  18
  19 namespace lyx {
  20
  21 class BiblioInfo;
  22
  23 /////////////////////////////////////////////////////////////////////////
  24 //
  25 // InsetBibItem
  26 //
  27 /////////////////////////////////////////////////////////////////////////
  28
  29 /// Used to insert bibitem's information (key and label)
  30
  31 //  Must be automatically inserted as the first object in a
  32 //  bibliography paragraph.
  33 class InsetBibitem : public InsetCommand
  34 {
  35 public:
  36         ///
  37         InsetBibitem(Buffer *, InsetCommandParams const &);
  38         ///
  39         ~InsetBibitem();
  40
  41         ///
  42         void updateCommand(docstring const & new_key, bool dummy = false);
  43
  44         /// \name Public functions inherited from Inset class
  45         //@{
  46         ///
  47         InsetCode lyxCode() const { return BIBITEM_CODE; }
  48         ///
  49         bool hasSettings() const { return true; }
  50         /// \copydoc Inset::initView()
  51         /// verify label and update references.
  52         void initView();
  53         ///
  54         bool isLabeled() const { return true; }
  55         ///
  56         void read(Lexer & lex);
  57         ///
  58         int plaintext(odocstringstream &, OutputParams const &,
  59                       size_t max_length = INT_MAX) const;
  60         ///
  61         docstring xhtml(XMLStream &, OutputParams const &) const;
  62         ///
  63         void docbook(XMLStream &, OutputParams const &) const;
  64         ///
  65         void collectBibKeys(InsetIterator const &, support::FileNameList &) const;
  66         /// update the counter of this inset
  67         void updateBuffer(ParIterator const &, UpdateType, bool const deleted = false);
  68         ///@}
  69
  70         /// \name Static public methods obligated for InsetCommand derived classes
  71         //@{
  72         ///
  73         static ParamInfo const & findInfo(std::string const &);
  74         ///
  75         static std::string defaultCommand() { return "bibitem"; }
  76         ///
  77         static bool isCompatibleCommand(std::string const & s)
  78                 { return s == "bibitem"; }
  79         ///
  80         docstring bibLabel() const;
  81         ///@}
  82
  83 private:
  84         /// \name Private functions inherited from Inset class
  85         //@{
  86         ///
  87         void doDispatch(Cursor & cur, FuncRequest & cmd);
  88         ///
  89         Inset * clone() const { return new InsetBibitem(*this); }
  90         /// Is the content of this inset part of the immediate (visible) text sequence?
  91         bool isPartOfTextSequence() const { return false; }
  92         ///@}
  93
  94         /// \name Private functions inherited from InsetCommand class
  95         //@{
  96         ///
  97         docstring screenLabel() const;
  98         //@}
  99
 100         friend docstring bibitemWidest(Buffer const & buffer, OutputParams const &);
 101
 102         /// The label that is set by updateBuffer
 103         docstring autolabel_;
 104         ///
 105         static int key_counter;
 106 };
 107
 108
 109 /// Return the widest label in the Bibliography.
 110 docstring bibitemWidest(Buffer const &, OutputParams const &);
 111
 112
 113 } // namespace lyx
 114
 115 #endif // INSET_BIBITEM_H