X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetRef.h;h=066a596630b15f55399e015f96bdafd364780a7d;hb=4947476da8d7e42ded2c53ee984dc4c38db1d528;hp=1b9e9f469c4821c0df6f58d244ab95b256b86cf2;hpb=d65020b293ab208b1391f96a731e53e0c7274a02;p=lyx.git diff --git a/src/insets/InsetRef.h b/src/insets/InsetRef.h index 1b9e9f469c..066a596630 100644 --- a/src/insets/InsetRef.h +++ b/src/insets/InsetRef.h @@ -17,7 +17,6 @@ namespace lyx { - /// The reference inset class InsetRef : public InsetCommand { public: @@ -29,64 +28,99 @@ 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 &); + /// \name Public functions inherited from Inset class + //@{ /// bool isLabeled() const { return true; } /// - docstring screenLabel() const { return screen_label_; } - /// docstring toolTip(BufferView const &, int, int) const { return tooltip_; } /// + 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; /// docstring xhtml(XHTMLStream &, OutputParams const &) const; - /// the string that is passed to the TOC - void tocString(odocstream &) 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, TocBackend & backend) 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 bool isCompatibleCommand(std::string const & s); - /// - void updateBuffer(ParIterator const & it, UpdateType); - /// - void addToToc(DocIterator const &); + //@} + protected: /// InsetRef(InsetRef const &); + private: + /// \name Private functions inherited from Inset class + //@{ /// Inset * clone() const { return new InsetRef(*this); } + //@} + + /// \name Private functions inherited from InsetCommand class + //@{ /// - bool isLatex; + docstring screenLabel() const; + //@} + + /// \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 bool broken_; + /// mutable docstring tooltip_; }; + } // namespace lyx -#endif +#endif // INSET_REF_H