********************
wx.html.HtmlLinkInfo
********************

Inheritance diagram for `wx.html.HtmlLinkInfo`:

|

.. inheritance-diagram:: wx.html.HtmlLinkInfo

|

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

This class stores all necessary information about hypertext links (as represented by ``<A>`` tag in HTML documents). 

In current implementation it stores URL and target frame name.  

.. note:: Note that frames are not currently supported by wxHTML!


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

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


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

* `__init__ <#__init__>`_ 
* `GetEvent <#GetEvent>`_ 
* `GetHref <#GetHref>`_ 
* `GetHtmlCell <#GetHtmlCell>`_ 
* `GetTarget <#GetTarget>`_ 
* `SetEvent <#SetEvent>`_ 
* `SetHtmlCell <#SetHtmlCell>`_ 

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

* `Event <#Event>`_ 
* `Href <#Href>`_ 
* `HtmlCell <#HtmlCell>`_ 
* `Target <#Target>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(href, target="")

   Construct hypertext link from `href` (aka URL) and `target` (name of target frame).
   
   **Parameters:**

   * `href` (string)
   * `target` (string)

   |

   **Returns:**

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

--------

.. method:: GetEvent()

   Return pointer to event that generated OnLinkClicked event. 

   Valid only within `wx.html.HtmlWindow.OnLinkClicked <wx.html.HtmlWindow.html#OnLinkClicked>`_, ``None`` otherwise.

   |  

   **Returns:**

   `wx.MouseEvent <../Events/wx.MouseEvent.html>`_
 

--------

.. method:: GetHref()

   Return *HREF* value of the ``<A>`` tag.

   |  

   **Returns:**

   `string` 

--------

.. method:: GetHtmlCell()

   Return pointer to the cell that was clicked. 

   Valid only within `wx.html.HtmlWindow.OnLinkClicked <wx.html.HtmlWindow.html#OnLinkClicked>`_, ``None`` otherwise.

   |  

   **Returns:**

   `wx.html.HtmlCell <wx.html.HtmlCell.html>`_
 

--------

.. method:: GetTarget()

   Return *TARGET* value of the ``<A>`` tag (this value is used to specify in which frame should be the page pointed by `Href <#Href>`_ opened).

   |  

   **Returns:**

   `string` 

--------

.. method:: SetEvent(e)

   |

   **Parameters:**

   * `e` (`wx.MouseEvent <../Events/wx.MouseEvent.html>`_)

--------

.. method:: SetHtmlCell(e)

   |
   
   **Parameters:**

   * `e` (`wx.html.HtmlCell <wx.html.HtmlCell.html>`_)

--------

Properties
^^^^^^^^^^


.. attribute:: Event

   See `GetEvent <#GetEvent>`_ and `SetEvent <#SetEvent>`_

.. attribute:: Href

   See `GetHref <#GetHref>`_

.. attribute:: HtmlCell

   See `GetHtmlCell <#GetHtmlCell>`_ and `SetHtmlCell <#SetHtmlCell>`_

.. attribute:: Target

   See `GetTarget <#GetTarget>`_