.. include:: headings.inc



.. currentmodule:: adv



.. _adv.HyperlinkEvent:

==========================================================================================================================================
|phoenix_title|  **HyperlinkEvent**
==========================================================================================================================================

This event class is used for the events generated by :ref:`adv.HyperlinkCtrl`.          





.. _HyperlinkEvent-events:

|events| Events Emitted by this Class
=====================================

Handlers bound for the following event types will receive a :ref:`adv.HyperlinkEvent` parameter.

- EVT_HYPERLINK: User clicked on an hyperlink.  










|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **HyperlinkEvent**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/adv.HyperlinkEvent_inheritance.png" alt="Inheritance diagram of HyperlinkEvent" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="Event.html" title="An event is a structure holding information about an event passed to a callback or member function." alt="" coords="125,5,197,35"/> <area shape="rect" id="node4" href="CommandEvent.html" title="This event class contains information about command events, which originate from a variety of simple controls." alt="" coords="247,5,359,35"/> <area shape="rect" id="node2" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="5,5,77,35"/> <area shape="rect" id="node6" href="adv.HyperlinkEvent.html" title="This event class is used for the events generated by adv.HyperlinkCtrl." alt="" coords="409,5,516,35"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~HyperlinkEvent.__init__`                                                 The constructor is not normally used by the user code.
:meth:`~HyperlinkEvent.GetURL`                                                   Returns the ``URL`` of the hyperlink where the user has just clicked.
:meth:`~HyperlinkEvent.SetURL`                                                   Sets the ``URL`` associated with the event.
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~HyperlinkEvent.URL`                                                      See :meth:`~HyperlinkEvent.GetURL` and :meth:`~HyperlinkEvent.SetURL`
================================================================================ ================================================================================


|


|api| Class API
===============
   

.. class:: HyperlinkEvent(CommandEvent)

   This event class is used for the events generated by HyperlinkCtrl.
   
   **Possible constructors**::

       HyperlinkEvent(generator, id, url)
       



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

      The constructor is not normally used by the user code.                  


      :param `generator`: 
      :type `generator`: Object
      :param `id`: 
      :type `id`: int
      :param `url`: 
      :type `url`: string







   .. method:: GetURL(self)

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

      :rtype: `string`








   .. method:: SetURL(self, url)

      Sets the ``URL`` associated with the event.                  


      :param `url`: 
      :type `url`: string







   .. attribute:: URL

      See :meth:`~HyperlinkEvent.GetURL` and :meth:`~HyperlinkEvent.SetURL`