X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetCitation.h;h=40926b310a3330ec27522826c9fe8c24885116c1;hb=23c231c761dda80d220927c15e15c14493a57bc2;hp=a7c2ce02cc02478b2bc6beaa7495776d52779cb8;hpb=99f2abf59fc88faeac69df6a64d0d2a3615c8972;p=lyx.git diff --git a/src/insets/InsetCitation.h b/src/insets/InsetCitation.h index a7c2ce02cc..40926b310a 100644 --- a/src/insets/InsetCitation.h +++ b/src/insets/InsetCitation.h @@ -5,7 +5,7 @@ * 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. */ @@ -14,10 +14,6 @@ #define INSET_CITATION_H #include "InsetCommand.h" -#include "InsetCode.h" - -#include "BiblioInfo.h" - namespace lyx { @@ -32,59 +28,90 @@ class InsetCitation : public InsetCommand { public: /// - explicit InsetCitation(InsetCommandParams const &); + InsetCitation(Buffer * buf, InsetCommandParams const &); + /// + ~InsetCitation(); + + /// + bool addKey(std::string const & key); + + /// \name Public functions inherited from Inset class + //@{ /// bool isLabeled() const { return true; } /// - docstring screenLabel() const; + bool hasSettings() const { return true; } + /// + docstring toolTip(BufferView const & bv, int x, int y) const; + /// + void doDispatch(Cursor & cur, FuncRequest & cmd); /// - EDITABLE editable() const { return IS_EDITABLE; } + bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const; /// InsetCode lyxCode() const { return CITE_CODE; } /// - int latex(odocstream &, OutputParams const &) const; + void latex(otexstream &, OutputParams const &) const; /// - int plaintext(odocstream &, OutputParams const &) const; + int plaintext(odocstringstream & ods, OutputParams const & op, + size_t max_length = INT_MAX) const; /// int docbook(odocstream &, OutputParams const &) const; - /// the string that is passed to the TOC - void textString(odocstream &) const; /// - void validate(LaTeXFeatures &) const; + docstring xhtml(XHTMLStream &, OutputParams const &) const; + /// + void toString(odocstream &) const; + /// + void forOutliner(docstring &, size_t const, bool const) 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 & 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 bool isCompatibleCommand(std::string const & cmd); + static std::string defaultCommand() { return "cite"; } /// - virtual docstring contextMenu(BufferView const & bv, int x, int y) const; + static bool isCompatibleCommand(std::string 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); } - /// we'll eventually want to be able to get info on this from the + //@} + + /// \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_; - /// This function does the donkey work of creating the pretty label - docstring generateLabel() const; /// - class Cache { - public: + struct Cache { + Cache() : recalculate(true) {} /// - Cache() : engine(ENGINE_BASIC), params(CITE_CODE) {} - /// - CiteEngine engine; - /// - InsetCommandParams params; + bool recalculate; /// docstring generated_label; /// @@ -94,6 +121,7 @@ private: mutable Cache cache; }; + } // namespace lyx #endif // INSET_CITATION_H