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"
21 /// The reference inset
22 class InsetRef : public InsetCommand {
26 std::string latex_name;
30 std::string short_gui_name;
32 static type_info types[];
34 static int getType(std::string const & name);
36 static std::string const & getName(int type);
39 InsetRef(Buffer * buffer, InsetCommandParams const &);
42 bool isLabeled() const { return true; }
44 docstring screenLabel() const;
46 bool hasSettings() const { return true; }
48 InsetCode lyxCode() const { return REF_CODE; }
50 DisplayType display() const { return Inline; }
52 int latex(odocstream &, OutputParams const &) const;
54 int plaintext(odocstream &, OutputParams const &) const;
56 int docbook(odocstream &, OutputParams const &) const;
58 docstring xhtml(XHTMLStream &, OutputParams const &) const;
59 /// the string that is passed to the TOC
60 void tocString(odocstream &) const;
62 void validate(LaTeXFeatures & features) const;
64 static ParamInfo const & findInfo(std::string const &);
66 static std::string defaultCommand() { return "ref"; }
68 static bool isCompatibleCommand(std::string const & s);
70 void updateLabels(ParIterator const & it, UpdateType);
72 void addToToc(DocIterator const &);
75 InsetRef(InsetRef const &);
78 Inset * clone() const { return new InsetRef(*this); }
82 mutable docstring screen_label_;