3 * \file InsetHyperlink.h
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.
12 #ifndef INSET_HYPERLINK_H
13 #define INSET_HYPERLINK_H
15 #include "InsetCommand.h"
20 /** The hyperlink inset
22 class InsetHyperlink : public InsetCommand
26 InsetHyperlink(Buffer * buf, InsetCommandParams const &);
28 /// \name Public functions inherited from Inset class
31 InsetCode lyxCode() const override { return HYPERLINK_CODE; }
33 bool hasSettings() const override { return true; }
35 bool isInToc() const override { return true; }
37 void toString(odocstream &) const override;
39 void forOutliner(docstring &, size_t const, bool const) const override;
41 docstring toolTip(BufferView const & bv, int x, int y) const override;
43 std::string contextMenuName() const override;
45 void validate(LaTeXFeatures &) const override;
47 void latex(otexstream &, OutputParams const &) const override;
49 int plaintext(odocstringstream & ods, OutputParams const & op,
50 size_t max_length = INT_MAX) const override;
52 void docbook(XMLStream &, OutputParams const &) const override;
54 docstring xhtml(XMLStream &, OutputParams const &) const override;
56 std::pair<int, int> isWords() const override;
59 /// \name Static public methods obligated for InsetCommand derived classes
62 static bool isCompatibleCommand(std::string const & s)
63 { return s == "href"; }
65 static std::string defaultCommand() { return "href"; }
67 static ParamInfo const & findInfo(std::string const &);
71 /// \name Private functions inherited from Inset class
74 void doDispatch(Cursor & cur, FuncRequest & cmd) override;
76 bool getStatus(Cursor & cur, FuncRequest const & cmd,
77 FuncStatus & flag) const override;
79 Inset * clone() const override { return new InsetHyperlink(*this); }
82 /// \name Private functions inherited from InsetCommand class
85 docstring screenLabel() const override;
89 void viewTarget() const;
95 #endif // INSET_HYPERLINK_H