8f835ca38de867b8eae927c8e57c92d98fae9583
[platform/upstream/python-lxml.git] / doc / html / api / xml.etree.ElementTree.TreeBuilder-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>xml.etree.ElementTree.TreeBuilder</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         xml ::
46         etree ::
47         ElementTree ::
48         TreeBuilder ::
49         Class&nbsp;TreeBuilder
50       </span>
51     </td>
52     <td>
53       <table cellpadding="0" cellspacing="0">
54         <!-- hide/show private -->
55         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
56     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
57         <tr><td align="right"><span class="options"
58             >[<a href="frames.html" target="_top">frames</a
59             >]&nbsp;|&nbsp;<a href="xml.etree.ElementTree.TreeBuilder-class.html"
60             target="_top">no&nbsp;frames</a>]</span></td></tr>
61       </table>
62     </td>
63   </tr>
64 </table>
65 <!-- ==================== CLASS DESCRIPTION ==================== -->
66 <h1 class="epydoc">Class TreeBuilder</h1><p class="nomargin-top"><span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#TreeBuilder">source&nbsp;code</a></span></p>
67 <pre class="base-tree">
68 object --+
69          |
70         <strong class="uidshort">TreeBuilder</strong>
71 </pre>
72
73 <hr />
74 <!-- ==================== INSTANCE METHODS ==================== -->
75 <a name="section-InstanceMethods"></a>
76 <table class="summary" border="1" cellpadding="3"
77        cellspacing="0" width="100%" bgcolor="white">
78 <tr bgcolor="#70b0f0" class="table-header">
79   <td colspan="2" class="table-header">
80     <table border="0" cellpadding="0" cellspacing="0" width="100%">
81       <tr valign="top">
82         <td align="left"><span class="table-header">Instance Methods</span></td>
83         <td align="right" valign="top"
84          ><span class="options">[<a href="#section-InstanceMethods"
85          class="privatelink" onclick="toggle_private();"
86          >hide private</a>]</span></td>
87       </tr>
88     </table>
89   </td>
90 </tr>
91 <tr>
92     <td width="15%" align="right" valign="top" class="summary">
93       <span class="summary-type">&nbsp;</span>
94     </td><td class="summary">
95       <table width="100%" cellpadding="0" cellspacing="0" border="0">
96         <tr>
97           <td><span class="summary-sig"><a href="xml.etree.ElementTree.TreeBuilder-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
98         <span class="summary-sig-arg">element_factory</span>=<span class="summary-sig-default">None</span>)</span><br />
99       x.__init__(...) initializes x; see help(type(x)) for signature</td>
100           <td align="right" valign="top">
101             <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#TreeBuilder.__init__">source&nbsp;code</a></span>
102             
103           </td>
104         </tr>
105       </table>
106       
107     </td>
108   </tr>
109 <tr class="private">
110     <td width="15%" align="right" valign="top" class="summary">
111       <span class="summary-type">&nbsp;</span>
112     </td><td class="summary">
113       <table width="100%" cellpadding="0" cellspacing="0" border="0">
114         <tr>
115           <td><span class="summary-sig"><a name="_flush"></a><span class="summary-sig-name">_flush</span>(<span class="summary-sig-arg">self</span>)</span></td>
116           <td align="right" valign="top">
117             <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#TreeBuilder._flush">source&nbsp;code</a></span>
118             
119           </td>
120         </tr>
121       </table>
122       
123     </td>
124   </tr>
125 <tr>
126     <td width="15%" align="right" valign="top" class="summary">
127       <span class="summary-type">&nbsp;</span>
128     </td><td class="summary">
129       <table width="100%" cellpadding="0" cellspacing="0" border="0">
130         <tr>
131           <td><span class="summary-sig"><a name="close"></a><span class="summary-sig-name">close</span>(<span class="summary-sig-arg">self</span>)</span></td>
132           <td align="right" valign="top">
133             <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#TreeBuilder.close">source&nbsp;code</a></span>
134             
135           </td>
136         </tr>
137       </table>
138       
139     </td>
140   </tr>
141 <tr>
142     <td width="15%" align="right" valign="top" class="summary">
143       <span class="summary-type">&nbsp;</span>
144     </td><td class="summary">
145       <table width="100%" cellpadding="0" cellspacing="0" border="0">
146         <tr>
147           <td><span class="summary-sig"><a name="data"></a><span class="summary-sig-name">data</span>(<span class="summary-sig-arg">self</span>,
148         <span class="summary-sig-arg">data</span>)</span></td>
149           <td align="right" valign="top">
150             <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#TreeBuilder.data">source&nbsp;code</a></span>
151             
152           </td>
153         </tr>
154       </table>
155       
156     </td>
157   </tr>
158 <tr>
159     <td width="15%" align="right" valign="top" class="summary">
160       <span class="summary-type">&nbsp;</span>
161     </td><td class="summary">
162       <table width="100%" cellpadding="0" cellspacing="0" border="0">
163         <tr>
164           <td><span class="summary-sig"><a name="end"></a><span class="summary-sig-name">end</span>(<span class="summary-sig-arg">self</span>,
165         <span class="summary-sig-arg">tag</span>)</span></td>
166           <td align="right" valign="top">
167             <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#TreeBuilder.end">source&nbsp;code</a></span>
168             
169           </td>
170         </tr>
171       </table>
172       
173     </td>
174   </tr>
175 <tr>
176     <td width="15%" align="right" valign="top" class="summary">
177       <span class="summary-type">&nbsp;</span>
178     </td><td class="summary">
179       <table width="100%" cellpadding="0" cellspacing="0" border="0">
180         <tr>
181           <td><span class="summary-sig"><a name="start"></a><span class="summary-sig-name">start</span>(<span class="summary-sig-arg">self</span>,
182         <span class="summary-sig-arg">tag</span>,
183         <span class="summary-sig-arg">attrs</span>)</span></td>
184           <td align="right" valign="top">
185             <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#TreeBuilder.start">source&nbsp;code</a></span>
186             
187           </td>
188         </tr>
189       </table>
190       
191     </td>
192   </tr>
193   <tr>
194     <td colspan="2" class="summary">
195     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
196       <code>__delattr__</code>,
197       <code>__format__</code>,
198       <code>__getattribute__</code>,
199       <code>__hash__</code>,
200       <code>__new__</code>,
201       <code>__reduce__</code>,
202       <code>__reduce_ex__</code>,
203       <code>__repr__</code>,
204       <code>__setattr__</code>,
205       <code>__sizeof__</code>,
206       <code>__str__</code>,
207       <code>__subclasshook__</code>
208       </p>
209     </td>
210   </tr>
211 </table>
212 <!-- ==================== PROPERTIES ==================== -->
213 <a name="section-Properties"></a>
214 <table class="summary" border="1" cellpadding="3"
215        cellspacing="0" width="100%" bgcolor="white">
216 <tr bgcolor="#70b0f0" class="table-header">
217   <td colspan="2" class="table-header">
218     <table border="0" cellpadding="0" cellspacing="0" width="100%">
219       <tr valign="top">
220         <td align="left"><span class="table-header">Properties</span></td>
221         <td align="right" valign="top"
222          ><span class="options">[<a href="#section-Properties"
223          class="privatelink" onclick="toggle_private();"
224          >hide private</a>]</span></td>
225       </tr>
226     </table>
227   </td>
228 </tr>
229   <tr>
230     <td colspan="2" class="summary">
231     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
232       <code>__class__</code>
233       </p>
234     </td>
235   </tr>
236 </table>
237 <!-- ==================== METHOD DETAILS ==================== -->
238 <a name="section-MethodDetails"></a>
239 <table class="details" border="1" cellpadding="3"
240        cellspacing="0" width="100%" bgcolor="white">
241 <tr bgcolor="#70b0f0" class="table-header">
242   <td colspan="2" class="table-header">
243     <table border="0" cellpadding="0" cellspacing="0" width="100%">
244       <tr valign="top">
245         <td align="left"><span class="table-header">Method Details</span></td>
246         <td align="right" valign="top"
247          ><span class="options">[<a href="#section-MethodDetails"
248          class="privatelink" onclick="toggle_private();"
249          >hide private</a>]</span></td>
250       </tr>
251     </table>
252   </td>
253 </tr>
254 </table>
255 <a name="__init__"></a>
256 <div>
257 <table class="details" border="1" cellpadding="3"
258        cellspacing="0" width="100%" bgcolor="white">
259 <tr><td>
260   <table width="100%" cellpadding="0" cellspacing="0" border="0">
261   <tr valign="top"><td>
262   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
263         <span class="sig-arg">element_factory</span>=<span class="sig-default">None</span>)</span>
264     <br /><em class="fname">(Constructor)</em>
265   </h3>
266   </td><td align="right" valign="top"
267     ><span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#TreeBuilder.__init__">source&nbsp;code</a></span>&nbsp;
268     </td>
269   </tr></table>
270   
271   x.__init__(...) initializes x; see help(type(x)) for signature
272   <dl class="fields">
273     <dt>Overrides:
274         object.__init__
275         <dd><em class="note">(inherited documentation)</em></dd>
276     </dt>
277   </dl>
278 </td></tr></table>
279 </div>
280 <br />
281 <!-- ==================== NAVIGATION BAR ==================== -->
282 <table class="navbar" border="0" width="100%" cellpadding="0"
283        bgcolor="#a0c0ff" cellspacing="0">
284   <tr valign="middle">
285   <!-- Home link -->
286       <th>&nbsp;&nbsp;&nbsp;<a
287         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
288
289   <!-- Tree link -->
290       <th>&nbsp;&nbsp;&nbsp;<a
291         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
292
293   <!-- Index link -->
294       <th>&nbsp;&nbsp;&nbsp;<a
295         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
296
297   <!-- Help link -->
298       <th>&nbsp;&nbsp;&nbsp;<a
299         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
300
301   <!-- Project homepage -->
302       <th class="navbar" align="right" width="100%">
303         <table border="0" cellpadding="0" cellspacing="0">
304           <tr><th class="navbar" align="center"
305             ><a class="navbar" target="_top" href="/">lxml API</a></th>
306           </tr></table></th>
307   </tr>
308 </table>
309 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
310   <tr>
311     <td align="left" class="footer">
312     Generated by Epydoc 3.0.1
313     on Wed Jan 29 12:26:21 2020
314     </td>
315     <td align="right" class="footer">
316       <a target="mainFrame" href="http://epydoc.sourceforge.net"
317         >http://epydoc.sourceforge.net</a>
318     </td>
319   </tr>
320 </table>
321
322 <script type="text/javascript">
323   <!--
324   // Private objects are initially displayed (because if
325   // javascript is turned off then we want them to be
326   // visible); but by default, we want to hide them.  So hide
327   // them unless we have a cookie that says to show them.
328   checkCookie();
329   // -->
330 </script>
331 </body>
332 </html>