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="/">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">tag</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">with_tail</tt> keyword argument to <tt class="rst-docutils literal">False</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 name="__iter__"></a><span class="summary-sig-name">__iter__</span>(<span class="summary-sig-arg">x</span>)</span><br />
 103       iter(x)</td>
 104           <td align="right" valign="top">
 105
 106
 107           </td>
 108         </tr>
 109       </table>
 110
 111     </td>
 112   </tr>
 113 <tr>
 114     <td width="15%" align="right" valign="top" class="summary">
 115       <span class="summary-type">a new object with type S, a subtype of T</span>
 116     </td><td class="summary">
 117       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 118         <tr>
 119           <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>,
 120         <span class="summary-sig-arg">S</span>,
 121         <span class="summary-sig-arg">...</span>)</span></td>
 122           <td align="right" valign="top">
 123
 124
 125           </td>
 126         </tr>
 127       </table>
 128
 129     </td>
 130   </tr>
 131 <tr>
 132     <td width="15%" align="right" valign="top" class="summary">
 133       <span class="summary-type">&nbsp;</span>
 134     </td><td class="summary">
 135       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 136         <tr>
 137           <td><span class="summary-sig"><a name="__next__"></a><span class="summary-sig-name">__next__</span>(<span class="summary-sig-arg">...</span>)</span></td>
 138           <td align="right" valign="top">
 139
 140
 141           </td>
 142         </tr>
 143       </table>
 144
 145     </td>
 146   </tr>
 147 <tr>
 148     <td width="15%" align="right" valign="top" class="summary">
 149       <span class="summary-type">the next value, or raise StopIteration</span>
 150     </td><td class="summary">
 151       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 152         <tr>
 153           <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>
 154           <td align="right" valign="top">
 155
 156
 157           </td>
 158         </tr>
 159       </table>
 160
 161     </td>
 162   </tr>
 163   <tr>
 164     <td colspan="2" class="summary">
 165     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 166       <code>__delattr__</code>,
 167       <code>__format__</code>,
 168       <code>__getattribute__</code>,
 169       <code>__hash__</code>,
 170       <code>__init__</code>,
 171       <code>__reduce__</code>,
 172       <code>__reduce_ex__</code>,
 173       <code>__repr__</code>,
 174       <code>__setattr__</code>,
 175       <code>__sizeof__</code>,
 176       <code>__str__</code>,
 177       <code>__subclasshook__</code>
 178       </p>
 179     </td>
 180   </tr>
 181 </table>
 182 <!-- ==================== PROPERTIES ==================== -->
 183 <a name="section-Properties"></a>
 184 <table class="summary" border="1" cellpadding="3"
 185        cellspacing="0" width="100%" bgcolor="white">
 186 <tr bgcolor="#70b0f0" class="table-header">
 187   <td colspan="2" class="table-header">
 188     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 189       <tr valign="top">
 190         <td align="left"><span class="table-header">Properties</span></td>
 191         <td align="right" valign="top"
 192          ><span class="options">[<a href="#section-Properties"
 193          class="privatelink" onclick="toggle_private();"
 194          >hide private</a>]</span></td>
 195       </tr>
 196     </table>
 197   </td>
 198 </tr>
 199   <tr>
 200     <td colspan="2" class="summary">
 201     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 202       <code>__class__</code>
 203       </p>
 204     </td>
 205   </tr>
 206 </table>
 207 <!-- ==================== METHOD DETAILS ==================== -->
 208 <a name="section-MethodDetails"></a>
 209 <table class="details" border="1" cellpadding="3"
 210        cellspacing="0" width="100%" bgcolor="white">
 211 <tr bgcolor="#70b0f0" class="table-header">
 212   <td colspan="2" class="table-header">
 213     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 214       <tr valign="top">
 215         <td align="left"><span class="table-header">Method Details</span></td>
 216         <td align="right" valign="top"
 217          ><span class="options">[<a href="#section-MethodDetails"
 218          class="privatelink" onclick="toggle_private();"
 219          >hide private</a>]</span></td>
 220       </tr>
 221     </table>
 222   </td>
 223 </tr>
 224 </table>
 225 <a name="__new__"></a>
 226 <div>
 227 <table class="details" border="1" cellpadding="3"
 228        cellspacing="0" width="100%" bgcolor="white">
 229 <tr><td>
 230   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 231   <tr valign="top"><td>
 232   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 233         <span class="sig-arg">S</span>,
 234         <span class="sig-arg">...</span>)</span>
 235   </h3>
 236   </td><td align="right" valign="top"
 237     >&nbsp;
 238     </td>
 239   </tr></table>
 240
 241
 242   <dl class="fields">
 243     <dt>Returns: a new object with type S, a subtype of T</dt>
 244     <dt>Overrides:
 245         object.__new__
 246     </dt>
 247   </dl>
 248 </td></tr></table>
 249 </div>
 250 <br />
 251 <!-- ==================== NAVIGATION BAR ==================== -->
 252 <table class="navbar" border="0" width="100%" cellpadding="0"
 253        bgcolor="#a0c0ff" cellspacing="0">
 254   <tr valign="middle">
 255   <!-- Home link -->
 256       <th>&nbsp;&nbsp;&nbsp;<a
 257         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 258
 259   <!-- Tree link -->
 260       <th>&nbsp;&nbsp;&nbsp;<a
 261         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 262
 263   <!-- Index link -->
 264       <th>&nbsp;&nbsp;&nbsp;<a
 265         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 266
 267   <!-- Help link -->
 268       <th>&nbsp;&nbsp;&nbsp;<a
 269         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 270
 271   <!-- Project homepage -->
 272       <th class="navbar" align="right" width="100%">
 273         <table border="0" cellpadding="0" cellspacing="0">
 274           <tr><th class="navbar" align="center"
 275             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 276           </tr></table></th>
 277   </tr>
 278 </table>
 279 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 280   <tr>
 281     <td align="left" class="footer">
 282     Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:18 2012
 283     </td>
 284     <td align="right" class="footer">
 285       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 286         >http://epydoc.sourceforge.net</a>
 287     </td>
 288   </tr>
 289 </table>
 290
 291 <script type="text/javascript">
 292   <!--
 293   // Private objects are initially displayed (because if
 294   // javascript is turned off then we want them to be
 295   // visible); but by default, we want to hide them.  So hide
 296   // them unless we have a cookie that says to show them.
 297   checkCookie();
 298   // -->
 299 </script>
 300 </body>
 301 </html>