doc/html/api/lxml.html.InputGetter-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.InputGetter</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;InputGetter
  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.InputGetter-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 InputGetter</h1><p class="nomargin-top"><span class="codelink"><a href="lxml.html-pysrc.html#InputGetter">source&nbsp;code</a></span></p>
  65 <pre class="base-tree">
  66 object --+
  67          |
  68         <strong class="uidshort">InputGetter</strong>
  69 </pre>
  70
  71 <hr />
  72 <p>An accessor that represents all the input fields in a form.</p>
  73 <p>You can get fields by name from this, with
  74 <tt class="rst-docutils literal"><span class="pre">form.inputs['field_name']</span></tt>.  If there are a set of checkboxes
  75 with the same name, they are returned as a list (a <a href="lxml.html.CheckboxGroup-class.html" class="link" onclick="show_private();">CheckboxGroup</a>
  76 which also allows value setting).  Radio inputs are handled
  77 similarly.</p>
  78 <p>You can also iterate over this to get all input elements.  This
  79 won't return the same thing as if you get all the names, as
  80 checkboxes and radio elements are returned individually.</p>
  81
  82 <!-- ==================== INSTANCE METHODS ==================== -->
  83 <a name="section-InstanceMethods"></a>
  84 <table class="summary" border="1" cellpadding="3"
  85        cellspacing="0" width="100%" bgcolor="white">
  86 <tr bgcolor="#70b0f0" class="table-header">
  87   <td colspan="2" class="table-header">
  88     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  89       <tr valign="top">
  90         <td align="left"><span class="table-header">Instance Methods</span></td>
  91         <td align="right" valign="top"
  92          ><span class="options">[<a href="#section-InstanceMethods"
  93          class="privatelink" onclick="toggle_private();"
  94          >hide private</a>]</span></td>
  95       </tr>
  96     </table>
  97   </td>
  98 </tr>
  99 <tr>
 100     <td width="15%" align="right" valign="top" class="summary">
 101       <span class="summary-type">&nbsp;</span>
 102     </td><td class="summary">
 103       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 104         <tr>
 105           <td><span class="summary-sig"><a href="lxml.html.InputGetter-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
 106         <span class="summary-sig-arg">form</span>)</span><br />
 107       x.__init__(...) initializes x; see help(type(x)) for signature</td>
 108           <td align="right" valign="top">
 109             <span class="codelink"><a href="lxml.html-pysrc.html#InputGetter.__init__">source&nbsp;code</a></span>
 110
 111           </td>
 112         </tr>
 113       </table>
 114
 115     </td>
 116   </tr>
 117 <tr>
 118     <td width="15%" align="right" valign="top" class="summary">
 119       <span class="summary-type">&nbsp;</span>
 120     </td><td class="summary">
 121       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 122         <tr>
 123           <td><span class="summary-sig"><a href="lxml.html.InputGetter-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br />
 124       repr(x)</td>
 125           <td align="right" valign="top">
 126             <span class="codelink"><a href="lxml.html-pysrc.html#InputGetter.__repr__">source&nbsp;code</a></span>
 127
 128           </td>
 129         </tr>
 130       </table>
 131
 132     </td>
 133   </tr>
 134 <tr>
 135     <td width="15%" align="right" valign="top" class="summary">
 136       <span class="summary-type">&nbsp;</span>
 137     </td><td class="summary">
 138       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 139         <tr>
 140           <td><span class="summary-sig"><a name="__getitem__"></a><span class="summary-sig-name">__getitem__</span>(<span class="summary-sig-arg">self</span>,
 141         <span class="summary-sig-arg">name</span>)</span></td>
 142           <td align="right" valign="top">
 143             <span class="codelink"><a href="lxml.html-pysrc.html#InputGetter.__getitem__">source&nbsp;code</a></span>
 144
 145           </td>
 146         </tr>
 147       </table>
 148
 149     </td>
 150   </tr>
 151 <tr>
 152     <td width="15%" align="right" valign="top" class="summary">
 153       <span class="summary-type">&nbsp;</span>
 154     </td><td class="summary">
 155       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 156         <tr>
 157           <td><span class="summary-sig"><a name="__contains__"></a><span class="summary-sig-name">__contains__</span>(<span class="summary-sig-arg">self</span>,
 158         <span class="summary-sig-arg">name</span>)</span></td>
 159           <td align="right" valign="top">
 160             <span class="codelink"><a href="lxml.html-pysrc.html#InputGetter.__contains__">source&nbsp;code</a></span>
 161
 162           </td>
 163         </tr>
 164       </table>
 165
 166     </td>
 167   </tr>
 168 <tr>
 169     <td width="15%" align="right" valign="top" class="summary">
 170       <span class="summary-type">&nbsp;</span>
 171     </td><td class="summary">
 172       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 173         <tr>
 174           <td><span class="summary-sig"><a name="keys"></a><span class="summary-sig-name">keys</span>(<span class="summary-sig-arg">self</span>)</span></td>
 175           <td align="right" valign="top">
 176             <span class="codelink"><a href="lxml.html-pysrc.html#InputGetter.keys">source&nbsp;code</a></span>
 177
 178           </td>
 179         </tr>
 180       </table>
 181
 182     </td>
 183   </tr>
 184 <tr>
 185     <td width="15%" align="right" valign="top" class="summary">
 186       <span class="summary-type">&nbsp;</span>
 187     </td><td class="summary">
 188       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 189         <tr>
 190           <td><span class="summary-sig"><a name="__iter__"></a><span class="summary-sig-name">__iter__</span>(<span class="summary-sig-arg">self</span>)</span></td>
 191           <td align="right" valign="top">
 192             <span class="codelink"><a href="lxml.html-pysrc.html#InputGetter.__iter__">source&nbsp;code</a></span>
 193
 194           </td>
 195         </tr>
 196       </table>
 197
 198     </td>
 199   </tr>
 200   <tr>
 201     <td colspan="2" class="summary">
 202     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 203       <code>__delattr__</code>,
 204       <code>__format__</code>,
 205       <code>__getattribute__</code>,
 206       <code>__hash__</code>,
 207       <code>__new__</code>,
 208       <code>__reduce__</code>,
 209       <code>__reduce_ex__</code>,
 210       <code>__setattr__</code>,
 211       <code>__sizeof__</code>,
 212       <code>__str__</code>,
 213       <code>__subclasshook__</code>
 214       </p>
 215     </td>
 216   </tr>
 217 </table>
 218 <!-- ==================== CLASS VARIABLES ==================== -->
 219 <a name="section-ClassVariables"></a>
 220 <table class="summary" border="1" cellpadding="3"
 221        cellspacing="0" width="100%" bgcolor="white">
 222 <tr bgcolor="#70b0f0" class="table-header">
 223   <td colspan="2" class="table-header">
 224     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 225       <tr valign="top">
 226         <td align="left"><span class="table-header">Class Variables</span></td>
 227         <td align="right" valign="top"
 228          ><span class="options">[<a href="#section-ClassVariables"
 229          class="privatelink" onclick="toggle_private();"
 230          >hide private</a>]</span></td>
 231       </tr>
 232     </table>
 233   </td>
 234 </tr>
 235 <tr class="private">
 236     <td width="15%" align="right" valign="top" class="summary">
 237       <span class="summary-type">&nbsp;</span>
 238     </td><td class="summary">
 239         <a href="lxml.html.InputGetter-class.html#_name_xpath" class="summary-name" onclick="show_private();">_name_xpath</a> = <code title=".//*[@name = $name and (local-name(.) = 'select' or local-name(.) = 'i\
 240 nput' or local-name(.) = 'textarea')]">.//*[@name = $name and (local-name(.) = 'select'<code class="variable-ellipsis">...</code></code>
 241     </td>
 242   </tr>
 243 <tr class="private">
 244     <td width="15%" align="right" valign="top" class="summary">
 245       <span class="summary-type">&nbsp;</span>
 246     </td><td class="summary">
 247         <a href="lxml.html.InputGetter-class.html#_all_xpath" class="summary-name" onclick="show_private();">_all_xpath</a> = <code title=".//*[local-name() = 'select' or local-name() = 'input' or local-name()\
 248  = 'textarea']">.//*[local-name() = 'select' or local-name() = 'i<code class="variable-ellipsis">...</code></code>
 249     </td>
 250   </tr>
 251 </table>
 252 <!-- ==================== PROPERTIES ==================== -->
 253 <a name="section-Properties"></a>
 254 <table class="summary" border="1" cellpadding="3"
 255        cellspacing="0" width="100%" bgcolor="white">
 256 <tr bgcolor="#70b0f0" class="table-header">
 257   <td colspan="2" class="table-header">
 258     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 259       <tr valign="top">
 260         <td align="left"><span class="table-header">Properties</span></td>
 261         <td align="right" valign="top"
 262          ><span class="options">[<a href="#section-Properties"
 263          class="privatelink" onclick="toggle_private();"
 264          >hide private</a>]</span></td>
 265       </tr>
 266     </table>
 267   </td>
 268 </tr>
 269   <tr>
 270     <td colspan="2" class="summary">
 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 <!-- ==================== METHOD DETAILS ==================== -->
 278 <a name="section-MethodDetails"></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">Method Details</span></td>
 286         <td align="right" valign="top"
 287          ><span class="options">[<a href="#section-MethodDetails"
 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="__init__"></a>
 296 <div>
 297 <table class="details" border="1" cellpadding="3"
 298        cellspacing="0" width="100%" bgcolor="white">
 299 <tr><td>
 300   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 301   <tr valign="top"><td>
 302   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
 303         <span class="sig-arg">form</span>)</span>
 304     <br /><em class="fname">(Constructor)</em>
 305   </h3>
 306   </td><td align="right" valign="top"
 307     ><span class="codelink"><a href="lxml.html-pysrc.html#InputGetter.__init__">source&nbsp;code</a></span>&nbsp;
 308     </td>
 309   </tr></table>
 310
 311   x.__init__(...) initializes x; see help(type(x)) for signature
 312   <dl class="fields">
 313     <dt>Overrides:
 314         object.__init__
 315         <dd><em class="note">(inherited documentation)</em></dd>
 316     </dt>
 317   </dl>
 318 </td></tr></table>
 319 </div>
 320 <a name="__repr__"></a>
 321 <div>
 322 <table class="details" border="1" cellpadding="3"
 323        cellspacing="0" width="100%" bgcolor="white">
 324 <tr><td>
 325   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 326   <tr valign="top"><td>
 327   <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span>
 328     <br /><em class="fname">(Representation operator)</em>
 329   </h3>
 330   </td><td align="right" valign="top"
 331     ><span class="codelink"><a href="lxml.html-pysrc.html#InputGetter.__repr__">source&nbsp;code</a></span>&nbsp;
 332     </td>
 333   </tr></table>
 334
 335   repr(x)
 336   <dl class="fields">
 337     <dt>Overrides:
 338         object.__repr__
 339         <dd><em class="note">(inherited documentation)</em></dd>
 340     </dt>
 341   </dl>
 342 </td></tr></table>
 343 </div>
 344 <br />
 345 <!-- ==================== CLASS VARIABLE DETAILS ==================== -->
 346 <a name="section-ClassVariableDetails"></a>
 347 <table class="details" border="1" cellpadding="3"
 348        cellspacing="0" width="100%" bgcolor="white">
 349 <tr bgcolor="#70b0f0" class="table-header">
 350   <td colspan="2" class="table-header">
 351     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 352       <tr valign="top">
 353         <td align="left"><span class="table-header">Class Variable Details</span></td>
 354         <td align="right" valign="top"
 355          ><span class="options">[<a href="#section-ClassVariableDetails"
 356          class="privatelink" onclick="toggle_private();"
 357          >hide private</a>]</span></td>
 358       </tr>
 359     </table>
 360   </td>
 361 </tr>
 362 </table>
 363 <a name="_name_xpath"></a>
 364 <div class="private">
 365 <table class="details" border="1" cellpadding="3"
 366        cellspacing="0" width="100%" bgcolor="white">
 367 <tr><td>
 368   <h3 class="epydoc">_name_xpath</h3>
 369
 370   <dl class="fields">
 371   </dl>
 372   <dl class="fields">
 373     <dt>Value:</dt>
 374       <dd><table><tr><td><pre class="variable">
 375 .//*[@name = $name and (local-name(.) = 'select' or local-name(.) = 'i<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
 376 nput' or local-name(.) = 'textarea')]
 377 </pre></td></tr></table>
 378 </dd>
 379   </dl>
 380 </td></tr></table>
 381 </div>
 382 <a name="_all_xpath"></a>
 383 <div class="private">
 384 <table class="details" border="1" cellpadding="3"
 385        cellspacing="0" width="100%" bgcolor="white">
 386 <tr><td>
 387   <h3 class="epydoc">_all_xpath</h3>
 388
 389   <dl class="fields">
 390   </dl>
 391   <dl class="fields">
 392     <dt>Value:</dt>
 393       <dd><table><tr><td><pre class="variable">
 394 .//*[local-name() = 'select' or local-name() = 'input' or local-name()<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
 395  = 'textarea']
 396 </pre></td></tr></table>
 397 </dd>
 398   </dl>
 399 </td></tr></table>
 400 </div>
 401 <br />
 402 <!-- ==================== NAVIGATION BAR ==================== -->
 403 <table class="navbar" border="0" width="100%" cellpadding="0"
 404        bgcolor="#a0c0ff" cellspacing="0">
 405   <tr valign="middle">
 406   <!-- Home link -->
 407       <th>&nbsp;&nbsp;&nbsp;<a
 408         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 409
 410   <!-- Tree link -->
 411       <th>&nbsp;&nbsp;&nbsp;<a
 412         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 413
 414   <!-- Index link -->
 415       <th>&nbsp;&nbsp;&nbsp;<a
 416         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 417
 418   <!-- Help link -->
 419       <th>&nbsp;&nbsp;&nbsp;<a
 420         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 421
 422   <!-- Project homepage -->
 423       <th class="navbar" align="right" width="100%">
 424         <table border="0" cellpadding="0" cellspacing="0">
 425           <tr><th class="navbar" align="center"
 426             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 427           </tr></table></th>
 428   </tr>
 429 </table>
 430 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 431   <tr>
 432     <td align="left" class="footer">
 433     Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:19 2012
 434     </td>
 435     <td align="right" class="footer">
 436       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 437         >http://epydoc.sourceforge.net</a>
 438     </td>
 439   </tr>
 440 </table>
 441
 442 <script type="text/javascript">
 443   <!--
 444   // Private objects are initially displayed (because if
 445   // javascript is turned off then we want them to be
 446   // visible); but by default, we want to hide them.  So hide
 447   // them unless we have a cookie that says to show them.
 448   checkCookie();
 449   // -->
 450 </script>
 451 </body>
 452 </html>