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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
.. 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.HtmlCellEvent:
==========================================================================================================================================
|phoenix_title| **wx.html.HtmlCellEvent**
==========================================================================================================================================
This event class is used for the events generated by :ref:`wx.html.HtmlWindow`.
.. _HtmlCellEvent-events:
|events| Events Emitted by this Class
=====================================
Handlers bound for the following event types will receive a :ref:`wx.html.HtmlCellEvent` parameter.
Event macros:
- EVT_HTML_CELL_HOVER: User moved the mouse over a :ref:`wx.html.HtmlCell`.
- EVT_HTML_CELL_CLICKED: User clicked on a :ref:`wx.html.HtmlCell`. When handling this event, remember to use `HtmlCell.SetLinkClicked(true)` if the cell contains a link.
|
|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>HtmlCellEvent</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.HtmlCellEvent_inheritance.png" alt="Inheritance diagram of HtmlCellEvent" 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="47,83,125,112"/> <area shape="rect" id="node3" href="wx.CommandEvent.html" title="wx.CommandEvent" alt="" coords="14,160,159,189"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="45,5,127,35"/> <area shape="rect" id="node4" href="wx.html.HtmlCellEvent.html" title="wx.html.HtmlCellEvent" alt="" coords="4,237,168,267"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.html.HtmlCellEvent.__init__` The constructor is not normally used by the user code.
:meth:`~wx.html.HtmlCellEvent.GetCell` Returns the :ref:`wx.html.HtmlCellEvent` associated with the event.
:meth:`~wx.html.HtmlCellEvent.GetLinkClicked` Returns ``True`` if SetLinkClicked(true) has previously been called; ``False`` otherwise.
:meth:`~wx.html.HtmlCellEvent.GetPoint` Returns the :ref:`wx.Point` associated with the event.
:meth:`~wx.html.HtmlCellEvent.SetLinkClicked` Call this function with `linkclicked` set to ``True`` if the cell which has been clicked contained a link or ``False`` otherwise (which is the default).
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.html.HtmlCellEvent.Cell` See :meth:`~wx.html.HtmlCellEvent.GetCell`
:attr:`~wx.html.HtmlCellEvent.LinkClicked` See :meth:`~wx.html.HtmlCellEvent.GetLinkClicked` and :meth:`~wx.html.HtmlCellEvent.SetLinkClicked`
:attr:`~wx.html.HtmlCellEvent.Point` See :meth:`~wx.html.HtmlCellEvent.GetPoint`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.html.HtmlCellEvent(CommandEvent)
**Possible constructors**::
HtmlCellEvent(commandType, id, cell, point, ev)
This event class is used for the events generated by HtmlWindow.
.. method:: __init__(self, commandType, id, cell, point, ev)
The constructor is not normally used by the user code.
:param `commandType`:
:type `commandType`: wx.EventType
:param `id`:
:type `id`: int
:param `cell`:
:type `cell`: wx.html.HtmlCell
:param `point`:
:type `point`: wx.Point
:param `ev`:
:type `ev`: wx.MouseEvent
.. method:: GetCell(self)
Returns the :ref:`wx.html.HtmlCellEvent` associated with the event.
:rtype: :ref:`wx.html.HtmlCell`
.. method:: GetLinkClicked(self)
Returns ``True`` if SetLinkClicked(true) has previously been called; ``False`` otherwise.
:rtype: `bool`
.. method:: GetPoint(self)
Returns the :ref:`wx.Point` associated with the event.
:rtype: :ref:`Point`
.. method:: SetLinkClicked(self, linkclicked)
Call this function with `linkclicked` set to ``True`` if the cell which has been clicked contained a link or ``False`` otherwise (which is the default).
With this function the event handler can return info to the :ref:`wx.html.HtmlWindow` which sent the event.
:param `linkclicked`:
:type `linkclicked`: bool
.. attribute:: Cell
See :meth:`~wx.html.HtmlCellEvent.GetCell`
.. attribute:: LinkClicked
See :meth:`~wx.html.HtmlCellEvent.GetLinkClicked` and :meth:`~wx.html.HtmlCellEvent.SetLinkClicked`
.. attribute:: Point
See :meth:`~wx.html.HtmlCellEvent.GetPoint`
|
