*****************
wx.HyperlinkEvent
*****************

Inheritance diagram for `wx.HyperlinkEvent`:

|

.. inheritance-diagram:: wx.HyperlinkEvent

|

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

This event class is used for the events generated by `wx.HyperlinkCtrl <../Widgets/wx.HyperlinkCtrl.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_HYPERLINK(id, func)                          User clicked on an hyperlink.
==================================================  ==================================================  

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

* `__init__ <#__init__>`_ 
* `GetURL <#GetURL>`_ 
* `SetURL <#SetURL>`_ 

Properties Summary
^^^^^^^^^^^^^^^^^^

* `URL <#URL>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(generator, id, url)

   The constructor is not normally used by the user code.

   **Parameters:**

   * `generator` (`wx.Object <../Widgets/wx.Object.html>`_)
   * `id` (int)
   * `url` (string)

   |

   **Returns:**

   `wx.HyperlinkEvent <wx.HyperlinkEvent.html>`_
 

--------

.. method:: GetURL()

   Returns the URL of the hyperlink where the user has just clicked.

   |  

   **Returns:**

   `string` 

--------

.. method:: SetURL(url)

   Sets the URL associated with the event.

   **Parameters:**

   * `url` (string) 

--------

Properties
^^^^^^^^^^


.. attribute:: URL

   See `GetURL <#GetURL>`_ and `SetURL <#SetURL>`_