Imported Upstream version 2.3.5
[platform/upstream/python-lxml.git] / doc / html / api / lxml.etree._Entity-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._Entity</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;_Entity
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._Entity-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 _Entity</h1><p class="nomargin-top"></p>
65 <pre class="base-tree">
66       object --+        
67                |        
68         <a href="lxml.etree._Element-class.html" onclick="show_private();">_Element</a> --+    
69                    |    
70 <a href="lxml.etree.__ContentOnlyElement-class.html" onclick="show_private();">__ContentOnlyElement</a> --+
71                        |
72                       <strong class="uidshort">_Entity</strong>
73 </pre>
74
75 <dl><dt>Known Subclasses:</dt>
76 <dd>
77       <ul class="subclass-list">
78 <li><a href="lxml.etree.EntityBase-class.html">EntityBase</a></li>  </ul>
79 </dd></dl>
80
81 <hr />
82 <!-- ==================== INSTANCE METHODS ==================== -->
83 <a name="section-InstanceMethods"></a>
84 <table class="summary" border="1" cellpadding="3"
85        cellspacing="0" width="100%" bgcolor="white">
86 <tr bgcolor="#70b0f0" class="table-header">
87   <td colspan="2" class="table-header">
88     <table border="0" cellpadding="0" cellspacing="0" width="100%">
89       <tr valign="top">
90         <td align="left"><span class="table-header">Instance Methods</span></td>
91         <td align="right" valign="top"
92          ><span class="options">[<a href="#section-InstanceMethods"
93          class="privatelink" onclick="toggle_private();"
94          >hide private</a>]</span></td>
95       </tr>
96     </table>
97   </td>
98 </tr>
99 <tr>
100     <td width="15%" align="right" valign="top" class="summary">
101       <span class="summary-type">a new object with type S, a subtype of T</span>
102     </td><td class="summary">
103       <table width="100%" cellpadding="0" cellspacing="0" border="0">
104         <tr>
105           <td><span class="summary-sig"><a href="lxml.etree._Entity-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
106         <span class="summary-sig-arg">S</span>,
107         <span class="summary-sig-arg">...</span>)</span></td>
108           <td align="right" valign="top">
109             
110             
111           </td>
112         </tr>
113       </table>
114       
115     </td>
116   </tr>
117 <tr>
118     <td width="15%" align="right" valign="top" class="summary">
119       <span class="summary-type">&nbsp;</span>
120     </td><td class="summary">
121       <table width="100%" cellpadding="0" cellspacing="0" border="0">
122         <tr>
123           <td><span class="summary-sig"><a href="lxml.etree._Entity-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">x</span>)</span><br />
124       repr(x)</td>
125           <td align="right" valign="top">
126             
127             
128           </td>
129         </tr>
130       </table>
131       
132     </td>
133   </tr>
134   <tr>
135     <td colspan="2" class="summary">
136     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree.__ContentOnlyElement-class.html" onclick="show_private();">__ContentOnlyElement</a></code></b>:
137       <code><a href="lxml.etree.__ContentOnlyElement-class.html#__delitem__">__delitem__</a></code>,
138       <code><a href="lxml.etree.__ContentOnlyElement-class.html#__getitem__">__getitem__</a></code>,
139       <code><a href="lxml.etree.__ContentOnlyElement-class.html#__len__">__len__</a></code>,
140       <code><a href="lxml.etree.__ContentOnlyElement-class.html#__setitem__">__setitem__</a></code>,
141       <code><a href="lxml.etree.__ContentOnlyElement-class.html#append">append</a></code>,
142       <code><a href="lxml.etree.__ContentOnlyElement-class.html#get">get</a></code>,
143       <code><a href="lxml.etree.__ContentOnlyElement-class.html#insert">insert</a></code>,
144       <code><a href="lxml.etree.__ContentOnlyElement-class.html#items">items</a></code>,
145       <code><a href="lxml.etree.__ContentOnlyElement-class.html#keys">keys</a></code>,
146       <code><a href="lxml.etree.__ContentOnlyElement-class.html#set">set</a></code>,
147       <code><a href="lxml.etree.__ContentOnlyElement-class.html#values">values</a></code>
148       </p>
149     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Element-class.html" onclick="show_private();">_Element</a></code></b>:
150       <code><a href="lxml.etree._Element-class.html#__contains__">__contains__</a></code>,
151       <code><a href="lxml.etree._Element-class.html#__copy__">__copy__</a></code>,
152       <code><a href="lxml.etree._Element-class.html#__deepcopy__">__deepcopy__</a></code>,
153       <code><a href="lxml.etree._Element-class.html#__iter__">__iter__</a></code>,
154       <code><a href="lxml.etree._Element-class.html#__nonzero__">__nonzero__</a></code>,
155       <code><a href="lxml.etree._Element-class.html#__reversed__">__reversed__</a></code>,
156       <code><a href="lxml.etree._Element-class.html#addnext">addnext</a></code>,
157       <code><a href="lxml.etree._Element-class.html#addprevious">addprevious</a></code>,
158       <code><a href="lxml.etree._Element-class.html#clear">clear</a></code>,
159       <code><a href="lxml.etree._Element-class.html#extend">extend</a></code>,
160       <code><a href="lxml.etree._Element-class.html#find">find</a></code>,
161       <code><a href="lxml.etree._Element-class.html#findall">findall</a></code>,
162       <code><a href="lxml.etree._Element-class.html#findtext">findtext</a></code>,
163       <code><a href="lxml.etree._Element-class.html#getchildren">getchildren</a></code>,
164       <code><a href="lxml.etree._Element-class.html#getiterator">getiterator</a></code>,
165       <code><a href="lxml.etree._Element-class.html#getnext">getnext</a></code>,
166       <code><a href="lxml.etree._Element-class.html#getparent">getparent</a></code>,
167       <code><a href="lxml.etree._Element-class.html#getprevious">getprevious</a></code>,
168       <code><a href="lxml.etree._Element-class.html#getroottree">getroottree</a></code>,
169       <code><a href="lxml.etree._Element-class.html#index">index</a></code>,
170       <code><a href="lxml.etree._Element-class.html#iter">iter</a></code>,
171       <code><a href="lxml.etree._Element-class.html#iterancestors">iterancestors</a></code>,
172       <code><a href="lxml.etree._Element-class.html#iterchildren">iterchildren</a></code>,
173       <code><a href="lxml.etree._Element-class.html#iterdescendants">iterdescendants</a></code>,
174       <code><a href="lxml.etree._Element-class.html#iterfind">iterfind</a></code>,
175       <code><a href="lxml.etree._Element-class.html#itersiblings">itersiblings</a></code>,
176       <code><a href="lxml.etree._Element-class.html#itertext">itertext</a></code>,
177       <code><a href="lxml.etree._Element-class.html#makeelement">makeelement</a></code>,
178       <code><a href="lxml.etree._Element-class.html#remove">remove</a></code>,
179       <code><a href="lxml.etree._Element-class.html#replace">replace</a></code>,
180       <code><a href="lxml.etree._Element-class.html#xpath">xpath</a></code>
181       </p>
182     <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Element-class.html" onclick="show_private();">_Element</a></code></b> (private):
183       <code><a href="lxml.etree._Element-class.html#_init" onclick="show_private();">_init</a></code>
184       </p></div>
185     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
186       <code>__delattr__</code>,
187       <code>__format__</code>,
188       <code>__getattribute__</code>,
189       <code>__hash__</code>,
190       <code>__init__</code>,
191       <code>__reduce__</code>,
192       <code>__reduce_ex__</code>,
193       <code>__setattr__</code>,
194       <code>__sizeof__</code>,
195       <code>__str__</code>,
196       <code>__subclasshook__</code>
197       </p>
198     </td>
199   </tr>
200 </table>
201 <!-- ==================== PROPERTIES ==================== -->
202 <a name="section-Properties"></a>
203 <table class="summary" border="1" cellpadding="3"
204        cellspacing="0" width="100%" bgcolor="white">
205 <tr bgcolor="#70b0f0" class="table-header">
206   <td colspan="2" class="table-header">
207     <table border="0" cellpadding="0" cellspacing="0" width="100%">
208       <tr valign="top">
209         <td align="left"><span class="table-header">Properties</span></td>
210         <td align="right" valign="top"
211          ><span class="options">[<a href="#section-Properties"
212          class="privatelink" onclick="toggle_private();"
213          >hide private</a>]</span></td>
214       </tr>
215     </table>
216   </td>
217 </tr>
218 <tr>
219     <td width="15%" align="right" valign="top" class="summary">
220       <span class="summary-type">&nbsp;</span>
221     </td><td class="summary">
222         <a name="name"></a><span class="summary-name">name</span>
223     </td>
224   </tr>
225 <tr>
226     <td width="15%" align="right" valign="top" class="summary">
227       <span class="summary-type">&nbsp;</span>
228     </td><td class="summary">
229         <a name="tag"></a><span class="summary-name">tag</span><br />
230       Element tag
231     </td>
232   </tr>
233 <tr>
234     <td width="15%" align="right" valign="top" class="summary">
235       <span class="summary-type">&nbsp;</span>
236     </td><td class="summary">
237         <a name="text"></a><span class="summary-name">text</span><br />
238       Text before the first subelement. This is either a string or
239 the value None, if there was no text.
240     </td>
241   </tr>
242   <tr>
243     <td colspan="2" class="summary">
244     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree.__ContentOnlyElement-class.html" onclick="show_private();">__ContentOnlyElement</a></code></b>:
245       <code><a href="lxml.etree.__ContentOnlyElement-class.html#attrib">attrib</a></code>
246       </p>
247     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Element-class.html" onclick="show_private();">_Element</a></code></b>:
248       <code><a href="lxml.etree._Element-class.html#base">base</a></code>,
249       <code><a href="lxml.etree._Element-class.html#nsmap">nsmap</a></code>,
250       <code><a href="lxml.etree._Element-class.html#prefix">prefix</a></code>,
251       <code><a href="lxml.etree._Element-class.html#sourceline">sourceline</a></code>,
252       <code><a href="lxml.etree._Element-class.html#tail">tail</a></code>
253       </p>
254     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
255       <code>__class__</code>
256       </p>
257     </td>
258   </tr>
259 </table>
260 <!-- ==================== METHOD DETAILS ==================== -->
261 <a name="section-MethodDetails"></a>
262 <table class="details" border="1" cellpadding="3"
263        cellspacing="0" width="100%" bgcolor="white">
264 <tr bgcolor="#70b0f0" class="table-header">
265   <td colspan="2" class="table-header">
266     <table border="0" cellpadding="0" cellspacing="0" width="100%">
267       <tr valign="top">
268         <td align="left"><span class="table-header">Method Details</span></td>
269         <td align="right" valign="top"
270          ><span class="options">[<a href="#section-MethodDetails"
271          class="privatelink" onclick="toggle_private();"
272          >hide private</a>]</span></td>
273       </tr>
274     </table>
275   </td>
276 </tr>
277 </table>
278 <a name="__new__"></a>
279 <div>
280 <table class="details" border="1" cellpadding="3"
281        cellspacing="0" width="100%" bgcolor="white">
282 <tr><td>
283   <table width="100%" cellpadding="0" cellspacing="0" border="0">
284   <tr valign="top"><td>
285   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
286         <span class="sig-arg">S</span>,
287         <span class="sig-arg">...</span>)</span>
288   </h3>
289   </td><td align="right" valign="top"
290     >&nbsp;
291     </td>
292   </tr></table>
293   
294   
295   <dl class="fields">
296     <dt>Returns: a new object with type S, a subtype of T</dt>
297     <dt>Overrides:
298         object.__new__
299     </dt>
300   </dl>
301 </td></tr></table>
302 </div>
303 <a name="__repr__"></a>
304 <div>
305 <table class="details" border="1" cellpadding="3"
306        cellspacing="0" width="100%" bgcolor="white">
307 <tr><td>
308   <table width="100%" cellpadding="0" cellspacing="0" border="0">
309   <tr valign="top"><td>
310   <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">x</span>)</span>
311     <br /><em class="fname">(Representation operator)</em>
312   </h3>
313   </td><td align="right" valign="top"
314     >&nbsp;
315     </td>
316   </tr></table>
317   
318   repr(x)
319   <dl class="fields">
320     <dt>Overrides:
321         object.__repr__
322     </dt>
323   </dl>
324 </td></tr></table>
325 </div>
326 <br />
327 <!-- ==================== NAVIGATION BAR ==================== -->
328 <table class="navbar" border="0" width="100%" cellpadding="0"
329        bgcolor="#a0c0ff" cellspacing="0">
330   <tr valign="middle">
331   <!-- Home link -->
332       <th>&nbsp;&nbsp;&nbsp;<a
333         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
334
335   <!-- Tree link -->
336       <th>&nbsp;&nbsp;&nbsp;<a
337         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
338
339   <!-- Index link -->
340       <th>&nbsp;&nbsp;&nbsp;<a
341         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
342
343   <!-- Help link -->
344       <th>&nbsp;&nbsp;&nbsp;<a
345         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
346
347   <!-- Project homepage -->
348       <th class="navbar" align="right" width="100%">
349         <table border="0" cellpadding="0" cellspacing="0">
350           <tr><th class="navbar" align="center"
351             ><a class="navbar" target="_top" href="/">lxml API</a></th>
352           </tr></table></th>
353   </tr>
354 </table>
355 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
356   <tr>
357     <td align="left" class="footer">
358     Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:18 2012
359     </td>
360     <td align="right" class="footer">
361       <a target="mainFrame" href="http://epydoc.sourceforge.net"
362         >http://epydoc.sourceforge.net</a>
363     </td>
364   </tr>
365 </table>
366
367 <script type="text/javascript">
368   <!--
369   // Private objects are initially displayed (because if
370   // javascript is turned off then we want them to be
371   // visible); but by default, we want to hide them.  So hide
372   // them unless we have a cookie that says to show them.
373   checkCookie();
374   // -->
375 </script>
376 </body>
377 </html>