X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetCitation.h;h=49104924cd2d00f0cc31a8e56640ee2b322f0680;hb=bfddee97e191a853f0576f4fab3f095c4e9ce0de;hp=f0fd1d7a732cf44b37918f8adcdedbc571c8a271;hpb=176715bd567758b914a8ebaa2eb8c32f9770a8c7;p=lyx.git diff --git a/src/insets/InsetCitation.h b/src/insets/InsetCitation.h index f0fd1d7a73..49104924cd 100644 --- a/src/insets/InsetCitation.h +++ b/src/insets/InsetCitation.h @@ -5,67 +5,109 @@ * Licence details can be found in the file COPYING. * * \author Angus Leeming - * \author Herbert Voß + * \author Herbert Voß * * Full author contact details are available in file CREDITS. */ -#ifndef INSET_CITE_H -#define INSET_CITE_H - +#ifndef INSET_CITATION_H +#define INSET_CITATION_H #include "InsetCommand.h" -#include "frontends/controllers/biblio.h" - +#include "Citation.h" namespace lyx { +///////////////////////////////////////////////////////////////////////// +// +// InsetCitation +// +///////////////////////////////////////////////////////////////////////// -/** Used to insert citations - */ -class InsetCitation : public InsetCommand { +/// Used to insert citations +class InsetCitation : public InsetCommand +{ public: /// - InsetCitation(InsetCommandParams const &); + InsetCitation(Buffer * buf, InsetCommandParams const &); + + /// \name Public functions inherited from Inset class + //@{ + /// + bool isLabeled() const { return true; } /// - docstring const getScreenLabel(Buffer const &) const; + bool hasSettings() const { return true; } /// - EDITABLE editable() const { return IS_EDITABLE; } + docstring toolTip(BufferView const & bv, int x, int y) const; /// - InsetBase::Code lyxCode() const { return InsetBase::CITE_CODE; } + InsetCode lyxCode() const { return CITE_CODE; } /// - int latex(Buffer const &, odocstream &, - OutputParams const &) const; + void latex(otexstream &, OutputParams const &) const; /// - int plaintext(Buffer const &, odocstream &, - OutputParams const &) const; + int plaintext(odocstream &, OutputParams const &) const; /// - int docbook(Buffer const &, odocstream &, - OutputParams const &) const; - /// the string that is passed to the TOC - virtual int textString(Buffer const &, odocstream &, - OutputParams const &) const; + int docbook(odocstream &, OutputParams const &) const; + /// + docstring xhtml(XHTMLStream &, OutputParams const &) const; + /// + void toString(odocstream &) const; + /// + void forToc(docstring &, size_t) const; /// void validate(LaTeXFeatures &) const; /// - void replaceContents(std::string const & from, std::string const & to); + void updateBuffer(ParIterator const & it, UpdateType); + /// + void addToToc(DocIterator const &) const; + /// + docstring contextMenuName() const; + //@} + + /// \name Static public methods obligated for InsetCommand derived classes + //@{ + /// + 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); + //@} private: - virtual std::auto_ptr doClone() const - { - return std::auto_ptr(new InsetCitation(params())); - } + /// tries to make a pretty label and makes a basic one if not + docstring generateLabel(bool for_xhtml = false) const; + /// makes a pretty label + docstring complexLabel(bool for_xhtml = false) const; + /// makes a very basic label, in case we can't make a pretty one + docstring basicLabel(bool for_xhtml = false) const; - /// This function does the donkey work of creating the pretty label - docstring const generateLabel(Buffer const &) const; + /// \name Private functions inherited from Inset class + //@{ + /// + Inset * clone() const { return new InsetCitation(*this); } + //@} + /// \name Private functions inherited from InsetCommand class + //@{ + /// + docstring screenLabel() const; + //@} + + /// we'll eventually want to be able to get info on this from the + /// various CiteEngines + static ParamInfo param_info_; + + /// class Cache { public: /// - Cache() : engine(biblio::ENGINE_BASIC), params("cite") {} + Cache() : engine(ENGINE_BASIC), params(CITE_CODE) {} /// - biblio::CiteEngine engine; + CiteEngine engine; /// InsetCommandParams params; /// @@ -80,4 +122,4 @@ private: } // namespace lyx -#endif // INSET_CITE_H +#endif // INSET_CITATION_H