.. 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.adv.HyperlinkCtrl:

==========================================================================================================================================
|phoenix_title|  **wx.adv.HyperlinkCtrl**
==========================================================================================================================================

This class shows a static text element which links to an URL. 
         

Appearance and behaviour is completely customizable. 

In fact, when the user clicks on the hyperlink, a :ref:`wx.adv.HyperlinkEvent`  is sent but if that event is not handled (or it's skipped; see :meth:`wx.Event.Skip` ), then a call to `wx.LaunchDefaultBrowser`       is done with the hyperlink's URL. 

Note that standard :ref:`wx.Window`  functions like :meth:`wx.Window.SetBackgroundColour` , :meth:`wx.Window.SetFont` , :meth:`wx.Window.SetCursor` , :meth:`wx.Window.SetLabel`   can be used to customize appearance of the hyperlink. 





.. _HyperlinkCtrl-styles:

|styles| Window Styles
================================

This class supports the following styles: 

  

- ``wx.adv.HL_ALIGN_LEFT``: Align the text to the left.  
- ``wx.adv.HL_ALIGN_RIGHT``: Align the text to the right. This style is not supported under Windows.  
- ``wx.adv.HL_ALIGN_CENTRE``: Center the text (horizontally). This style is not supported under Windows.  
- ``wx.adv.HL_CONTEXTMENU``: Pop up a context menu when the hyperlink is right-clicked. The context menu contains a "Copy URL" menu item which is automatically handled by the hyperlink and which just copies in the clipboard the URL (not the label) of the control.  
- ``wx.adv.HL_DEFAULT_STYLE``: The default style for :ref:`wx.adv.HyperlinkCtrl`: BORDER_NONE|wxHL_CONTEXTMENU|wxHL_ALIGN_CENTRE.  








.. _HyperlinkCtrl-events:

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

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


- EVT_HYPERLINK: The hyperlink was (left) clicked. If this event is not handled in user's code (or it's skipped; see :meth:`wx.Event.Skip` ), then a call to LaunchDefaultBrowser is done with the hyperlink's URL.  

Currently this class is implemented using native support in wxGTK and wxMSW and a generic version is used by the other ports.









         



.. seealso:: URL, :ref:`wx.adv.HyperlinkEvent`    







|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>HyperlinkCtrl</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.adv.HyperlinkCtrl_inheritance.svg" alt="Inheritance diagram of HyperlinkCtrl" usemap="#dummy" class="inheritance"/></center>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.adv.HyperlinkCtrl.html" title="This class shows a static text element which links to an URL." alt="" coords="34,313,209,341"/> <area shape="rect" id="node2" href="wx.Control.html" title="This is the base class for a control or 'widget'." alt="" coords="69,236,174,265"/> <area shape="rect" id="node3" href="wx.Window.html" title="wx.Window  is the base class for all windows and represents any visible object on screen." alt="" coords="66,159,177,188"/> <area shape="rect" id="node4" href="wx.EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="55,82,188,111"/> <area shape="rect" id="node5" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="5,5,104,34"/> <area shape="rect" id="node6" href="wx.Trackable.html" title="Add-on base class for a trackable object." alt="" coords="128,5,251,34"/> </map> 
   </p>
   </div>

|


|appearance| Control Appearance
===============================

|

.. container:: control-appearance-figures

   .. figure:: _static/images/widgets/fullsize/wxmsw/wx.adv.hyperlinkctrl.png
      :alt: wxMSW
      :figclass: appearance-figure

      **wxMSW**


   .. figure:: _static/images/widgets/fullsize/wxmac/wx.adv.hyperlinkctrl.png
      :alt: wxMAC
      :figclass: appearance-figure

      **wxMAC**


   .. figure:: _static/images/widgets/fullsize/wxgtk/wx.adv.hyperlinkctrl.png
      :alt: wxGTK
      :figclass: appearance-figure

      **wxGTK**

|


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

