doc/html/api/lxml.etree.ElementTextIterator-class.html

   1 <?xml version="1.0" encoding="ascii"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   3           "DTD/xhtml1-transitional.dtd">
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   5 <head>
   6   <title>lxml.etree.ElementTextIterator</title>
   7   <link rel="stylesheet" href="epydoc.css" type="text/css" />
   8   <script type="text/javascript" src="epydoc.js"></script>
   9 </head>
  10
  11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
  12       alink="#204080">
  13 <!-- ==================== NAVIGATION BAR ==================== -->
  14 <table class="navbar" border="0" width="100%" cellpadding="0"
  15        bgcolor="#a0c0ff" cellspacing="0">
  16   <tr valign="middle">
  17   <!-- Home link -->
  18       <th>&nbsp;&nbsp;&nbsp;<a
  19         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
  20
  21   <!-- Tree link -->
  22       <th>&nbsp;&nbsp;&nbsp;<a
  23         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
  24
  25   <!-- Index link -->
  26       <th>&nbsp;&nbsp;&nbsp;<a
  27         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
  28
  29   <!-- Help link -->
  30       <th>&nbsp;&nbsp;&nbsp;<a
  31         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
  32
  33   <!-- Project homepage -->
  34       <th class="navbar" align="right" width="100%">
  35         <table border="0" cellpadding="0" cellspacing="0">
  36           <tr><th class="navbar" align="center"
  37             ><a class="navbar" target="_top" href="http://codespeak.net/lxml/">lxml API</a></th>
  38           </tr></table></th>
  39   </tr>
  40 </table>
  41 <table width="100%" cellpadding="0" cellspacing="0">
  42   <tr valign="top">
  43     <td width="100%">
  44       <span class="breadcrumbs">
  45         <a href="lxml-module.html">Package&nbsp;lxml</a> ::
  46         <a href="lxml.etree-module.html">Module&nbsp;etree</a> ::
  47         Class&nbsp;ElementTextIterator
  48       </span>
  49     </td>
  50     <td>
  51       <table cellpadding="0" cellspacing="0">
  52         <!-- hide/show private -->
  53         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
  54     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
  55         <tr><td align="right"><span class="options"
  56             >[<a href="frames.html" target="_top">frames</a
  57             >]&nbsp;|&nbsp;<a href="lxml.etree.ElementTextIterator-class.html"
  58             target="_top">no&nbsp;frames</a>]</span></td></tr>
  59       </table>
  60     </td>
  61   </tr>
  62 </table>
  63 <!-- ==================== CLASS DESCRIPTION ==================== -->
  64 <h1 class="epydoc">Class ElementTextIterator</h1><p class="nomargin-top"></p>
  65 <pre class="base-tree">
  66 object --+
  67          |
  68         <strong class="uidshort">ElementTextIterator</strong>
  69 </pre>
  70
  71 <hr />
  72 <p>ElementTextIterator(self, element, tag=None, with_tail=True)
  73 Iterates over the text content of a subtree.</p>
  74 <p>You can pass the <tt class="rst-docutils literal"><span class="pre">tag</span></tt> keyword argument to restrict text content to a
  75 specific tag name.</p>
  76 <p>You can set the <tt class="rst-docutils literal"><span class="pre">with_tail</span></tt> keyword argument to <tt class="rst-docutils literal"><span class="pre">False</span></tt> to skip over
  77 tail text.</p>
  78
  79 <!-- ==================== INSTANCE METHODS ==================== -->
  80 <a name="section-InstanceMethods"></a>
  81 <table class="summary" border="1" cellpadding="3"
  82        cellspacing="0" width="100%" bgcolor="white">
  83 <tr bgcolor="#70b0f0" class="table-header">
  84   <td colspan="2" class="table-header">
  85     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  86       <tr valign="top">
  87         <td align="left"><span class="table-header">Instance Methods</span></td>
  88         <td align="right" valign="top"
  89          ><span class="options">[<a href="#section-InstanceMethods"
  90          class="privatelink" onclick="toggle_private();"
  91          >hide private</a>]</span></td>
  92       </tr>
  93     </table>
  94   </td>
  95 </tr>
  96 <tr>
  97     <td width="15%" align="right" valign="top" class="summary">
  98       <span class="summary-type">&nbsp;</span>
  99     </td><td class="summary">
 100       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 101         <tr>
 102           <td><span class="summary-sig"><a href="lxml.etree.ElementTextIterator-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
 103         <span class="summary-sig-arg">element</span>,
 104         <span class="summary-sig-arg">tag</span>=<span class="summary-sig-default">None</span>,
 105         <span class="summary-sig-arg">with_tail</span>=<span class="summary-sig-default">True</span>)</span><br />
 106       x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
 107           <td align="right" valign="top">
 108
 109
 110           </td>
 111         </tr>
 112       </table>
 113
 114     </td>
 115   </tr>
 116 <tr>
 117     <td width="15%" align="right" valign="top" class="summary">
 118       <span class="summary-type">&nbsp;</span>
 119     </td><td class="summary">
 120       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 121         <tr>
 122           <td><span class="summary-sig"><a name="__iter__"></a><span class="summary-sig-name">__iter__</span>(<span class="summary-sig-arg">...</span>)</span></td>
 123           <td align="right" valign="top">
 124
 125
 126           </td>
 127         </tr>
 128       </table>
 129
 130     </td>
 131   </tr>
 132 <tr>
 133     <td width="15%" align="right" valign="top" class="summary">
 134       <span class="summary-type">a new object with type S, a subtype of T</span>
 135     </td><td class="summary">
 136       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 137         <tr>
 138           <td><span class="summary-sig"><a href="lxml.etree.ElementTextIterator-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
 139         <span class="summary-sig-arg">S</span>,
 140         <span class="summary-sig-arg">...</span>)</span></td>
 141           <td align="right" valign="top">
 142
 143
 144           </td>
 145         </tr>
 146       </table>
 147
 148     </td>
 149   </tr>
 150 <tr>
 151     <td width="15%" align="right" valign="top" class="summary">
 152       <span class="summary-type">&nbsp;</span>
 153     </td><td class="summary">
 154       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 155         <tr>
 156           <td><span class="summary-sig"><a name="__next__"></a><span class="summary-sig-name">__next__</span>(<span class="summary-sig-arg">...</span>)</span></td>
 157           <td align="right" valign="top">
 158
 159
 160           </td>
 161         </tr>
 162       </table>
 163
 164     </td>
 165   </tr>
 166 <tr>
 167     <td width="15%" align="right" valign="top" class="summary">
 168       <span class="summary-type">the next value, or raise StopIteration</span>
 169     </td><td class="summary">
 170       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 171         <tr>
 172           <td><span class="summary-sig"><a name="next"></a><span class="summary-sig-name">next</span>(<span class="summary-sig-arg">x</span>)</span></td>
 173           <td align="right" valign="top">
 174
 175
 176           </td>
 177         </tr>
 178       </table>
 179
 180     </td>
 181   </tr>
 182   <tr>
 183     <td colspan="2" class="summary">
 184     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 185       <code>__delattr__</code>,
 186       <code>__getattribute__</code>,
 187       <code>__hash__</code>,
 188       <code>__reduce__</code>,
 189       <code>__reduce_ex__</code>,
 190       <code>__repr__</code>,
 191       <code>__setattr__</code>,
 192       <code>__str__</code>
 193       </p>
 194     </td>
 195   </tr>
 196 </table>
 197 <!-- ==================== PROPERTIES ==================== -->
 198 <a name="section-Properties"></a>
 199 <table class="summary" border="1" cellpadding="3"
 200        cellspacing="0" width="100%" bgcolor="white">
 201 <tr bgcolor="#70b0f0" class="table-header">
 202   <td colspan="2" class="table-header">
 203     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 204       <tr valign="top">
 205         <td align="left"><span class="table-header">Properties</span></td>
 206         <td align="right" valign="top"
 207          ><span class="options">[<a href="#section-Properties"
 208          class="privatelink" onclick="toggle_private();"
 209          >hide private</a>]</span></td>
 210       </tr>
 211     </table>
 212   </td>
 213 </tr>
 214   <tr>
 215     <td colspan="2" class="summary">
 216     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 217       <code>__class__</code>
 218       </p>
 219     </td>
 220   </tr>
 221 </table>
 222 <!-- ==================== METHOD DETAILS ==================== -->
 223 <a name="section-MethodDetails"></a>
 224 <table class="details" border="1" cellpadding="3"
 225        cellspacing="0" width="100%" bgcolor="white">
 226 <tr bgcolor="#70b0f0" class="table-header">
 227   <td colspan="2" class="table-header">
 228     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 229       <tr valign="top">
 230         <td align="left"><span class="table-header">Method Details</span></td>
 231         <td align="right" valign="top"
 232          ><span class="options">[<a href="#section-MethodDetails"
 233          class="privatelink" onclick="toggle_private();"
 234          >hide private</a>]</span></td>
 235       </tr>
 236     </table>
 237   </td>
 238 </tr>
 239 </table>
 240 <a name="__init__"></a>
 241 <div>
 242 <table class="details" border="1" cellpadding="3"
 243        cellspacing="0" width="100%" bgcolor="white">
 244 <tr><td>
 245   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 246   <tr valign="top"><td>
 247   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
 248         <span class="sig-arg">element</span>,
 249         <span class="sig-arg">tag</span>=<span class="sig-default">None</span>,
 250         <span class="sig-arg">with_tail</span>=<span class="sig-default">True</span>)</span>
 251     <br /><em class="fname">(Constructor)</em>
 252   </h3>
 253   </td><td align="right" valign="top"
 254     >&nbsp;
 255     </td>
 256   </tr></table>
 257
 258   x.__init__(...) initializes x; see x.__class__.__doc__ for signature
 259   <dl class="fields">
 260     <dt>Overrides:
 261         object.__init__
 262     </dt>
 263   </dl>
 264 </td></tr></table>
 265 </div>
 266 <a name="__new__"></a>
 267 <div>
 268 <table class="details" border="1" cellpadding="3"
 269        cellspacing="0" width="100%" bgcolor="white">
 270 <tr><td>
 271   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 272   <tr valign="top"><td>
 273   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 274         <span class="sig-arg">S</span>,
 275         <span class="sig-arg">...</span>)</span>
 276   </h3>
 277   </td><td align="right" valign="top"
 278     >&nbsp;
 279     </td>
 280   </tr></table>
 281
 282
 283   <dl class="fields">
 284     <dt>Returns: a new object with type S, a subtype of T</dt>
 285     <dt>Overrides:
 286         object.__new__
 287     </dt>
 288   </dl>
 289 </td></tr></table>
 290 </div>
 291 <br />
 292 <!-- ==================== NAVIGATION BAR ==================== -->
 293 <table class="navbar" border="0" width="100%" cellpadding="0"
 294        bgcolor="#a0c0ff" cellspacing="0">
 295   <tr valign="middle">
 296   <!-- Home link -->
 297       <th>&nbsp;&nbsp;&nbsp;<a
 298         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 299
 300   <!-- Tree link -->
 301       <th>&nbsp;&nbsp;&nbsp;<a
 302         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 303
 304   <!-- Index link -->
 305       <th>&nbsp;&nbsp;&nbsp;<a
 306         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 307
 308   <!-- Help link -->
 309       <th>&nbsp;&nbsp;&nbsp;<a
 310         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 311
 312   <!-- Project homepage -->
 313       <th class="navbar" align="right" width="100%">
 314         <table border="0" cellpadding="0" cellspacing="0">
 315           <tr><th class="navbar" align="center"
 316             ><a class="navbar" target="_top" href="http://codespeak.net/lxml/">lxml API</a></th>
 317           </tr></table></th>
 318   </tr>
 319 </table>
 320 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 321   <tr>
 322     <td align="left" class="footer">
 323     Generated by Epydoc 3.0 on Fri Oct 30 14:51:45 2009
 324     </td>
 325     <td align="right" class="footer">
 326       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 327         >http://epydoc.sourceforge.net</a>
 328     </td>
 329   </tr>
 330 </table>
 331
 332 <script type="text/javascript">
 333   <!--
 334   // Private objects are initially displayed (because if
 335   // javascript is turned off then we want them to be
 336   // visible); but by default, we want to hide them.  So hide
 337   // them unless we have a cookie that says to show them.
 338   checkCookie();
 339   // -->
 340 </script>
 341 </body>
 342 </html>