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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>DOM.TreeWalker</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
</head>
<body>
<div id="container">
<div id="header">
<div id="header_top">
<div>
<div>
<img alt ="" src="../common/top-kde.jpg"/>
KDE 4.9 PyKDE API Reference
</div>
</div>
</div>
<div id="header_bottom">
<div id="location">
<ul>
<li>KDE's Python API</li>
</ul>
</div>
<div id="menu">
<ul>
<li><a href="../modules.html">Overview</a></li>
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
<li><a href="http://kde.org/family/">Sitemap</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<div id="body_wrapper">
<div id="body">
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<h1>TreeWalker Class Reference</h1>
<code>from PyKDE4.khtml import *</code>
<p>
Namespace: <a href="../khtml/DOM.html">DOM</a><br />
<h2>Detailed Description</h2>
<p>TreeWalker objects are used to navigate a document
tree or subtree using the view of the document defined by its
whatToShow flags and any filters that are defined
for the TreeWalker . Any function which performs
navigation using a TreeWalker will automatically
support any view defined by a TreeWalker .
</p>
<p>
Omitting nodes from the logical view of a subtree can result in a
structure that is substantially different from the same subtree in
the complete, unfiltered document. Nodes that are siblings in the
TreeWalker view may be children of different, widely separated
nodes in the original view. For instance, consider a Filter that
skips all nodes except for Text nodes and the root node of a
document. In the logical view that results, all text nodes will be
siblings and appear as direct children of the root node, no matter
how deeply nested the structure of the original document.
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#TreeWalker">__init__</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#TreeWalker">__init__</a> (self, <a href="../khtml/DOM.TreeWalker.html">DOM.TreeWalker</a> other)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../khtml/DOM.Node.html">DOM.Node</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#currentNode">currentNode</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#expandEntityReferences">expandEntityReferences</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../khtml/DOM.NodeFilter.html">DOM.NodeFilter</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#filter">filter</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../khtml/DOM.Node.html">DOM.Node</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#firstChild">firstChild</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isNull">isNull</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../khtml/DOM.Node.html">DOM.Node</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#lastChild">lastChild</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../khtml/DOM.Node.html">DOM.Node</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#nextNode">nextNode</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../khtml/DOM.Node.html">DOM.Node</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#nextSibling">nextSibling</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../khtml/DOM.Node.html">DOM.Node</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#parentNode">parentNode</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../khtml/DOM.Node.html">DOM.Node</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#previousNode">previousNode</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../khtml/DOM.Node.html">DOM.Node</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#previousSibling">previousSibling</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../khtml/DOM.Node.html">DOM.Node</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#root">root</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setCurrentNode">setCurrentNode</a> (self, <a href="../khtml/DOM.Node.html">DOM.Node</a> _currentNode)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#whatToShow">whatToShow</a> (self)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="TreeWalker"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="TreeWalker"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../khtml/DOM.TreeWalker.html">DOM.TreeWalker</a> </td>
<td class="paramname"><em>other</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="currentNode"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../khtml/DOM.Node.html">DOM.Node</a> currentNode</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>The node at which the TreeWalker is currently positioned.
Alterations to the DOM tree may cause the current node to no longer be
accepted by the TreeWalker's associated filter. currentNode may also be
explicitly set to any node, whether or not it is within the subtree
specified by the root node or would be accepted by the filter and
whatToShow flags. Further traversal occurs relative to currentNode even
if it is not part of the current view, by applying the filters in the
requested direction; if no traversal is possible, currentNode is not changed.
</p>
<p>
DOMException
NOT_SUPPORTED_ERR: Raised if an attempt is made to set currentNode to null.
</p></div></div><a class="anchor" name="expandEntityReferences"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool expandEntityReferences</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>The value of this flag determines whether the children of entity
reference nodes are visible to the TreeWalker. If false, they and their
descendents will be rejected. Note that this rejection takes precedence
over whatToShow and the filter, if any.
</p>
<p>
To produce a view of the document that has entity references expanded
and does not expose the entity reference node itself, use the whatToShow
flags to hide the entity reference node and set expandEntityReferences
to true when creating the TreeWalker. To produce a view of the document
that has entity reference nodes but no entity expansion, use the
whatToShow flags to show the entity reference node and set
expandEntityReferences to false.
</p></div></div><a class="anchor" name="filter"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../khtml/DOM.NodeFilter.html">DOM.NodeFilter</a> filter</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>The filter used to screen nodes.
</p></div></div><a class="anchor" name="firstChild"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../khtml/DOM.Node.html">DOM.Node</a> firstChild</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Moves the TreeWalker to the first child of the
current node, and returns the new node. If the current node has
no children, returns null , and retains the
current node.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> The new node, or null if the current
node has no children.
</dd></dl> </p>
<p>
Exceptions from user code
Any exceptions raised by a user-written Filter will propagate
through.
</p></div></div><a class="anchor" name="isNull"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isNull</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="lastChild"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../khtml/DOM.Node.html">DOM.Node</a> lastChild</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Moves the TreeWalker to the last child of the
current node, and returns the new node. If the current node has
no children, returns null , and retains the
current node.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> The new node, or null if the current
node has no children.
</dd></dl> </p>
<p>
Exceptions from user code
Any exceptions raised by a user-written Filter will propagate
through.
</p></div></div><a class="anchor" name="nextNode"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../khtml/DOM.Node.html">DOM.Node</a> nextNode</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Moves the TreeWalker to the next node in
document order relative to the current node, and returns the
new node. If the current node has no next node, returns
null , and retains the current node.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> The new node, or null if the current
node has no next node.
</dd></dl> </p>
<p>
Exceptions from user code
Any exceptions raised by a user-written Filter will propagate
through.
</p></div></div><a class="anchor" name="nextSibling"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../khtml/DOM.Node.html">DOM.Node</a> nextSibling</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Moves the TreeWalker to the next sibling of the
current node, and returns the new node. If the current node has
no next sibling, returns null , and retains the
current node.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> The new node, or null if the current
node has no next sibling.
</dd></dl> </p>
<p>
Exceptions from user code
Any exceptions raised by a user-written Filter will propagate
through.
</p></div></div><a class="anchor" name="parentNode"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../khtml/DOM.Node.html">DOM.Node</a> parentNode</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Moves to and returns the parent node of the current node. If
there is no parent node, or if the current node is the root
node from which this TreeWalker was created, retains the
current position and returns null.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> The new parent node, or null if the current node has no
parent in the TreeWalker's logical view.
</dd></dl> </p>
<p>
Exceptions from user code
Any exceptions raised by a user-written Filter will propagate
through.
</p></div></div><a class="anchor" name="previousNode"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../khtml/DOM.Node.html">DOM.Node</a> previousNode</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Moves the TreeWalker to the previous node in
document order relative to the current node, and returns the
new node. If the current node has no previous node, returns
null , and retains the current node.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> The new node, or null if the current
node has no previous node.
</dd></dl> </p>
<p>
Exceptions from user code
Any exceptions raised by a user-written Filter will propagate
through.
</p></div></div><a class="anchor" name="previousSibling"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../khtml/DOM.Node.html">DOM.Node</a> previousSibling</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Moves the TreeWalker to the previous sibling of
the current node, and returns the new node. If the current node
has no previous sibling, returns null , and
retains the current node.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> The new node, or null if the current
node has no previous sibling.
</dd></dl> </p>
<p>
Exceptions from user code
Any exceptions raised by a user-written Filter will propagate
through.
</p></div></div><a class="anchor" name="root"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../khtml/DOM.Node.html">DOM.Node</a> root</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>The root node of the TreeWalker, as specified when it was created.
</p></div></div><a class="anchor" name="setCurrentNode"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setCurrentNode</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../khtml/DOM.Node.html">DOM.Node</a> </td>
<td class="paramname"><em>_currentNode</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>see currentNode
</p></div></div><a class="anchor" name="whatToShow"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">long whatToShow</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>This attribute determines which node types are presented via the
TreeWalker. The available set of constants is defined in the NodeFilter
interface. Nodes not accepted by whatToShow will be skipped, but their
children may still be considered. Note that this skip takes precedence
over the filter, if any.
</p></div></div>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<div class="nav_list">
<ul>
<li><a href="../allclasses.html">Full Index</a></li>
</ul>
</div>
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">Modules</h2>
</div></div>
<div class="nav_list">
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
<li><a href="../dnssd/index.html">dnssd</a></li>
<li><a href="../kdecore/index.html">kdecore</a></li>
<li><a href="../kdeui/index.html">kdeui</a></li>
<li><a href="../khtml/index.html">khtml</a></li>
<li><a href="../kio/index.html">kio</a></li>
<li><a href="../knewstuff/index.html">knewstuff</a></li>
<li><a href="../kparts/index.html">kparts</a></li>
<li><a href="../kutils/index.html">kutils</a></li>
<li><a href="../nepomuk/index.html">nepomuk</a></li>
<li><a href="../phonon/index.html">phonon</a></li>
<li><a href="../plasma/index.html">plasma</a></li>
<li><a href="../polkitqt/index.html">polkitqt</a></li>
<li><a href="../solid/index.html">solid</a></li>
<li><a href="../soprano/index.html">soprano</a></li>
</ul></div></div>
</div>
</div>
<div class="clearer"/>
</div>
<div id="end_body"></div>
</div>
<div id="footer"><div id="footer_text">
This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br />
KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div></div>
</body>
</html>
|
