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">
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>
11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
13 <!-- ==================== NAVIGATION BAR ==================== -->
14 <table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
18 <th> <a
19 href="lxml-module.html">Home</a> </th>
22 <th> <a
23 href="module-tree.html">Trees</a> </th>
26 <th> <a
27 href="identifier-index.html">Indices</a> </th>
30 <th> <a
31 href="help.html">Help</a> </th>
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>
41 <table width="100%" cellpadding="0" cellspacing="0">
44 <span class="breadcrumbs">
45 <a href="lxml-module.html">Package lxml</a> ::
46 <a href="lxml.html-module.html">Package html</a> ::
47 Class FormElement
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 private</a>]</span></td></tr>
55 <tr><td align="right"><span class="options"
56 >[<a href="frames.html" target="_top">frames</a
57 >] | <a href="lxml.html.FormElement-class.html"
58 target="_top">no frames</a>]</span></td></tr>
63 <!-- ==================== CLASS DESCRIPTION ==================== -->
64 <h1 class="epydoc">Class FormElement</h1><p class="nomargin-top"><span class="codelink"><a href="lxml.html-pysrc.html#FormElement">source code</a></span></p>
65 <pre class="base-tree">
68 <a href="lxml.etree._Element-class.html" onclick="show_private();">etree._Element</a> --+
70 <a href="lxml.etree.ElementBase-class.html">etree.ElementBase</a> --+
74 <a href="lxml.html.HtmlMixin-class.html" onclick="show_private();">HtmlMixin</a> --+
76 <a href="lxml.html.HtmlElement-class.html" onclick="show_private();">HtmlElement</a> --+
78 <strong class="uidshort">FormElement</strong>
82 Represents a <form> element.
84 <!-- ==================== INSTANCE METHODS ==================== -->
85 <a name="section-InstanceMethods"></a>
86 <table class="summary" border="1" cellpadding="3"
87 cellspacing="0" width="100%" bgcolor="white">
88 <tr bgcolor="#70b0f0" class="table-header">
89 <td colspan="2" class="table-header">
90 <table border="0" cellpadding="0" cellspacing="0" width="100%">
92 <td align="left"><span class="table-header">Instance Methods</span></td>
93 <td align="right" valign="top"
94 ><span class="options">[<a href="#section-InstanceMethods"
95 class="privatelink" onclick="toggle_private();"
96 >hide private</a>]</span></td>
102 <td width="15%" align="right" valign="top" class="summary">
103 <span class="summary-type"> </span>
104 </td><td class="summary">
105 <table width="100%" cellpadding="0" cellspacing="0" border="0">
107 <td><span class="summary-sig"><a name="_fields__get"></a><span class="summary-sig-name">_fields__get</span>(<span class="summary-sig-arg">self</span>)</span><br />
108 Dictionary-like object that represents all the fields in this
109 form. You can set values in this dictionary to effect the
111 <td align="right" valign="top">
112 <span class="codelink"><a href="lxml.html-pysrc.html#FormElement._fields__get">source code</a></span>
121 <td width="15%" align="right" valign="top" class="summary">
122 <span class="summary-type"> </span>
123 </td><td class="summary">
124 <table width="100%" cellpadding="0" cellspacing="0" border="0">
126 <td><span class="summary-sig"><a name="_fields__set"></a><span class="summary-sig-name">_fields__set</span>(<span class="summary-sig-arg">self</span>,
127 <span class="summary-sig-arg">value</span>)</span></td>
128 <td align="right" valign="top">
129 <span class="codelink"><a href="lxml.html-pysrc.html#FormElement._fields__set">source code</a></span>
138 <td width="15%" align="right" valign="top" class="summary">
139 <span class="summary-type"> </span>
140 </td><td class="summary">
141 <table width="100%" cellpadding="0" cellspacing="0" border="0">
143 <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>
144 <td align="right" valign="top">
145 <span class="codelink"><a href="lxml.html-pysrc.html#FormElement._name">source code</a></span>
154 <td width="15%" align="right" valign="top" class="summary">
155 <span class="summary-type"> </span>
156 </td><td class="summary">
157 <table width="100%" cellpadding="0" cellspacing="0" border="0">
159 <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 />
160 Return a list of tuples of the field values for the form.
161 This is suitable to be passed to <tt class="rst-docutils literal">urllib.urlencode()</tt>.</td>
162 <td align="right" valign="top">
163 <span class="codelink"><a href="lxml.html-pysrc.html#FormElement.form_values">source code</a></span>
172 <td width="15%" align="right" valign="top" class="summary">
173 <span class="summary-type"> </span>
174 </td><td class="summary">
175 <table width="100%" cellpadding="0" cellspacing="0" border="0">
177 <td><span class="summary-sig"><a name="_action__get"></a><span class="summary-sig-name">_action__get</span>(<span class="summary-sig-arg">self</span>)</span><br />
178 Get/set the form's <tt class="rst-docutils literal">action</tt> attribute.</td>
179 <td align="right" valign="top">
180 <span class="codelink"><a href="lxml.html-pysrc.html#FormElement._action__get">source code</a></span>
189 <td width="15%" align="right" valign="top" class="summary">
190 <span class="summary-type"> </span>
191 </td><td class="summary">
192 <table width="100%" cellpadding="0" cellspacing="0" border="0">
194 <td><span class="summary-sig"><a name="_action__set"></a><span class="summary-sig-name">_action__set</span>(<span class="summary-sig-arg">self</span>,
195 <span class="summary-sig-arg">value</span>)</span></td>
196 <td align="right" valign="top">
197 <span class="codelink"><a href="lxml.html-pysrc.html#FormElement._action__set">source code</a></span>
206 <td width="15%" align="right" valign="top" class="summary">
207 <span class="summary-type"> </span>
208 </td><td class="summary">
209 <table width="100%" cellpadding="0" cellspacing="0" border="0">
211 <td><span class="summary-sig"><a name="_action__del"></a><span class="summary-sig-name">_action__del</span>(<span class="summary-sig-arg">self</span>)</span></td>
212 <td align="right" valign="top">
213 <span class="codelink"><a href="lxml.html-pysrc.html#FormElement._action__del">source code</a></span>
222 <td width="15%" align="right" valign="top" class="summary">
223 <span class="summary-type"> </span>
224 </td><td class="summary">
225 <table width="100%" cellpadding="0" cellspacing="0" border="0">
227 <td><span class="summary-sig"><a name="_method__get"></a><span class="summary-sig-name">_method__get</span>(<span class="summary-sig-arg">self</span>)</span><br />
228 Get/set the form's method. Always returns a capitalized
229 string, and defaults to <tt class="rst-docutils literal">'GET'</tt></td>
230 <td align="right" valign="top">
231 <span class="codelink"><a href="lxml.html-pysrc.html#FormElement._method__get">source code</a></span>
240 <td width="15%" align="right" valign="top" class="summary">
241 <span class="summary-type"> </span>
242 </td><td class="summary">
243 <table width="100%" cellpadding="0" cellspacing="0" border="0">
245 <td><span class="summary-sig"><a name="_method__set"></a><span class="summary-sig-name">_method__set</span>(<span class="summary-sig-arg">self</span>,
246 <span class="summary-sig-arg">value</span>)</span></td>
247 <td align="right" valign="top">
248 <span class="codelink"><a href="lxml.html-pysrc.html#FormElement._method__set">source code</a></span>
257 <td colspan="2" class="summary">
258 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree.ElementBase-class.html">etree.ElementBase</a></code></b>:
259 <code><a href="lxml.etree.ElementBase-class.html#__init__">__init__</a></code>,
260 <code><a href="lxml.etree.ElementBase-class.html#__new__">__new__</a></code>
262 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Element-class.html" onclick="show_private();">etree._Element</a></code></b>:
263 <code><a href="lxml.etree._Element-class.html#__contains__">__contains__</a></code>,
264 <code><a href="lxml.etree._Element-class.html#__copy__">__copy__</a></code>,
265 <code><a href="lxml.etree._Element-class.html#__deepcopy__">__deepcopy__</a></code>,
266 <code><a href="lxml.etree._Element-class.html#__delitem__">__delitem__</a></code>,
267 <code><a href="lxml.etree._Element-class.html#__getitem__">__getitem__</a></code>,
268 <code><a href="lxml.etree._Element-class.html#__iter__">__iter__</a></code>,
269 <code><a href="lxml.etree._Element-class.html#__len__">__len__</a></code>,
270 <code><a href="lxml.etree._Element-class.html#__nonzero__">__nonzero__</a></code>,
271 <code><a href="lxml.etree._Element-class.html#__repr__">__repr__</a></code>,
272 <code><a href="lxml.etree._Element-class.html#__reversed__">__reversed__</a></code>,
273 <code><a href="lxml.etree._Element-class.html#__setitem__">__setitem__</a></code>,
274 <code><a href="lxml.etree._Element-class.html#addnext">addnext</a></code>,
275 <code><a href="lxml.etree._Element-class.html#addprevious">addprevious</a></code>,
276 <code><a href="lxml.etree._Element-class.html#append">append</a></code>,
277 <code><a href="lxml.etree._Element-class.html#clear">clear</a></code>,
278 <code><a href="lxml.etree._Element-class.html#extend">extend</a></code>,
279 <code><a href="lxml.etree._Element-class.html#find">find</a></code>,
280 <code><a href="lxml.etree._Element-class.html#findall">findall</a></code>,
281 <code><a href="lxml.etree._Element-class.html#findtext">findtext</a></code>,
282 <code><a href="lxml.etree._Element-class.html#get">get</a></code>,
283 <code><a href="lxml.etree._Element-class.html#getchildren">getchildren</a></code>,
284 <code><a href="lxml.etree._Element-class.html#getiterator">getiterator</a></code>,
285 <code><a href="lxml.etree._Element-class.html#getnext">getnext</a></code>,
286 <code><a href="lxml.etree._Element-class.html#getparent">getparent</a></code>,
287 <code><a href="lxml.etree._Element-class.html#getprevious">getprevious</a></code>,
288 <code><a href="lxml.etree._Element-class.html#getroottree">getroottree</a></code>,
289 <code><a href="lxml.etree._Element-class.html#index">index</a></code>,
290 <code><a href="lxml.etree._Element-class.html#insert">insert</a></code>,
291 <code><a href="lxml.etree._Element-class.html#items">items</a></code>,
292 <code><a href="lxml.etree._Element-class.html#iter">iter</a></code>,
293 <code><a href="lxml.etree._Element-class.html#iterancestors">iterancestors</a></code>,
294 <code><a href="lxml.etree._Element-class.html#iterchildren">iterchildren</a></code>,
295 <code><a href="lxml.etree._Element-class.html#iterdescendants">iterdescendants</a></code>,
296 <code><a href="lxml.etree._Element-class.html#iterfind">iterfind</a></code>,
297 <code><a href="lxml.etree._Element-class.html#itersiblings">itersiblings</a></code>,
298 <code><a href="lxml.etree._Element-class.html#itertext">itertext</a></code>,
299 <code><a href="lxml.etree._Element-class.html#keys">keys</a></code>,
300 <code><a href="lxml.etree._Element-class.html#makeelement">makeelement</a></code>,
301 <code><a href="lxml.etree._Element-class.html#remove">remove</a></code>,
302 <code><a href="lxml.etree._Element-class.html#replace">replace</a></code>,
303 <code><a href="lxml.etree._Element-class.html#set">set</a></code>,
304 <code><a href="lxml.etree._Element-class.html#values">values</a></code>,
305 <code><a href="lxml.etree._Element-class.html#xpath">xpath</a></code>
307 <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):
308 <code><a href="lxml.etree._Element-class.html#_init" onclick="show_private();">_init</a></code>
310 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.html.HtmlMixin-class.html" onclick="show_private();">HtmlMixin</a></code></b>:
311 <code><a href="lxml.html.HtmlMixin-class.html#cssselect">cssselect</a></code>,
312 <code><a href="lxml.html.HtmlMixin-class.html#drop_tag">drop_tag</a></code>,
313 <code><a href="lxml.html.HtmlMixin-class.html#drop_tree">drop_tree</a></code>,
314 <code><a href="lxml.html.HtmlMixin-class.html#find_class">find_class</a></code>,
315 <code><a href="lxml.html.HtmlMixin-class.html#find_rel_links">find_rel_links</a></code>,
316 <code><a href="lxml.html.HtmlMixin-class.html#get_element_by_id">get_element_by_id</a></code>,
317 <code><a href="lxml.html.HtmlMixin-class.html#iterlinks">iterlinks</a></code>,
318 <code><a href="lxml.html.HtmlMixin-class.html#make_links_absolute">make_links_absolute</a></code>,
319 <code><a href="lxml.html.HtmlMixin-class.html#resolve_base_href">resolve_base_href</a></code>,
320 <code><a href="lxml.html.HtmlMixin-class.html#rewrite_links">rewrite_links</a></code>,
321 <code><a href="lxml.html.HtmlMixin-class.html#text_content">text_content</a></code>
323 <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):
324 <code><a href="lxml.html.HtmlMixin-class.html#_label__del" onclick="show_private();">_label__del</a></code>,
325 <code><a href="lxml.html.HtmlMixin-class.html#_label__get" onclick="show_private();">_label__get</a></code>,
326 <code><a href="lxml.html.HtmlMixin-class.html#_label__set" onclick="show_private();">_label__set</a></code>
328 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
329 <code>__delattr__</code>,
330 <code>__format__</code>,
331 <code>__getattribute__</code>,
332 <code>__hash__</code>,
333 <code>__reduce__</code>,
334 <code>__reduce_ex__</code>,
335 <code>__setattr__</code>,
336 <code>__sizeof__</code>,
337 <code>__str__</code>,
338 <code>__subclasshook__</code>
343 <!-- ==================== PROPERTIES ==================== -->
344 <a name="section-Properties"></a>
345 <table class="summary" border="1" cellpadding="3"
346 cellspacing="0" width="100%" bgcolor="white">
347 <tr bgcolor="#70b0f0" class="table-header">
348 <td colspan="2" class="table-header">
349 <table border="0" cellpadding="0" cellspacing="0" width="100%">
351 <td align="left"><span class="table-header">Properties</span></td>
352 <td align="right" valign="top"
353 ><span class="options">[<a href="#section-Properties"
354 class="privatelink" onclick="toggle_private();"
355 >hide private</a>]</span></td>
361 <td width="15%" align="right" valign="top" class="summary">
362 <span class="summary-type"> </span>
363 </td><td class="summary">
364 <a href="lxml.html.FormElement-class.html#inputs" class="summary-name">inputs</a><br />
365 Returns an accessor for all the input elements in the form.
369 <td width="15%" align="right" valign="top" class="summary">
370 <span class="summary-type"> </span>
371 </td><td class="summary">
372 <a href="lxml.html.FormElement-class.html#fields" class="summary-name">fields</a><br />
373 Dictionary-like object that represents all the fields in this
374 form. You can set values in this dictionary to effect the
379 <td width="15%" align="right" valign="top" class="summary">
380 <span class="summary-type"> </span>
381 </td><td class="summary">
382 <a href="lxml.html.FormElement-class.html#action" class="summary-name">action</a><br />
383 Get/set the form's <tt class="rst-docutils literal">action</tt> attribute.
387 <td width="15%" align="right" valign="top" class="summary">
388 <span class="summary-type"> </span>
389 </td><td class="summary">
390 <a href="lxml.html.FormElement-class.html#method" class="summary-name">method</a><br />
391 Get/set the form's method. Always returns a capitalized
392 string, and defaults to <tt class="rst-docutils literal">'GET'</tt>
396 <td colspan="2" class="summary">
397 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Element-class.html" onclick="show_private();">etree._Element</a></code></b>:
398 <code><a href="lxml.etree._Element-class.html#attrib">attrib</a></code>,
399 <code><a href="lxml.etree._Element-class.html#base">base</a></code>,
400 <code><a href="lxml.etree._Element-class.html#nsmap">nsmap</a></code>,
401 <code><a href="lxml.etree._Element-class.html#prefix">prefix</a></code>,
402 <code><a href="lxml.etree._Element-class.html#sourceline">sourceline</a></code>,
403 <code><a href="lxml.etree._Element-class.html#tag">tag</a></code>,
404 <code><a href="lxml.etree._Element-class.html#tail">tail</a></code>,
405 <code><a href="lxml.etree._Element-class.html#text">text</a></code>
407 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.html.HtmlMixin-class.html" onclick="show_private();">HtmlMixin</a></code></b>:
408 <code><a href="lxml.html.HtmlMixin-class.html#base_url">base_url</a></code>,
409 <code><a href="lxml.html.HtmlMixin-class.html#body">body</a></code>,
410 <code><a href="lxml.html.HtmlMixin-class.html#forms">forms</a></code>,
411 <code><a href="lxml.html.HtmlMixin-class.html#head">head</a></code>,
412 <code><a href="lxml.html.HtmlMixin-class.html#label">label</a></code>
414 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
415 <code>__class__</code>
420 <!-- ==================== PROPERTY DETAILS ==================== -->
421 <a name="section-PropertyDetails"></a>
422 <table class="details" border="1" cellpadding="3"
423 cellspacing="0" width="100%" bgcolor="white">
424 <tr bgcolor="#70b0f0" class="table-header">
425 <td colspan="2" class="table-header">
426 <table border="0" cellpadding="0" cellspacing="0" width="100%">
428 <td align="left"><span class="table-header">Property Details</span></td>
429 <td align="right" valign="top"
430 ><span class="options">[<a href="#section-PropertyDetails"
431 class="privatelink" onclick="toggle_private();"
432 >hide private</a>]</span></td>
438 <a name="inputs"></a>
440 <table class="details" border="1" cellpadding="3"
441 cellspacing="0" width="100%" bgcolor="white">
443 <h3 class="epydoc">inputs</h3>
444 <p>Returns an accessor for all the input elements in the form.</p>
445 <p>See <a href="lxml.html.InputGetter-class.html" class="link" onclick="show_private();">InputGetter</a> for more information about the object.</p>
448 <dd class="value"><span class="summary-sig"><i>unreachable</i>.inputs(<span class="summary-sig-arg">self</span>)</span>
449 - Returns an accessor for all the input elements in the form.
454 <a name="fields"></a>
456 <table class="details" border="1" cellpadding="3"
457 cellspacing="0" width="100%" bgcolor="white">
459 <h3 class="epydoc">fields</h3>
460 Dictionary-like object that represents all the fields in this
461 form. You can set values in this dictionary to effect the
465 <dd class="value"><span class="summary-sig"><a href="lxml.html.FormElement-class.html#_fields__get" class="summary-sig-name" onclick="show_private();">_fields__get</a>(<span class="summary-sig-arg">self</span>)</span>
466 - Dictionary-like object that represents all the fields in this
467 form. You can set values in this dictionary to effect the
471 <dd class="value"><span class="summary-sig"><a href="lxml.html.FormElement-class.html#_fields__set" class="summary-sig-name" onclick="show_private();">_fields__set</a>(<span class="summary-sig-arg">self</span>,
472 <span class="summary-sig-arg">value</span>)</span>
477 <a name="action"></a>
479 <table class="details" border="1" cellpadding="3"
480 cellspacing="0" width="100%" bgcolor="white">
482 <h3 class="epydoc">action</h3>
483 Get/set the form's <tt class="rst-rst-docutils literal rst-docutils literal">action</tt> attribute.
486 <dd class="value"><span class="summary-sig"><a href="lxml.html.FormElement-class.html#_action__get" class="summary-sig-name" onclick="show_private();">_action__get</a>(<span class="summary-sig-arg">self</span>)</span>
487 - Get/set the form's <tt class="rst-rst-docutils literal rst-docutils literal">action</tt> attribute.
490 <dd class="value"><span class="summary-sig"><a href="lxml.html.FormElement-class.html#_action__set" class="summary-sig-name" onclick="show_private();">_action__set</a>(<span class="summary-sig-arg">self</span>,
491 <span class="summary-sig-arg">value</span>)</span>
493 <dt>Delete Method:</dt>
494 <dd class="value"><span class="summary-sig"><a href="lxml.html.FormElement-class.html#_action__del" class="summary-sig-name" onclick="show_private();">_action__del</a>(<span class="summary-sig-arg">self</span>)</span>
499 <a name="method"></a>
501 <table class="details" border="1" cellpadding="3"
502 cellspacing="0" width="100%" bgcolor="white">
504 <h3 class="epydoc">method</h3>
505 Get/set the form's method. Always returns a capitalized
506 string, and defaults to <tt class="rst-rst-docutils literal rst-docutils literal">'GET'</tt>
509 <dd class="value"><span class="summary-sig"><a href="lxml.html.FormElement-class.html#_method__get" class="summary-sig-name" onclick="show_private();">_method__get</a>(<span class="summary-sig-arg">self</span>)</span>
510 - Get/set the form's method. Always returns a capitalized
511 string, and defaults to <tt class="rst-rst-docutils literal rst-docutils literal">'GET'</tt>
514 <dd class="value"><span class="summary-sig"><a href="lxml.html.FormElement-class.html#_method__set" class="summary-sig-name" onclick="show_private();">_method__set</a>(<span class="summary-sig-arg">self</span>,
515 <span class="summary-sig-arg">value</span>)</span>
521 <!-- ==================== NAVIGATION BAR ==================== -->
522 <table class="navbar" border="0" width="100%" cellpadding="0"
523 bgcolor="#a0c0ff" cellspacing="0">
526 <th> <a
527 href="lxml-module.html">Home</a> </th>
530 <th> <a
531 href="module-tree.html">Trees</a> </th>
534 <th> <a
535 href="identifier-index.html">Indices</a> </th>
538 <th> <a
539 href="help.html">Help</a> </th>
541 <!-- Project homepage -->
542 <th class="navbar" align="right" width="100%">
543 <table border="0" cellpadding="0" cellspacing="0">
544 <tr><th class="navbar" align="center"
545 ><a class="navbar" target="_top" href="/">lxml API</a></th>
549 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
551 <td align="left" class="footer">
552 Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:19 2012
554 <td align="right" class="footer">
555 <a target="mainFrame" href="http://epydoc.sourceforge.net"
556 >http://epydoc.sourceforge.net</a>
561 <script type="text/javascript">
563 // Private objects are initially displayed (because if
564 // javascript is turned off then we want them to be
565 // visible); but by default, we want to hide them. So hide
566 // them unless we have a cookie that says to show them.