X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2Finsets%2FInsetCitation.h;h=036d25fbbdb918b0565f8ac7a63320ad1f69dd08;hb=d65020b293ab208b1391f96a731e53e0c7274a02;hp=85f3f0ae22167621daa8fe90af23c43ca02d3600;hpb=2ab77c16f64b5e966c351f4d7a544e4892825127;p=lyx.git diff --git a/src/insets/InsetCitation.h b/src/insets/InsetCitation.h index 85f3f0ae22..036d25fbbd 100644 --- a/src/insets/InsetCitation.h +++ b/src/insets/InsetCitation.h @@ -5,14 +5,13 @@ * 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 "InsetCode.h" @@ -22,19 +21,26 @@ namespace lyx { +///////////////////////////////////////////////////////////////////////// +// +// InsetCitation +// +///////////////////////////////////////////////////////////////////////// -/** Used to insert citations - */ -class InsetCitation : public InsetCommand { +/// Used to insert citations +class InsetCitation : public InsetCommand +{ public: /// - InsetCitation(InsetCommandParams const &); + explicit InsetCitation(Buffer * buf, InsetCommandParams const &); /// bool isLabeled() const { return true; } /// docstring screenLabel() const; /// - EDITABLE editable() const { return IS_EDITABLE; } + bool hasSettings() const { return true; } + /// + docstring toolTip(BufferView const & bv, int x, int y) const; /// InsetCode lyxCode() const { return CITE_CODE; } /// @@ -43,41 +49,48 @@ public: int plaintext(odocstream &, OutputParams const &) const; /// int docbook(odocstream &, OutputParams const &) const; + /// + docstring xhtml(XHTMLStream &, OutputParams const &) const; /// the string that is passed to the TOC - void textString(odocstream &) const; + void tocString(odocstream &) const; /// void validate(LaTeXFeatures &) const; /// - void updateLabels(ParIterator const & it); + void updateBuffer(ParIterator const & it, UpdateType); /// - void addToToc(ParConstIterator const &) const; + 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"; }; + // 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); } + /// 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; /// 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(biblio::ENGINE_BASIC), params(CITE_CODE) {} + Cache() : engine(ENGINE_BASIC), params(CITE_CODE) {} /// - biblio::CiteEngine engine; + CiteEngine engine; /// InsetCommandParams params; /// @@ -89,7 +102,6 @@ private: mutable Cache cache; }; - } // namespace lyx -#endif // INSET_CITE_H +#endif // INSET_CITATION_H