X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetRef.h;h=a28d233fc2cb0edc6a35ce567e4e3a79de4ef0c6;hb=239b9919ffe28338d789e6dc9122228f77ab77a7;hp=934681172bab76cc3e9102380a9ac89e0ccf0a5b;hpb=b83564d82cbf5ffab48715293df03b6b6284c1b5;p=lyx.git diff --git a/src/insets/InsetRef.h b/src/insets/InsetRef.h index 934681172b..a28d233fc2 100644 --- a/src/insets/InsetRef.h +++ b/src/insets/InsetRef.h @@ -4,7 +4,7 @@ * This file is part of LyX, the document processor. * Licence details can be found in the file COPYING. * - * \author José Matos + * \author José Matos * * Full author contact details are available in file CREDITS. */ @@ -17,7 +17,6 @@ namespace lyx { - /// The reference inset class InsetRef : public InsetCommand { public: @@ -29,57 +28,98 @@ public: /// std::string short_gui_name; }; - static type_info types[]; + static const type_info types[]; /// static int getType(std::string const & name); /// static std::string const & getName(int type); + /// + InsetRef(Buffer * buffer, InsetCommandParams const &); - InsetRef(Buffer const & buffer, InsetCommandParams const &); - + /// \name Public functions inherited from Inset class + //@{ /// bool isLabeled() const { return true; } /// - docstring screenLabel() const; + docstring toolTip(BufferView const &, int, int) const + { return tooltip_; } /// - EDITABLE editable() const { return IS_EDITABLE; } + docstring getTOCString() const; + /// + bool hasSettings() const { return true; } /// InsetCode lyxCode() const { return REF_CODE; } /// DisplayType display() const { return Inline; } /// - 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 tocString(odocstream &) const; + /// + docstring xhtml(XHTMLStream &, OutputParams const &) const; + /// + void toString(odocstream &) const; + /// + void forOutliner(docstring &, size_t const, bool const) const; /// void validate(LaTeXFeatures & features) const; /// + void updateBuffer(ParIterator const & it, UpdateType); + /// + void addToToc(DocIterator const & di, bool output_active, + UpdateType utype) const; + /// + bool forceLTR() const { return true; } + //@} + + /// \name Static public methods obligated for InsetCommand derived classes + //@{ + /// static ParamInfo const & findInfo(std::string const &); /// - static std::string defaultCommand() { return "ref"; }; + static std::string defaultCommand() { return "ref"; } /// static bool isCompatibleCommand(std::string const & s); + //@} + + //FIXME: private + /// \name Private functions inherited from InsetCommand class + //@{ /// - void updateLabels(ParIterator const & it); - /// - void addToToc(DocIterator const &); + docstring screenLabel() const { return screen_label_; } + //@} + protected: /// InsetRef(InsetRef const &); + private: + /// \name Private functions inherited from Inset class + //@{ /// Inset * clone() const { return new InsetRef(*this); } - /// - bool isLatex; + //@} + + /// \return the label with things that need to be escaped escaped + docstring getEscapedLabel(OutputParams const &) const; + /// \return the command for a formatted reference to ref + /// \param label we're cross-referencing + /// \param argument for reference command + /// \param prefix of the label (before :) + docstring getFormattedCmd(docstring const & ref, docstring & label, + docstring & prefix, docstring const & caps) const; + /// mutable docstring screen_label_; + /// + mutable docstring tooltip_; }; + } // namespace lyx -#endif +#endif // INSET_REF_H