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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
|
.. 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.HtmlTagHandler:
==========================================================================================================================================
|phoenix_title| **wx.html.HtmlTagHandler**
==========================================================================================================================================
.. seealso:: :ref:`Tag Handlers <tag handlers>`, :ref:`wx.html.HtmlTag`
.. todo:: describe me
|
|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>HtmlTagHandler</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.HtmlTagHandler_inheritance.png" alt="Inheritance diagram of HtmlTagHandler" 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.Object.html" title="wx.Object" alt="" coords="52,5,133,35"/> <area shape="rect" id="node2" href="wx.html.HtmlTagHandler.html" title="wx.html.HtmlTagHandler" alt="" coords="5,83,181,112"/> </map>
</p>
|
|sub_classes| Known Subclasses
==============================
:ref:`wx.html.HtmlWinTagHandler`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.html.HtmlTagHandler.__init__` Constructor.
:meth:`~wx.html.HtmlTagHandler.GetParser` Returns the parser associated with this tag handler.
:meth:`~wx.html.HtmlTagHandler.GetSupportedTags` Returns list of supported tags.
:meth:`~wx.html.HtmlTagHandler.HandleTag` This is the core method of each handler.
:meth:`~wx.html.HtmlTagHandler.ParseInner` This method calls parser's :meth:`wx.html.HtmlParser.DoParsing` method for the string between this tag and the paired ending tag
:meth:`~wx.html.HtmlTagHandler.ParseInnerSource` Parses given source as if it was tag's inner code (see `HtmlParser.GetInnerSource).`
:meth:`~wx.html.HtmlTagHandler.SetParser` Assigns `parser` to this handler.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.html.HtmlTagHandler.Parser` See :meth:`~wx.html.HtmlTagHandler.GetParser` and :meth:`~wx.html.HtmlTagHandler.SetParser`
:attr:`~wx.html.HtmlTagHandler.SupportedTags` See :meth:`~wx.html.HtmlTagHandler.GetSupportedTags`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.html.HtmlTagHandler(Object)
**Possible constructors**::
HtmlTagHandler()
.. method:: __init__(self)
Constructor.
.. method:: GetParser(self)
Returns the parser associated with this tag handler.
:rtype: :ref:`wx.html.HtmlParser`
.. versionadded:: 2.9.5
.. method:: GetSupportedTags(self)
Returns list of supported tags.
The list is in uppercase and tags are delimited by ','. Example: ``"I,B,FONT,P"``
:rtype: `string`
.. method:: HandleTag(self, tag)
This is the core method of each handler.
It is called each time one of supported tags is detected. `tag` contains all necessary info (see :ref:`wx.html.HtmlTag` for details).
Example:
::
def HandleTag(self, tag):
# change state of parser (e.g. set bold face)
self.ParseInner(tag)
# ...
# restore original state of parser
You shouldn't call :meth:`ParseInner` if the tag is not paired with an ending one.
:param `tag`:
:type `tag`: wx.html.HtmlTag
:rtype: `bool`
:returns:
``True`` if :meth:`ParseInner` was called, ``False`` otherwise.
.. method:: ParseInner(self, tag)
This method calls parser's :meth:`wx.html.HtmlParser.DoParsing` method for the string between this tag and the paired ending tag:
.. code-block:: html
<A HREF="x.htm">Hello, world!</A>
In this example, a call to :meth:`ParseInner` (with `tag` pointing to A tag) will parse 'Hello, world!'.
:param `tag`:
:type `tag`: wx.html.HtmlTag
.. method:: ParseInnerSource(self, source)
Parses given source as if it was tag's inner code (see `HtmlParser.GetInnerSource).`
Unlike :meth:`ParseInner` , this method lets you specify the source code to parse. This is useful when you need to modify the inner text before parsing.
:param `source`:
:type `source`: string
.. method:: SetParser(self, parser)
Assigns `parser` to this handler.
Each **instance** of handler is guaranteed to be called only from the one parser.
:param `parser`:
:type `parser`: wx.html.HtmlParser
.. attribute:: Parser
See :meth:`~wx.html.HtmlTagHandler.GetParser` and :meth:`~wx.html.HtmlTagHandler.SetParser`
.. attribute:: SupportedTags
See :meth:`~wx.html.HtmlTagHandler.GetSupportedTags`
|