================================================================================ ================================================================================
:meth:`~wx.adv.HyperlinkCtrl.__init__`                                           
:meth:`~wx.adv.HyperlinkCtrl.Create`                                             Creates the hyperlink control.
:meth:`~wx.adv.HyperlinkCtrl.GetClassDefaultAttributes`                          
:meth:`~wx.adv.HyperlinkCtrl.GetHoverColour`                                     Returns the colour used to print the label of the hyperlink when the mouse is over the control.
:meth:`~wx.adv.HyperlinkCtrl.GetNormalColour`                                    Returns the colour used to print the label when the link has never been clicked before (i.e. the link has not been `visited`) and the mouse is not over the control.
:meth:`~wx.adv.HyperlinkCtrl.GetURL`                                             Returns the URL associated with the hyperlink.
:meth:`~wx.adv.HyperlinkCtrl.GetVisited`                                         Returns ``True`` if the hyperlink has already been clicked by the user at least one time.
:meth:`~wx.adv.HyperlinkCtrl.GetVisitedColour`                                   Returns the colour used to print the label when the mouse is not over the control and the link has already been clicked before (i.e. the link has been `visited`).
:meth:`~wx.adv.HyperlinkCtrl.SetHoverColour`                                     Sets the colour used to print the label of the hyperlink when the mouse is over the control.
:meth:`~wx.adv.HyperlinkCtrl.SetNormalColour`                                    Sets the colour used to print the label when the link has never been clicked before (i.e. the link has not been `visited`) and the mouse is not over the control.
:meth:`~wx.adv.HyperlinkCtrl.SetURL`                                             Sets the URL associated with the hyperlink.
:meth:`~wx.adv.HyperlinkCtrl.SetVisited`                                         Marks the hyperlink as visited (see :meth:`wx.adv.HyperlinkCtrl.SetVisitedColour` ).
:meth:`~wx.adv.HyperlinkCtrl.SetVisitedColour`                                   Sets the colour used to print the label when the mouse is not over the control and the link has already been clicked before (i.e. the link has been `visited`).
================================================================================ ================================================================================


|


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

================================================================================ ================================================================================
:attr:`~wx.adv.HyperlinkCtrl.HoverColour`                                        See :meth:`~wx.adv.HyperlinkCtrl.GetHoverColour` and :meth:`~wx.adv.HyperlinkCtrl.SetHoverColour`
:attr:`~wx.adv.HyperlinkCtrl.NormalColour`                                       See :meth:`~wx.adv.HyperlinkCtrl.GetNormalColour` and :meth:`~wx.adv.HyperlinkCtrl.SetNormalColour`
:attr:`~wx.adv.HyperlinkCtrl.URL`                                                See :meth:`~wx.adv.HyperlinkCtrl.GetURL` and :meth:`~wx.adv.HyperlinkCtrl.SetURL`
:attr:`~wx.adv.HyperlinkCtrl.Visited`                                            See :meth:`~wx.adv.HyperlinkCtrl.GetVisited` and :meth:`~wx.adv.HyperlinkCtrl.SetVisited`
:attr:`~wx.adv.HyperlinkCtrl.VisitedColour`                                      See :meth:`~wx.adv.HyperlinkCtrl.GetVisitedColour` and :meth:`~wx.adv.HyperlinkCtrl.SetVisitedColour`
================================================================================ ================================================================================


|


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


