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