Imported Upstream version 2.3.5
[platform/upstream/python-lxml.git] / doc / html / api / lxml.etree._ElementIterator-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._ElementIterator</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;_ElementIterator
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._ElementIterator-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 _ElementIterator</h1><p class="nomargin-top"></p>
65 <pre class="base-tree">
66         object --+    
67                  |    
68 <a href="lxml.etree._ElementTagMatcher-class.html" onclick="show_private();">_ElementTagMatcher</a> --+
69                      |
70                     <strong class="uidshort">_ElementIterator</strong>
71 </pre>
72
73 <dl><dt>Known Subclasses:</dt>
74 <dd>
75       <ul class="subclass-list">
76 <li class="private"><a href="lxml.etree.AncestorsIterator-class.html" onclick="show_private();">AncestorsIterator</a></li><li class="private">, <a href="lxml.etree.ElementChildIterator-class.html" onclick="show_private();">ElementChildIterator</a></li><li class="private">, <a href="lxml.etree.SiblingsIterator-class.html" onclick="show_private();">SiblingsIterator</a></li>  </ul>
77 </dd></dl>
78
79 <hr />
80 <!-- ==================== INSTANCE METHODS ==================== -->
81 <a name="section-InstanceMethods"></a>
82 <table class="summary" border="1" cellpadding="3"
83        cellspacing="0" width="100%" bgcolor="white">
84 <tr bgcolor="#70b0f0" class="table-header">
85   <td colspan="2" class="table-header">
86     <table border="0" cellpadding="0" cellspacing="0" width="100%">
87       <tr valign="top">
88         <td align="left"><span class="table-header">Instance Methods</span></td>
89         <td align="right" valign="top"
90          ><span class="options">[<a href="#section-InstanceMethods"
91          class="privatelink" onclick="toggle_private();"
92          >hide private</a>]</span></td>
93       </tr>
94     </table>
95   </td>
96 </tr>
97 <tr>
98     <td width="15%" align="right" valign="top" class="summary">
99       <span class="summary-type">&nbsp;</span>
100     </td><td class="summary">
101       <table width="100%" cellpadding="0" cellspacing="0" border="0">
102         <tr>
103           <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 />
104       iter(x)</td>
105           <td align="right" valign="top">
106             
107             
108           </td>
109         </tr>
110       </table>
111       
112     </td>
113   </tr>
114 <tr>
115     <td width="15%" align="right" valign="top" class="summary">
116       <span class="summary-type">a new object with type S, a subtype of T</span>
117     </td><td class="summary">
118       <table width="100%" cellpadding="0" cellspacing="0" border="0">
119         <tr>
120           <td><span class="summary-sig"><a href="lxml.etree._ElementIterator-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
121         <span class="summary-sig-arg">S</span>,
122         <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">&nbsp;</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 name="__next__"></a><span class="summary-sig-name">__next__</span>(<span class="summary-sig-arg">...</span>)</span></td>
139           <td align="right" valign="top">
140             
141             
142           </td>
143         </tr>
144       </table>
145       
146     </td>
147   </tr>
148 <tr>
149     <td width="15%" align="right" valign="top" class="summary">
150       <span class="summary-type">the next value, or raise StopIteration</span>
151     </td><td class="summary">
152       <table width="100%" cellpadding="0" cellspacing="0" border="0">
153         <tr>
154           <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>
155           <td align="right" valign="top">
156             
157             
158           </td>
159         </tr>
160       </table>
161       
162     </td>
163   </tr>
164   <tr>
165     <td colspan="2" class="summary">
166     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
167       <code>__delattr__</code>,
168       <code>__format__</code>,
169       <code>__getattribute__</code>,
170       <code>__hash__</code>,
171       <code>__init__</code>,
172       <code>__reduce__</code>,
173       <code>__reduce_ex__</code>,
174       <code>__repr__</code>,
175       <code>__setattr__</code>,
176       <code>__sizeof__</code>,
177       <code>__str__</code>,
178       <code>__subclasshook__</code>
179       </p>
180     </td>
181   </tr>
182 </table>
183 <!-- ==================== PROPERTIES ==================== -->
184 <a name="section-Properties"></a>
185 <table class="summary" border="1" cellpadding="3"
186        cellspacing="0" width="100%" bgcolor="white">
187 <tr bgcolor="#70b0f0" class="table-header">
188   <td colspan="2" class="table-header">
189     <table border="0" cellpadding="0" cellspacing="0" width="100%">
190       <tr valign="top">
191         <td align="left"><span class="table-header">Properties</span></td>
192         <td align="right" valign="top"
193          ><span class="options">[<a href="#section-Properties"
194          class="privatelink" onclick="toggle_private();"
195          >hide private</a>]</span></td>
196       </tr>
197     </table>
198   </td>
199 </tr>
200   <tr>
201     <td colspan="2" class="summary">
202     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
203       <code>__class__</code>
204       </p>
205     </td>
206   </tr>
207 </table>
208 <!-- ==================== METHOD DETAILS ==================== -->
209 <a name="section-MethodDetails"></a>
210 <table class="details" border="1" cellpadding="3"
211        cellspacing="0" width="100%" bgcolor="white">
212 <tr bgcolor="#70b0f0" class="table-header">
213   <td colspan="2" class="table-header">
214     <table border="0" cellpadding="0" cellspacing="0" width="100%">
215       <tr valign="top">
216         <td align="left"><span class="table-header">Method Details</span></td>
217         <td align="right" valign="top"
218          ><span class="options">[<a href="#section-MethodDetails"
219          class="privatelink" onclick="toggle_private();"
220          >hide private</a>]</span></td>
221       </tr>
222     </table>
223   </td>
224 </tr>
225 </table>
226 <a name="__new__"></a>
227 <div>
228 <table class="details" border="1" cellpadding="3"
229        cellspacing="0" width="100%" bgcolor="white">
230 <tr><td>
231   <table width="100%" cellpadding="0" cellspacing="0" border="0">
232   <tr valign="top"><td>
233   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
234         <span class="sig-arg">S</span>,
235         <span class="sig-arg">...</span>)</span>
236   </h3>
237   </td><td align="right" valign="top"
238     >&nbsp;
239     </td>
240   </tr></table>
241   
242   
243   <dl class="fields">
244     <dt>Returns: a new object with type S, a subtype of T</dt>
245     <dt>Overrides:
246         object.__new__
247     </dt>
248   </dl>
249 </td></tr></table>
250 </div>
251 <br />
252 <!-- ==================== NAVIGATION BAR ==================== -->
253 <table class="navbar" border="0" width="100%" cellpadding="0"
254        bgcolor="#a0c0ff" cellspacing="0">
255   <tr valign="middle">
256   <!-- Home link -->
257       <th>&nbsp;&nbsp;&nbsp;<a
258         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
259
260   <!-- Tree link -->
261       <th>&nbsp;&nbsp;&nbsp;<a
262         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
263
264   <!-- Index link -->
265       <th>&nbsp;&nbsp;&nbsp;<a
266         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
267
268   <!-- Help link -->
269       <th>&nbsp;&nbsp;&nbsp;<a
270         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
271
272   <!-- Project homepage -->
273       <th class="navbar" align="right" width="100%">
274         <table border="0" cellpadding="0" cellspacing="0">
275           <tr><th class="navbar" align="center"
276             ><a class="navbar" target="_top" href="/">lxml API</a></th>
277           </tr></table></th>
278   </tr>
279 </table>
280 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
281   <tr>
282     <td align="left" class="footer">
283     Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:18 2012
284     </td>
285     <td align="right" class="footer">
286       <a target="mainFrame" href="http://epydoc.sourceforge.net"
287         >http://epydoc.sourceforge.net</a>
288     </td>
289   </tr>
290 </table>
291
292 <script type="text/javascript">
293   <!--
294   // Private objects are initially displayed (because if
295   // javascript is turned off then we want them to be
296   // visible); but by default, we want to hide them.  So hide
297   // them unless we have a cookie that says to show them.
298   checkCookie();
299   // -->
300 </script>
301 </body>
302 </html>