4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS.
15 #include "InsetCommand.h"
20 /// The reference inset
21 class InsetRef : public InsetCommand {
25 std::string latex_name;
29 std::string short_gui_name;
31 static const type_info types[];
33 static int getType(std::string const & name);
35 static std::string const & getName(int type);
38 InsetRef(Buffer * buffer, InsetCommandParams const &);
40 /// \name Public functions inherited from Inset class
43 bool isLabeled() const { return true; }
45 docstring toolTip(BufferView const &, int, int) const
48 docstring getTOCString() const;
50 bool hasSettings() const { return true; }
52 InsetCode lyxCode() const { return REF_CODE; }
54 DisplayType display() const { return Inline; }
56 void latex(otexstream &, OutputParams const &) const;
58 int plaintext(odocstringstream & ods, OutputParams const & op,
59 size_t max_length = INT_MAX) const;
61 int docbook(odocstream &, OutputParams const &) const;
63 docstring xhtml(XHTMLStream &, OutputParams const &) const;
65 void toString(odocstream &) const;
67 void forOutliner(docstring &, size_t) const;
69 void validate(LaTeXFeatures & features) const;
71 void updateBuffer(ParIterator const & it, UpdateType);
73 void addToToc(DocIterator const & di, bool output_active) const;
75 bool forceLTR() const { return true; }
78 /// \name Static public methods obligated for InsetCommand derived classes
81 static ParamInfo const & findInfo(std::string const &);
83 static std::string defaultCommand() { return "ref"; }
85 static bool isCompatibleCommand(std::string const & s);
89 /// \name Private functions inherited from InsetCommand class
92 docstring screenLabel() const { return screen_label_; }
97 InsetRef(InsetRef const &);
100 /// \name Private functions inherited from Inset class
103 Inset * clone() const { return new InsetRef(*this); }
106 /// \return the label with things that need to be escaped escaped
107 docstring getEscapedLabel(OutputParams const &) const;
108 /// \return the command for a formatted reference to ref
109 /// \param label we're cross-referencing
110 /// \param argument for reference command
111 /// \param prefix of the label (before :)
112 docstring getFormattedCmd(docstring const & ref, docstring & label,
113 docstring & prefix) const;
116 mutable docstring screen_label_;
118 mutable docstring tooltip_;
124 #endif // INSET_REF_H