lyx_mirror/src/insets/InsetBibtex.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

102 lines
2.2 KiB
C++

// -*- C++ -*-
/**
* \file InsetBibtex.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_BIBTEX_H
#define INSET_BIBTEX_H
#include "BiblioInfo.h"
#include "InsetCommand.h"
#include "support/FileNameList.h"
#include <map>
namespace lyx {
/** Used to insert BibTeX's information
*/
class InsetBibtex : public InsetCommand {
public:
///
InsetBibtex(Buffer *, InsetCommandParams const &);
///
~InsetBibtex();
///
support::FileNameList getBibFiles() const;
///
bool addDatabase(docstring const &);
///
bool delDatabase(docstring const &);
/// \name Public functions inherited from Inset class
//@{
///
docstring toolTip(BufferView const & bv, int x, int y) const;
///
bool hasSettings() const { return true; }
///
InsetCode lyxCode() const { return BIBTEX_CODE; }
///
DisplayType display() const { return AlignCenter; }
///
int latex(odocstream &, OutputParams const &) const;
///
void fillWithBibKeys(BiblioInfo &, InsetIterator const &) const;
///
void validate(LaTeXFeatures &) const;
///
docstring xhtml(XHTMLStream &, OutputParams const &) const;
///
docstring contextMenu(BufferView const &, int, int) const;
//@}
/// \name Static public methods obligated for InsetCommand derived classes
//@{
///
static ParamInfo const & findInfo(std::string const &);
///
static std::string defaultCommand() { return "bibtex"; }
///
static bool isCompatibleCommand(std::string const & s)
{ return s == "bibtex"; }
//@}
private:
/// look up the path to the file using TeX
static support::FileName
getBibTeXPath(docstring const & filename, Buffer const & buf);
///
void editDatabases() const;
/// \name Private functions inherited from Inset class
//@{
///
bool getStatus(Cursor & cur, FuncRequest const & cmd,
FuncStatus & flag) const;
///
void doDispatch(Cursor & cur, FuncRequest & cmd);
///
Inset * clone() const { return new InsetBibtex(*this); }
//@}
/// \name Private functions inherited from InsetCommand class
//@{
///
docstring screenLabel() const;
//@}
};
} // namespace lyx
#endif // INSET_BIBTEX_H