.. class:: wx.adv.HyperlinkCtrl(Control)

   **Possible constructors**::

       HyperlinkCtrl() -> None
       
       HyperlinkCtrl(parent, id=ID_ANY, label='', url='', pos=DefaultPosition,
                     size=DefaultSize, style=HL_DEFAULT_STYLE, name=HyperlinkCtrlNameStr) ->
                     None
       
   
   This class shows a static text element which links to an URL.



   .. method:: __init__(self, *args, **kw)



      |overload| **Overloaded Implementations:**

      :html:`<hr class="overloadsep" /><br />`

      
      **__init__** `(self)`
      
      
      
      :rtype: `None`     
      
      
      
      
      
      
      
      :html:`<hr class="overloadsep" /><br />`

      
      **__init__** `(self, parent, id=ID_ANY, label='', url='', pos=DefaultPosition, size=DefaultSize, style=HL_DEFAULT_STYLE, name=HyperlinkCtrlNameStr)`
      
      Constructor. 
                       
      
      See :meth:`Create`   for more info. 
                       
      
      
      :param `parent`: 
      :type `parent`: wx.Window
      :param `id`: 
      :type `id`: wx.WindowID
      :param `label`: 
      :type `label`: string
      :param `url`: 
      :type `url`: string
      :param `pos`: 
      :type `pos`: wx.Point
      :param `size`: 
      :type `size`: wx.Size
      :param `style`: 
      :type `style`: long
      :param `name`: 
      :type `name`: string
      
      
      
      
      :rtype: `None`     
      
      
      
      
      
      
      
      :html:`<hr class="overloadsep" /><br />`






   .. method:: Create(self, parent, id=ID_ANY, label='', url='', pos=DefaultPosition, size=DefaultSize, style=HL_DEFAULT_STYLE, name=HyperlinkCtrlNameStr)

      Creates the hyperlink control. 
                 




      :param `parent`: Parent window. Must not be nullptr.   
      :type `parent`: wx.Window
      :param `id`: Window identifier. A value of ``wx.ID_ANY`` indicates a default value.   
      :type `id`: wx.WindowID
      :param `label`: The label of the hyperlink.   
      :type `label`: string
      :param `url`: The URL associated with the given label.   
      :type `url`: string
      :param `pos`: Window position.   
      :type `pos`: wx.Point
      :param `size`: Window size. If the DefaultSize is specified then the window is sized appropriately.   
      :type `size`: wx.Size
      :param `style`: Window style. See :ref:`wx.adv.HyperlinkCtrl`.   
      :type `style`: long
      :param `name`: Window name.   
      :type `name`: string




















      :rtype: `bool`




                  





   .. staticmethod:: GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)




      :param `variant`: 
      :type `variant`: wx.WindowVariant




      :rtype: `VisualAttributes`     








   .. method:: GetHoverColour(self)

      Returns the colour used to print the label of the hyperlink when the mouse is over the control. 
                 

      In native wxMSW version of this control hover colour is always the same as normal colour, i.e. the control doesn't change its appearance when the mouse hovers over it. 
                 

      :rtype: `Colour`     








   .. method:: GetNormalColour(self)

      Returns the colour used to print the label when the link has never been clicked before (i.e. the link has not been `visited`) and the mouse is not over the control. 
                 

      :rtype: `Colour`     








   .. method:: GetURL(self)

      Returns the URL associated with the hyperlink. 
                 

      :rtype: `str`








   .. method:: GetVisited(self)

      Returns ``True`` if the hyperlink has already been clicked by the user at least one time. 
                 

      :rtype: `bool`








   .. method:: GetVisitedColour(self)

      Returns the colour used to print the label when the mouse is not over the control and the link has already been clicked before (i.e. the link has been `visited`). 
                 

      :rtype: `Colour`     








   .. method:: SetHoverColour(self, colour)

      Sets the colour used to print the label of the hyperlink when the mouse is over the control. 
                 

      Changing this colour is not supported in the native wxMSW version. 
                 


      :param `colour`: 
      :type `colour`: wx.Colour




      :rtype: `None`     








   .. method:: SetNormalColour(self, colour)

      Sets the colour used to print the label when the link has never been clicked before (i.e. the link has not been `visited`) and the mouse is not over the control. 
                 


      :param `colour`: 
      :type `colour`: wx.Colour




      :rtype: `None`     








   .. method:: SetURL(self, url)

      Sets the URL associated with the hyperlink. 
                 


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




      :rtype: `None`     








   .. method:: SetVisited(self, visited=True)

      Marks the hyperlink as visited (see :meth:`wx.adv.HyperlinkCtrl.SetVisitedColour` ). 
                 


      :param `visited`: 
      :type `visited`: bool




      :rtype: `None`     








   .. method:: SetVisitedColour(self, colour)

      Sets the colour used to print the label when the mouse is not over the control and the link has already been clicked before (i.e. the link has been `visited`). 
                 


      :param `colour`: 
      :type `colour`: wx.Colour




      :rtype: `None`     








   .. attribute:: HoverColour

      See :meth:`~wx.adv.HyperlinkCtrl.GetHoverColour` and :meth:`~wx.adv.HyperlinkCtrl.SetHoverColour`


   .. attribute:: NormalColour

      See :meth:`~wx.adv.HyperlinkCtrl.GetNormalColour` and :meth:`~wx.adv.HyperlinkCtrl.SetNormalColour`


   .. attribute:: URL

      See :meth:`~wx.adv.HyperlinkCtrl.GetURL` and :meth:`~wx.adv.HyperlinkCtrl.SetURL`


   .. attribute:: Visited

      See :meth:`~wx.adv.HyperlinkCtrl.GetVisited` and :meth:`~wx.adv.HyperlinkCtrl.SetVisited`


   .. attribute:: VisitedColour

      See :meth:`~wx.adv.HyperlinkCtrl.GetVisitedColour` and :meth:`~wx.adv.HyperlinkCtrl.SetVisitedColour`

