.. wxPython Phoenix documentation This file was generated by Phoenix's sphinx generator and associated tools, do not edit by hand. Copyright: (c) 2011-2020 by Total Control Software License: wxWindows License .. include:: headings.inc .. _wx.html.HtmlLinkEvent: ========================================================================================================================================== |phoenix_title| **wx.html.HtmlLinkEvent** ========================================================================================================================================== This event class is used for the events generated by :ref:`wx.html.HtmlWindow`. ^^ .. _HtmlLinkEvent-events: |events| Events Emitted by this Class ===================================== Handlers bound for the following event types will receive a :ref:`wx.html.HtmlLinkEvent` parameter. - EVT_HTML_LINK_CLICKED: User clicked on a hyperlink. ^^ | |class_hierarchy| Class Hierarchy ================================= .. raw:: html
Inheritance diagram for class HtmlLinkEvent:
| |method_summary| Methods Summary ================================ ================================================================================ ================================================================================ :meth:`~wx.html.HtmlLinkEvent.__init__` The constructor is not normally used by the user code. :meth:`~wx.html.HtmlLinkEvent.GetLinkInfo` Returns the :ref:`wx.html.HtmlLinkInfo` which contains info about the cell clicked and the hyperlink it contains. ================================================================================ ================================================================================ | |property_summary| Properties Summary ===================================== ================================================================================ ================================================================================ :attr:`~wx.html.HtmlLinkEvent.LinkInfo` See :meth:`~wx.html.HtmlLinkEvent.GetLinkInfo` ================================================================================ ================================================================================ | |api| Class API =============== .. class:: wx.html.HtmlLinkEvent(CommandEvent) **Possible constructors**:: HtmlLinkEvent(id, linkinfo) This event class is used for the events generated by HtmlWindow. .. method:: __init__(self, id, linkinfo) The constructor is not normally used by the user code. :param `id`: :type `id`: int :param `linkinfo`: :type `linkinfo`: wx.html.HtmlLinkInfo .. method:: GetLinkInfo(self) Returns the :ref:`wx.html.HtmlLinkInfo` which contains info about the cell clicked and the hyperlink it contains. :rtype: :ref:`wx.html.HtmlLinkInfo` .. attribute:: LinkInfo See :meth:`~wx.html.HtmlLinkEvent.GetLinkInfo`