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 bool findUsesToString() const override { return true; }
39 void toString(odocstream &) const override;
41 void forOutliner(docstring &, size_t const, bool const) const override;
43 docstring toolTip(BufferView const & bv, int x, int y) const override;
45 std::string contextMenuName() const override;
47 void validate(LaTeXFeatures &) const override;
49 void latex(otexstream &, OutputParams const &) const override;
51 int plaintext(odocstringstream & ods, OutputParams const & op,
52 size_t max_length = INT_MAX) const override;
54 void docbook(XMLStream &, OutputParams const &) const override;
56 docstring xhtml(XMLStream &, OutputParams const &) const override;
58 std::pair<int, int> isWords() const override;
61 /// \name Static public methods obligated for InsetCommand derived classes
64 static bool isCompatibleCommand(std::string const & s)
65 { return s == "href"; }
67 static std::string defaultCommand() { return "href"; }
69 static ParamInfo const & findInfo(std::string const &);
73 /// \name Private functions inherited from Inset class
76 void doDispatch(Cursor & cur, FuncRequest & cmd) override;
78 bool getStatus(Cursor & cur, FuncRequest const & cmd,
79 FuncStatus & flag) const override;
81 Inset * clone() const override { return new InsetHyperlink(*this); }
84 /// \name Private functions inherited from InsetCommand class
87 docstring screenLabel() const override;
91 void viewTarget() const;
97 #endif // INSET_HYPERLINK_H