*********************
wx.html.HtmlLinkEvent
*********************

Inheritance diagram for `wx.html.HtmlLinkEvent`:

|

.. inheritance-diagram:: wx.html.HtmlLinkEvent

|

Description
===========

This event class is used for the events generated by `wx.html.HtmlWindow <../html/wx.html.HtmlWindow.html>`_.


Derived From
^^^^^^^^^^^^^

* `wx.CommandEvent <wx.CommandEvent.html>`_ 
* `wx.Event <wx.Event.html>`_ 
* `wx.Object <../Widgets/wx.Object.html>`_ 


Event Handling
^^^^^^^^^^^^^^

==================================================  ==================================================  
Event Name                                          Description
==================================================  ==================================================  
wx.EVT_HTML_LINK_CLICKED(id, func)                  User clicked on an hyperlink.
==================================================  ==================================================  

Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `GetLinkInfo <#GetLinkInfo>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(id, linkinfo)

   The constructor is not normally used by the user code.

   **Parameters:**

   * `id` (int): event id.
   * `linkinfo` (`wx.html.HtmlLinkInfo <../html/wx.html.HtmlLinkInfo.html>`_)

   |

   **Returns:**

   `wx.html.HtmlLinkEvent <wx.html.HtmlLinkEvent.html>`_ 

--------

.. method:: GetLinkInfo()

   Returns the `wx.html.HtmlLinkInfo <../html/wx.html.HtmlLinkInfo.html>`_ which contains info about the cell clicked and the hyperlink it contains.

   |  

   **Returns:**

   `wx.html.HtmlLinkInfo <../html/wx.html.HtmlLinkInfo.html>`_