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