Imported Upstream version 4.5.2
[platform/upstream/python-lxml.git] / doc / html / api / lxml.html.LabelElement-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.html.LabelElement</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         lxml ::
46         html ::
47         LabelElement ::
48         Class&nbsp;LabelElement
49       </span>
50     </td>
51     <td>
52       <table cellpadding="0" cellspacing="0">
53         <!-- hide/show private -->
54         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
55     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
56         <tr><td align="right"><span class="options"
57             >[<a href="frames.html" target="_top">frames</a
58             >]&nbsp;|&nbsp;<a href="lxml.html.LabelElement-class.html"
59             target="_top">no&nbsp;frames</a>]</span></td></tr>
60       </table>
61     </td>
62   </tr>
63 </table>
64 <!-- ==================== CLASS DESCRIPTION ==================== -->
65 <h1 class="epydoc">Class LabelElement</h1><p class="nomargin-top"><span class="codelink"><a href="lxml.html-pysrc.html#LabelElement">source&nbsp;code</a></span></p>
66 <pre class="base-tree">
67     object --+            
68              |            
69 <a href="lxml.etree._Element-class.html" onclick="show_private();">etree._Element</a> --+        
70                  |        
71  <a href="lxml.etree.ElementBase-class.html">etree.ElementBase</a> --+    
72                      |    
73         object --+   |    
74                  |   |    
75          <a href="lxml.html.HtmlMixin-class.html">HtmlMixin</a> --+    
76                      |    
77            <a href="lxml.html.HtmlElement-class.html">HtmlElement</a> --+
78                          |
79                         <strong class="uidshort">LabelElement</strong>
80 </pre>
81
82 <hr />
83 <p>Represents a <tt class="rst-docutils literal">&lt;label&gt;</tt> element.</p>
84 <p>Label elements are linked to other elements with their <tt class="rst-docutils literal">for</tt>
85 attribute.  You can access this element with <tt class="rst-docutils literal">label.for_element</tt>.</p>
86
87 <!-- ==================== INSTANCE METHODS ==================== -->
88 <a name="section-InstanceMethods"></a>
89 <table class="summary" border="1" cellpadding="3"
90        cellspacing="0" width="100%" bgcolor="white">
91 <tr bgcolor="#70b0f0" class="table-header">
92   <td colspan="2" class="table-header">
93     <table border="0" cellpadding="0" cellspacing="0" width="100%">
94       <tr valign="top">
95         <td align="left"><span class="table-header">Instance Methods</span></td>
96         <td align="right" valign="top"
97          ><span class="options">[<a href="#section-InstanceMethods"
98          class="privatelink" onclick="toggle_private();"
99          >hide private</a>]</span></td>
100       </tr>
101     </table>
102   </td>
103 </tr>
104   <tr>
105     <td colspan="2" class="summary">
106     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.html.HtmlElement-class.html">HtmlElement</a></code></b>:
107       <code><a href="lxml.html.HtmlElement-class.html#cssselect">cssselect</a></code>,
108       <code><a href="lxml.html.HtmlElement-class.html#set">set</a></code>
109       </p>
110     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree.ElementBase-class.html">etree.ElementBase</a></code></b>:
111       <code><a href="lxml.etree.ElementBase-class.html#__init__">__init__</a></code>,
112       <code><a href="lxml.etree.ElementBase-class.html#__new__">__new__</a></code>
113       </p>
114     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Element-class.html" onclick="show_private();">etree._Element</a></code></b>:
115       <code><a href="lxml.etree._Element-class.html#__contains__">__contains__</a></code>,
116       <code><a href="lxml.etree._Element-class.html#__copy__">__copy__</a></code>,
117       <code><a href="lxml.etree._Element-class.html#__deepcopy__">__deepcopy__</a></code>,
118       <code><a href="lxml.etree._Element-class.html#__delitem__">__delitem__</a></code>,
119       <code><a href="lxml.etree._Element-class.html#__getitem__">__getitem__</a></code>,
120       <code><a href="lxml.etree._Element-class.html#__iter__">__iter__</a></code>,
121       <code><a href="lxml.etree._Element-class.html#__len__">__len__</a></code>,
122       <code><a href="lxml.etree._Element-class.html#__nonzero__">__nonzero__</a></code>,
123       <code><a href="lxml.etree._Element-class.html#__repr__">__repr__</a></code>,
124       <code><a href="lxml.etree._Element-class.html#__reversed__">__reversed__</a></code>,
125       <code><a href="lxml.etree._Element-class.html#__setitem__">__setitem__</a></code>,
126       <code><a href="lxml.etree._Element-class.html#addnext">addnext</a></code>,
127       <code><a href="lxml.etree._Element-class.html#addprevious">addprevious</a></code>,
128       <code><a href="lxml.etree._Element-class.html#append">append</a></code>,
129       <code><a href="lxml.etree._Element-class.html#clear">clear</a></code>,
130       <code><a href="lxml.etree._Element-class.html#extend">extend</a></code>,
131       <code><a href="lxml.etree._Element-class.html#find">find</a></code>,
132       <code><a href="lxml.etree._Element-class.html#findall">findall</a></code>,
133       <code><a href="lxml.etree._Element-class.html#findtext">findtext</a></code>,
134       <code><a href="lxml.etree._Element-class.html#get">get</a></code>,
135       <code><a href="lxml.etree._Element-class.html#getchildren">getchildren</a></code>,
136       <code><a href="lxml.etree._Element-class.html#getiterator">getiterator</a></code>,
137       <code><a href="lxml.etree._Element-class.html#getnext">getnext</a></code>,
138       <code><a href="lxml.etree._Element-class.html#getparent">getparent</a></code>,
139       <code><a href="lxml.etree._Element-class.html#getprevious">getprevious</a></code>,
140       <code><a href="lxml.etree._Element-class.html#getroottree">getroottree</a></code>,
141       <code><a href="lxml.etree._Element-class.html#index">index</a></code>,
142       <code><a href="lxml.etree._Element-class.html#insert">insert</a></code>,
143       <code><a href="lxml.etree._Element-class.html#items">items</a></code>,
144       <code><a href="lxml.etree._Element-class.html#iter">iter</a></code>,
145       <code><a href="lxml.etree._Element-class.html#iterancestors">iterancestors</a></code>,
146       <code><a href="lxml.etree._Element-class.html#iterchildren">iterchildren</a></code>,
147       <code><a href="lxml.etree._Element-class.html#iterdescendants">iterdescendants</a></code>,
148       <code><a href="lxml.etree._Element-class.html#iterfind">iterfind</a></code>,
149       <code><a href="lxml.etree._Element-class.html#itersiblings">itersiblings</a></code>,
150       <code><a href="lxml.etree._Element-class.html#itertext">itertext</a></code>,
151       <code><a href="lxml.etree._Element-class.html#keys">keys</a></code>,
152       <code><a href="lxml.etree._Element-class.html#makeelement">makeelement</a></code>,
153       <code><a href="lxml.etree._Element-class.html#remove">remove</a></code>,
154       <code><a href="lxml.etree._Element-class.html#replace">replace</a></code>,
155       <code><a href="lxml.etree._Element-class.html#values">values</a></code>,
156       <code><a href="lxml.etree._Element-class.html#xpath">xpath</a></code>
157       </p>
158     <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Element-class.html" onclick="show_private();">etree._Element</a></code></b> (private):
159       <code><a href="lxml.etree._Element-class.html#_init" onclick="show_private();">_init</a></code>
160       </p></div>
161     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.html.HtmlMixin-class.html">HtmlMixin</a></code></b>:
162       <code><a href="lxml.html.HtmlMixin-class.html#drop_tag">drop_tag</a></code>,
163       <code><a href="lxml.html.HtmlMixin-class.html#drop_tree">drop_tree</a></code>,
164       <code><a href="lxml.html.HtmlMixin-class.html#find_class">find_class</a></code>,
165       <code><a href="lxml.html.HtmlMixin-class.html#find_rel_links">find_rel_links</a></code>,
166       <code><a href="lxml.html.HtmlMixin-class.html#get_element_by_id">get_element_by_id</a></code>,
167       <code><a href="lxml.html.HtmlMixin-class.html#iterlinks">iterlinks</a></code>,
168       <code><a href="lxml.html.HtmlMixin-class.html#make_links_absolute">make_links_absolute</a></code>,
169       <code><a href="lxml.html.HtmlMixin-class.html#resolve_base_href">resolve_base_href</a></code>,
170       <code><a href="lxml.html.HtmlMixin-class.html#rewrite_links">rewrite_links</a></code>,
171       <code><a href="lxml.html.HtmlMixin-class.html#text_content">text_content</a></code>
172       </p>
173     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
174       <code>__delattr__</code>,
175       <code>__format__</code>,
176       <code>__getattribute__</code>,
177       <code>__hash__</code>,
178       <code>__reduce__</code>,
179       <code>__reduce_ex__</code>,
180       <code>__setattr__</code>,
181       <code>__sizeof__</code>,
182       <code>__str__</code>,
183       <code>__subclasshook__</code>
184       </p>
185     </td>
186   </tr>
187 </table>
188 <!-- ==================== PROPERTIES ==================== -->
189 <a name="section-Properties"></a>
190 <table class="summary" border="1" cellpadding="3"
191        cellspacing="0" width="100%" bgcolor="white">
192 <tr bgcolor="#70b0f0" class="table-header">
193   <td colspan="2" class="table-header">
194     <table border="0" cellpadding="0" cellspacing="0" width="100%">
195       <tr valign="top">
196         <td align="left"><span class="table-header">Properties</span></td>
197         <td align="right" valign="top"
198          ><span class="options">[<a href="#section-Properties"
199          class="privatelink" onclick="toggle_private();"
200          >hide private</a>]</span></td>
201       </tr>
202     </table>
203   </td>
204 </tr>
205 <tr>
206     <td width="15%" align="right" valign="top" class="summary">
207       <span class="summary-type">&nbsp;</span>
208     </td><td class="summary">
209         <a href="lxml.html.LabelElement-class.html#for_element" class="summary-name">for_element</a><br />
210       Get/set the element this label points to.  Return None if it
211 can't be found.
212     </td>
213   </tr>
214   <tr>
215     <td colspan="2" class="summary">
216     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Element-class.html" onclick="show_private();">etree._Element</a></code></b>:
217       <code><a href="lxml.etree._Element-class.html#attrib">attrib</a></code>,
218       <code><a href="lxml.etree._Element-class.html#base">base</a></code>,
219       <code><a href="lxml.etree._Element-class.html#nsmap">nsmap</a></code>,
220       <code><a href="lxml.etree._Element-class.html#prefix">prefix</a></code>,
221       <code><a href="lxml.etree._Element-class.html#sourceline">sourceline</a></code>,
222       <code><a href="lxml.etree._Element-class.html#tag">tag</a></code>,
223       <code><a href="lxml.etree._Element-class.html#tail">tail</a></code>,
224       <code><a href="lxml.etree._Element-class.html#text">text</a></code>
225       </p>
226     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.html.HtmlMixin-class.html">HtmlMixin</a></code></b>:
227       <code><a href="lxml.html.HtmlMixin-class.html#base_url">base_url</a></code>,
228       <code><a href="lxml.html.HtmlMixin-class.html#body">body</a></code>,
229       <code><a href="lxml.html.HtmlMixin-class.html#classes">classes</a></code>,
230       <code><a href="lxml.html.HtmlMixin-class.html#forms">forms</a></code>,
231       <code><a href="lxml.html.HtmlMixin-class.html#head">head</a></code>,
232       <code><a href="lxml.html.HtmlMixin-class.html#label">label</a></code>
233       </p>
234     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
235       <code>__class__</code>
236       </p>
237     </td>
238   </tr>
239 </table>
240 <!-- ==================== PROPERTY DETAILS ==================== -->
241 <a name="section-PropertyDetails"></a>
242 <table class="details" border="1" cellpadding="3"
243        cellspacing="0" width="100%" bgcolor="white">
244 <tr bgcolor="#70b0f0" class="table-header">
245   <td colspan="2" class="table-header">
246     <table border="0" cellpadding="0" cellspacing="0" width="100%">
247       <tr valign="top">
248         <td align="left"><span class="table-header">Property Details</span></td>
249         <td align="right" valign="top"
250          ><span class="options">[<a href="#section-PropertyDetails"
251          class="privatelink" onclick="toggle_private();"
252          >hide private</a>]</span></td>
253       </tr>
254     </table>
255   </td>
256 </tr>
257 </table>
258 <a name="for_element"></a>
259 <div>
260 <table class="details" border="1" cellpadding="3"
261        cellspacing="0" width="100%" bgcolor="white">
262 <tr><td>
263   <h3 class="epydoc">for_element</h3>
264   Get/set the element this label points to.  Return None if it
265 can't be found.
266   <dl class="fields">
267     <dt>Get Method:</dt>
268     <dd class="value"><span class="summary-sig"><i>unreachable</i>.for_element(<span class="summary-sig-arg">self</span>)</span>
269         - Get/set the element this label points to.  Return None if it
270 can't be found.
271     </dd>
272     <dt>Set Method:</dt>
273     <dd class="value"><span class="summary-sig"><i>unreachable</i>.for_element(<span class="summary-sig-arg">self</span>,
274         <span class="summary-sig-arg">other</span>)</span>
275     </dd>
276     <dt>Delete Method:</dt>
277     <dd class="value"><span class="summary-sig"><i>unreachable</i>.for_element(<span class="summary-sig-arg">self</span>)</span>
278     </dd>
279   </dl>
280 </td></tr></table>
281 </div>
282 <br />
283 <!-- ==================== NAVIGATION BAR ==================== -->
284 <table class="navbar" border="0" width="100%" cellpadding="0"
285        bgcolor="#a0c0ff" cellspacing="0">
286   <tr valign="middle">
287   <!-- Home link -->
288       <th>&nbsp;&nbsp;&nbsp;<a
289         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
290
291   <!-- Tree link -->
292       <th>&nbsp;&nbsp;&nbsp;<a
293         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
294
295   <!-- Index link -->
296       <th>&nbsp;&nbsp;&nbsp;<a
297         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
298
299   <!-- Help link -->
300       <th>&nbsp;&nbsp;&nbsp;<a
301         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
302
303   <!-- Project homepage -->
304       <th class="navbar" align="right" width="100%">
305         <table border="0" cellpadding="0" cellspacing="0">
306           <tr><th class="navbar" align="center"
307             ><a class="navbar" target="_top" href="/">lxml API</a></th>
308           </tr></table></th>
309   </tr>
310 </table>
311 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
312   <tr>
313     <td align="left" class="footer">
314     Generated by Epydoc 3.0.1
315     on Thu Jul  9 18:29:53 2020
316     </td>
317     <td align="right" class="footer">
318       <a target="mainFrame" href="http://epydoc.sourceforge.net"
319         >http://epydoc.sourceforge.net</a>
320     </td>
321   </tr>
322 </table>
323
324 <script type="text/javascript">
325   <!--
326   // Private objects are initially displayed (because if
327   // javascript is turned off then we want them to be
328   // visible); but by default, we want to hide them.  So hide
329   // them unless we have a cookie that says to show them.
330   checkCookie();
331   // -->
332 </script>
333 </body>
334 </html>