src/insets/InsetBibtex.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetBibtex.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_BIBTEX_H
  13 #define INSET_BIBTEX_H
  14
  15 #include "InsetCommand.h"
  16
  17 namespace lyx {
  18
  19 class BiblioInfo;
  20
  21 namespace support {
  22         class FileName;
  23         class FileNameList;
  24 }
  25
  26 /** Used to insert BibTeX's information
  27   */
  28 class InsetBibtex : public InsetCommand {
  29 public:
  30         ///
  31         InsetBibtex(Buffer *, InsetCommandParams const &);
  32         ///
  33         ~InsetBibtex();
  34
  35         ///
  36         support::FileNameList getBibFiles() const;
  37         ///
  38         bool addDatabase(docstring const &);
  39         ///
  40         bool delDatabase(docstring const &);
  41
  42         /// \name Public functions inherited from Inset class
  43         //@{
  44         ///
  45         docstring toolTip(BufferView const & bv, int x, int y) const;
  46         ///
  47         bool hasSettings() const { return true; }
  48         ///
  49         InsetCode lyxCode() const { return BIBTEX_CODE; }
  50         ///
  51         DisplayType display() const { return AlignCenter; }
  52         ///
  53         void latex(otexstream &, OutputParams const &) const;
  54         ///
  55         int plaintext(odocstringstream & ods, OutputParams const & op,
  56                       size_t max_length = INT_MAX) const;
  57         ///
  58         void collectBibKeys(InsetIterator const &) const;
  59         ///
  60         void validate(LaTeXFeatures &) const;
  61         ///
  62         docstring xhtml(XHTMLStream &, OutputParams const &) const;
  63         ///
  64         std::string contextMenuName() const;
  65         //@}
  66
  67         /// \name Static public methods obligated for InsetCommand derived classes
  68         //@{
  69         ///
  70         static ParamInfo const & findInfo(std::string const &);
  71         ///
  72         static std::string defaultCommand() { return "bibtex"; }
  73         ///
  74         static bool isCompatibleCommand(std::string const & s)
  75                 { return s == "bibtex"; }
  76         //@}
  77
  78 private:
  79         /// look up the path to the file using TeX
  80         static support::FileName
  81                 getBibTeXPath(docstring const & filename, Buffer const & buf);
  82         ///
  83         void editDatabases() const;
  84         ///
  85         void parseBibTeXFiles() const;
  86
  87         /// \name Private functions inherited from Inset class
  88         //@{
  89         ///
  90         bool getStatus(Cursor & cur, FuncRequest const & cmd,
  91                 FuncStatus & flag) const;
  92         ///
  93         void doDispatch(Cursor & cur, FuncRequest & cmd);
  94         ///
  95         Inset * clone() const { return new InsetBibtex(*this); }
  96         //@}
  97
  98         /// \name Private functions inherited from InsetCommand class
  99         //@{
 100         ///
 101         docstring screenLabel() const;
 102         //@}
 103 };
 104
 105
 106 } // namespace lyx
 107
 108 #endif // INSET_BIBTEX_H