lyx_mirror/src/insets/InsetCitation.h
2008-05-13 08:23:44 +00:00

100 lines
2.3 KiB
C++

// -*- C++ -*-
/**
* \file InsetCitation.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Angus Leeming
* \author Herbert Voß
*
* Full author contact details are available in file CREDITS.
*/
#ifndef INSET_CITATION_H
#define INSET_CITATION_H
#include "InsetCommand.h"
#include "InsetCode.h"
#include "BiblioInfo.h"
namespace lyx {
/////////////////////////////////////////////////////////////////////////
//
// InsetCitation
//
/////////////////////////////////////////////////////////////////////////
/// Used to insert citations
class InsetCitation : public InsetCommand
{
public:
///
explicit InsetCitation(InsetCommandParams const &);
///
bool isLabeled() const { return true; }
///
docstring screenLabel() const;
///
EDITABLE editable() const { return IS_EDITABLE; }
///
InsetCode lyxCode() const { return CITE_CODE; }
///
int latex(odocstream &, OutputParams const &) const;
///
int plaintext(odocstream &, OutputParams const &) const;
///
int docbook(odocstream &, OutputParams const &) const;
/// the string that is passed to the TOC
void textString(odocstream &) const;
///
void validate(LaTeXFeatures &) const;
///
void updateLabels(ParIterator const & it);
///
void addToToc(DocIterator const &);
///
static ParamInfo const & findInfo(std::string const &);
// FIXME This is the locus of the design problem we have.
// It really ought to do what default_cite_command() does,
// but to do that it needs to know what CiteEngine we are
// using.
static std::string defaultCommand() { return "cite"; }
///
static bool isCompatibleCommand(std::string const & cmd);
///
virtual docstring contextMenu(BufferView const & bv, int x, int y) const;
private:
///
Inset * clone() const { return new InsetCitation(*this); }
/// we'll eventually want to be able to get info on this from the
/// various CiteEngines
static ParamInfo param_info_;
/// This function does the donkey work of creating the pretty label
docstring generateLabel() const;
///
class Cache {
public:
///
Cache() : engine(ENGINE_BASIC), params(CITE_CODE) {}
///
CiteEngine engine;
///
InsetCommandParams params;
///
docstring generated_label;
///
docstring screen_label;
};
///
mutable Cache cache;
};
} // namespace lyx
#endif // INSET_CITATION_H