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
|
<?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.NodeFilter</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>NodeFilter Class Reference</h1>
<code>from PyKDE4.khtml import *</code>
<p>
Namespace: <a href="../khtml/DOM.html">DOM</a><br />
<h2>Detailed Description</h2>
<p>Filters are objects that know how to "filter out" nodes. If an
Iterator or TreeWalker is given a filter, before it
returns the next node, it applies the filter. If the filter says to
accept the node, the Iterator returns it; otherwise, the Iterator
looks for the next node and pretends that the node that was
rejected was not there.
</p>
<p>
The DOM does not provide any filters. Filter is just an interface
that users can implement to provide their own filters.
</p>
<p>
Filters do not need to know how to iterate, nor do they need to
know anything about the data structure that is being iterated. This
makes it very easy to write filters, since the only thing they have
to know how to do is evaluate a single node. One filter may be used
with a number of different kinds of Iterators, encouraging code
reuse.
</p>
<p>
To create your own custom NodeFilter, define a subclass of
CustomNodeFilter which overrides the acceptNode() method and assign
an instance of it to the NodeFilter. For more details see the
CustomNodeFilter class
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#AcceptCode">AcceptCode</a> </td><td class="memItemRight" valign="bottom">{ FILTER_ACCEPT, FILTER_REJECT, FILTER_SKIP }</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#ShowCode">ShowCode</a> </td><td class="memItemRight" valign="bottom">{ SHOW_ALL, SHOW_ELEMENT, SHOW_ATTRIBUTE, SHOW_TEXT, SHOW_CDATA_SECTION, SHOW_ENTITY_REFERENCE, SHOW_ENTITY, SHOW_PROCESSING_INSTRUCTION, SHOW_COMMENT, SHOW_DOCUMENT, SHOW_DOCUMENT_TYPE, SHOW_DOCUMENT_FRAGMENT, SHOW_NOTATION }</td></tr>
<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="#NodeFilter">__init__</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#NodeFilter">__init__</a> (self, <a href="../khtml/DOM.NodeFilter.html">DOM.NodeFilter</a> other)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#acceptNode">acceptNode</a> (self, <a href="../khtml/DOM.Node.html">DOM.Node</a> n)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../khtml/DOM.CustomNodeFilter.html">DOM.CustomNodeFilter</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#customNodeFilter">customNodeFilter</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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setCustomNodeFilter">setCustomNodeFilter</a> (self, <a href="../khtml/DOM.CustomNodeFilter.html">DOM.CustomNodeFilter</a> custom)</td></tr>
<tr><td colspan="2"><br><h2>Static Methods</h2></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="#createCustom">createCustom</a> (<a href="../khtml/DOM.CustomNodeFilter.html">DOM.CustomNodeFilter</a> custom)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="NodeFilter"></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="NodeFilter"></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.NodeFilter.html">DOM.NodeFilter</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="acceptNode"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int acceptNode</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>n</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Test whether a specified node is visible in the logical view of
a TreeWalker or NodeIterator. This function will be called by
the implementation of TreeWalker and NodeIterator; it is not
intended to be called directly from user code.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>n</em> </td><td> The node to check to see if it passes the filter or
not.
</td></tr>
</table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> a constant to determine whether the node is accepted,
rejected, or skipped, as defined <a
href="#Traversal-NodeFilter-acceptNode-constants"> above </a> .
</dd></dl>
</p></div></div><a class="anchor" name="customNodeFilter"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../khtml/DOM.CustomNodeFilter.html">DOM.CustomNodeFilter</a> customNodeFilter</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="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="setCustomNodeFilter"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setCustomNodeFilter</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.CustomNodeFilter.html">DOM.CustomNodeFilter</a> </td>
<td class="paramname"><em>custom</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="createCustom"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../khtml/DOM.NodeFilter.html">DOM.NodeFilter</a> createCustom</td>
<td>(</td>
<td class="paramtype"><a href="../khtml/DOM.CustomNodeFilter.html">DOM.CustomNodeFilter</a> </td>
<td class="paramname"><em>custom</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="AcceptCode"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">AcceptCode</td>
</tr>
</table>
</div>
<div class="memdoc"><p>The following constants are returned by the acceptNode()
method:
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>FILTER_ACCEPT</em> = 1</td><td><tr><td valign="top"><em>FILTER_REJECT</em> = 2</td><td><tr><td valign="top"><em>FILTER_SKIP</em> = 3</td><td></table>
</dl>
</div></div><p><a class="anchor" name="ShowCode"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">ShowCode</td>
</tr>
</table>
</div>
<div class="memdoc"><p>These are the available values for the whatToShow parameter.
They are the same as the set of possible types for Node, and
their values are derived by using a bit position corresponding
to the value of NodeType for the equivalent node type.
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>SHOW_ALL</em> = 0xFFFFFFFF</td><td><tr><td valign="top"><em>SHOW_ELEMENT</em> = 0x00000001</td><td><tr><td valign="top"><em>SHOW_ATTRIBUTE</em> = 0x00000002</td><td><tr><td valign="top"><em>SHOW_TEXT</em> = 0x00000004</td><td><tr><td valign="top"><em>SHOW_CDATA_SECTION</em> = 0x00000008</td><td><tr><td valign="top"><em>SHOW_ENTITY_REFERENCE</em> = 0x00000010</td><td><tr><td valign="top"><em>SHOW_ENTITY</em> = 0x00000020</td><td><tr><td valign="top"><em>SHOW_PROCESSING_INSTRUCTION</em> = 0x00000040</td><td><tr><td valign="top"><em>SHOW_COMMENT</em> = 0x00000080</td><td><tr><td valign="top"><em>SHOW_DOCUMENT</em> = 0x00000100</td><td><tr><td valign="top"><em>SHOW_DOCUMENT_TYPE</em> = 0x00000200</td><td><tr><td valign="top"><em>SHOW_DOCUMENT_FRAGMENT</em> = 0x00000400</td><td><tr><td valign="top"><em>SHOW_NOTATION</em> = 0x00000800</td><td></table>
</dl>
</div></div><p>
</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>
|
