X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetCitation.h;h=cde7bd126ce511f0475029944020dd40e84ae208;hb=239b9919ffe28338d789e6dc9122228f77ab77a7;hp=6a88473826775f5e8b56fbaefab20a1e36734371;hpb=8e9410b3d034178f5e391c6cfffca3d65afe59ff;p=lyx.git diff --git a/src/insets/InsetCitation.h b/src/insets/InsetCitation.h index 6a88473826..cde7bd126c 100644 --- a/src/insets/InsetCitation.h +++ b/src/insets/InsetCitation.h @@ -5,78 +5,117 @@ * 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" - -#include "BiblioInfo.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 &); /// - docstring const getScreenLabel(Buffer const &) const; + ~InsetCitation(); + + /// + bool addKey(std::string const & key); + + /// \name Public functions inherited from Inset class + //@{ /// - EDITABLE editable() const { return IS_EDITABLE; } + bool isLabeled() const { return true; } + /// + bool hasSettings() const { return true; } + /// + docstring toolTip(BufferView const & bv, int x, int y) const; + /// + void doDispatch(Cursor & cur, FuncRequest & cmd); + /// + bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const; /// InsetCode lyxCode() const { return CITE_CODE; } /// - int latex(Buffer const &, odocstream &, - OutputParams const &) const; + void latex(otexstream &, OutputParams const &) const; + /// + int plaintext(odocstringstream & ods, OutputParams const & op, + size_t max_length = INT_MAX) const; + /// + int docbook(odocstream &, OutputParams const &) const; /// - int plaintext(Buffer const &, odocstream &, - OutputParams const &) const; + docstring xhtml(XHTMLStream &, OutputParams const &) const; /// - int docbook(Buffer const &, odocstream &, - OutputParams const &) const; - /// the string that is passed to the TOC - void textString(Buffer const &, odocstream &) const; + void toString(odocstream &) const; /// - void validate(LaTeXFeatures &) const; + void forOutliner(docstring &, size_t const, bool const) const; + /// + void validate(LaTeXFeatures &) const {} + /// + void updateBuffer(ParIterator const & it, UpdateType); + /// + void addToToc(DocIterator const & di, bool output_active, + UpdateType utype) const; + /// + std::string 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 std::string defaultCommand() { return "cite"; } + /// + static bool isCompatibleCommand(std::string const &); + //@} /// - static bool isCompatibleCommand(std::string const & cmd); + CitationStyle getCitationStyle(BufferParams const & bp, std::string const & input, + std::vector const & valid_styles) const; + private: + /// 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; + + /// \name Private functions inherited from Inset class + //@{ + /// + Inset * clone() const { return new InsetCitation(*this); } + //@} + + /// \name Private functions inherited from InsetCommand class + //@{ /// - virtual Inset * clone() const - { return new InsetCitation(params()); } - /// we'll eventually want to be able to get info on this from the + docstring screenLabel() 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 const generateLabel(Buffer const &) const; /// - class Cache { - public: - /// - Cache() : engine(biblio::ENGINE_BASIC), params(CITE_CODE) {} - /// - biblio::CiteEngine engine; + struct Cache { + Cache() : recalculate(true) {} /// - InsetCommandParams params; + bool recalculate; /// docstring generated_label; /// @@ -89,4 +128,4 @@ private: } // namespace lyx -#endif // INSET_CITE_H +#endif // INSET_CITATION_H