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