1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.html.HtmlLinkEvent:
==========================================================================================================================================
|phoenix_title| **wx.html.HtmlLinkEvent**
==========================================================================================================================================
This event class is used for the events generated by :ref:`wx.html.HtmlWindow`.
.. _HtmlLinkEvent-events:
|events| Events Emitted by this Class
=====================================
Handlers bound for the following event types will receive a :ref:`wx.html.HtmlLinkEvent` parameter.
Event macros:
- EVT_HTML_LINK_CLICKED: User clicked on an hyperlink.
|
|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>HtmlLinkEvent</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.html.HtmlLinkEvent_inheritance.png" alt="Inheritance diagram of HtmlLinkEvent" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Event.html" title="wx.Event" alt="" coords="49,83,127,112"/> <area shape="rect" id="node3" href="wx.CommandEvent.html" title="wx.CommandEvent" alt="" coords="15,160,160,189"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="47,5,128,35"/> <area shape="rect" id="node4" href="wx.html.HtmlLinkEvent.html" title="wx.html.HtmlLinkEvent" alt="" coords="5,237,171,267"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.html.HtmlLinkEvent.__init__` The constructor is not normally used by the user code.
:meth:`~wx.html.HtmlLinkEvent.GetLinkInfo` Returns the :ref:`wx.html.HtmlLinkInfo` which contains info about the cell clicked and the hyperlink it contains.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.html.HtmlLinkEvent.LinkInfo` See :meth:`~wx.html.HtmlLinkEvent.GetLinkInfo`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.html.HtmlLinkEvent(CommandEvent)
**Possible constructors**::
HtmlLinkEvent(id, linkinfo)
This event class is used for the events generated by HtmlWindow.
.. method:: __init__(self, id, linkinfo)
The constructor is not normally used by the user code.
:param `id`:
:type `id`: int
:param `linkinfo`:
:type `linkinfo`: wx.html.HtmlLinkInfo
.. method:: GetLinkInfo(self)
Returns the :ref:`wx.html.HtmlLinkInfo` which contains info about the cell clicked and the hyperlink it contains.
:rtype: :ref:`wx.html.HtmlLinkInfo`
.. attribute:: LinkInfo
See :meth:`~wx.html.HtmlLinkEvent.GetLinkInfo`
|