Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > b77dda48f87d4eda8cc559e40c49a652 > files > 698

python-kde4-doc-4.4.5-0.2mdv2010.2.i586.rpm

<?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.4 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">&nbsp;</div>

<h1>NodeFilter Class Reference</h1>
<code>from PyKDE4.khtml import *</code>
<p>


Namespace: DOM.NodeFilter<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>&nbsp;</td><td class="memItemRight" valign="bottom">{&nbsp;FILTER_ACCEPT, FILTER_REJECT, FILTER_SKIP&nbsp;}</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#ShowCode">ShowCode</a>&nbsp;</td><td class="memItemRight" valign="bottom">{&nbsp;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&nbsp;}</td></tr>
<tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</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">&nbsp;</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">short&nbsp;</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.NodeFilter.html">DOM.NodeFilter</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#createCustom">createCustom</a> (self, <a href="../khtml/DOM.CustomNodeFilter.html">DOM.CustomNodeFilter</a> custom)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../khtml/DOM.CustomNodeFilter.html">DOM.CustomNodeFilter</a>&nbsp;</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&nbsp;</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">&nbsp;</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>
</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">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</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">&nbsp;<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>&nbsp;</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">short acceptNode</td>
<td>(</td>
<td class="paramtype">&nbsp;<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>&nbsp;</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>&nbsp;</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 &lt;a
href="#Traversal-NodeFilter-acceptNode-constants"&gt; above </a> .
</dd></dl>
</p></div></div><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">&nbsp;<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>&nbsp;</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><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">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</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">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</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">&nbsp;<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>&nbsp;</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>&nbsp;=&nbsp;1</td><td><tr><td valign="top"><em>FILTER_REJECT</em>&nbsp;=&nbsp;2</td><td><tr><td valign="top"><em>FILTER_SKIP</em>&nbsp;=&nbsp;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>&nbsp;=&nbsp;0xFFFFFFFF</td><td><tr><td valign="top"><em>SHOW_ELEMENT</em>&nbsp;=&nbsp;0x00000001</td><td><tr><td valign="top"><em>SHOW_ATTRIBUTE</em>&nbsp;=&nbsp;0x00000002</td><td><tr><td valign="top"><em>SHOW_TEXT</em>&nbsp;=&nbsp;0x00000004</td><td><tr><td valign="top"><em>SHOW_CDATA_SECTION</em>&nbsp;=&nbsp;0x00000008</td><td><tr><td valign="top"><em>SHOW_ENTITY_REFERENCE</em>&nbsp;=&nbsp;0x00000010</td><td><tr><td valign="top"><em>SHOW_ENTITY</em>&nbsp;=&nbsp;0x00000020</td><td><tr><td valign="top"><em>SHOW_PROCESSING_INSTRUCTION</em>&nbsp;=&nbsp;0x00000040</td><td><tr><td valign="top"><em>SHOW_COMMENT</em>&nbsp;=&nbsp;0x00000080</td><td><tr><td valign="top"><em>SHOW_DOCUMENT</em>&nbsp;=&nbsp;0x00000100</td><td><tr><td valign="top"><em>SHOW_DOCUMENT_TYPE</em>&nbsp;=&nbsp;0x00000200</td><td><tr><td valign="top"><em>SHOW_DOCUMENT_FRAGMENT</em>&nbsp;=&nbsp;0x00000400</td><td><tr><td valign="top"><em>SHOW_NOTATION</em>&nbsp;=&nbsp;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="&#109;&#97;&#105;&#108;&#116;&#111;&#58;simon&#64;simonzone&#46;com">Simon Edwards</a>.<br />
        KDE<sup>&#174;</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>&#174;</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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional