doc/html/api/lxml.html.RadioGroup-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.RadioGroup</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;RadioGroup
  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.RadioGroup-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 RadioGroup</h1><p class="nomargin-top"><span class="codelink"><a href="lxml.html-pysrc.html#RadioGroup">source&nbsp;code</a></span></p>
  65 <pre class="base-tree">
  66 object --+
  67          |
  68       list --+
  69              |
  70             <strong class="uidshort">RadioGroup</strong>
  71 </pre>
  72
  73 <hr />
  74 <p>This object represents several <tt class="rst-rst-rst-docutils literal rst-rst-docutils literal rst-docutils literal">&lt;input type=radio&gt;</tt> elements
  75 that have the same name.</p>
  76 <p>You can use this like a list, but also use the property
  77 <tt class="rst-docutils literal">.value</tt> to check/uncheck inputs.  Also you can use
  78 <tt class="rst-docutils literal">.value_options</tt> to get the possible values.</p>
  79
  80 <!-- ==================== INSTANCE METHODS ==================== -->
  81 <a name="section-InstanceMethods"></a>
  82 <table class="summary" border="1" cellpadding="3"
  83        cellspacing="0" width="100%" bgcolor="white">
  84 <tr bgcolor="#70b0f0" class="table-header">
  85   <td colspan="2" class="table-header">
  86     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  87       <tr valign="top">
  88         <td align="left"><span class="table-header">Instance Methods</span></td>
  89         <td align="right" valign="top"
  90          ><span class="options">[<a href="#section-InstanceMethods"
  91          class="privatelink" onclick="toggle_private();"
  92          >hide private</a>]</span></td>
  93       </tr>
  94     </table>
  95   </td>
  96 </tr>
  97 <tr class="private">
  98     <td width="15%" align="right" valign="top" class="summary">
  99       <span class="summary-type">&nbsp;</span>
 100     </td><td class="summary">
 101       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 102         <tr>
 103           <td><span class="summary-sig"><a name="_value__get"></a><span class="summary-sig-name">_value__get</span>(<span class="summary-sig-arg">self</span>)</span><br />
 104       Get/set the value, which checks the radio with that value (and
 105 unchecks any other value).</td>
 106           <td align="right" valign="top">
 107             <span class="codelink"><a href="lxml.html-pysrc.html#RadioGroup._value__get">source&nbsp;code</a></span>
 108
 109           </td>
 110         </tr>
 111       </table>
 112
 113     </td>
 114   </tr>
 115 <tr class="private">
 116     <td width="15%" align="right" valign="top" class="summary">
 117       <span class="summary-type">&nbsp;</span>
 118     </td><td class="summary">
 119       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 120         <tr>
 121           <td><span class="summary-sig"><a name="_value__set"></a><span class="summary-sig-name">_value__set</span>(<span class="summary-sig-arg">self</span>,
 122         <span class="summary-sig-arg">value</span>)</span></td>
 123           <td align="right" valign="top">
 124             <span class="codelink"><a href="lxml.html-pysrc.html#RadioGroup._value__set">source&nbsp;code</a></span>
 125
 126           </td>
 127         </tr>
 128       </table>
 129
 130     </td>
 131   </tr>
 132 <tr class="private">
 133     <td width="15%" align="right" valign="top" class="summary">
 134       <span class="summary-type">&nbsp;</span>
 135     </td><td class="summary">
 136       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 137         <tr>
 138           <td><span class="summary-sig"><a name="_value__del"></a><span class="summary-sig-name">_value__del</span>(<span class="summary-sig-arg">self</span>)</span></td>
 139           <td align="right" valign="top">
 140             <span class="codelink"><a href="lxml.html-pysrc.html#RadioGroup._value__del">source&nbsp;code</a></span>
 141
 142           </td>
 143         </tr>
 144       </table>
 145
 146     </td>
 147   </tr>
 148 <tr>
 149     <td width="15%" align="right" valign="top" class="summary">
 150       <span class="summary-type">&nbsp;</span>
 151     </td><td class="summary">
 152       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 153         <tr>
 154           <td><span class="summary-sig"><a href="lxml.html.RadioGroup-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br />
 155       repr(x)</td>
 156           <td align="right" valign="top">
 157             <span class="codelink"><a href="lxml.html-pysrc.html#RadioGroup.__repr__">source&nbsp;code</a></span>
 158
 159           </td>
 160         </tr>
 161       </table>
 162
 163     </td>
 164   </tr>
 165   <tr>
 166     <td colspan="2" class="summary">
 167     <p class="indent-wrapped-lines"><b>Inherited from <code>list</code></b>:
 168       <code>__add__</code>,
 169       <code>__contains__</code>,
 170       <code>__delitem__</code>,
 171       <code>__delslice__</code>,
 172       <code>__eq__</code>,
 173       <code>__ge__</code>,
 174       <code>__getattribute__</code>,
 175       <code>__getitem__</code>,
 176       <code>__getslice__</code>,
 177       <code>__gt__</code>,
 178       <code>__iadd__</code>,
 179       <code>__imul__</code>,
 180       <code>__init__</code>,
 181       <code>__iter__</code>,
 182       <code>__le__</code>,
 183       <code>__len__</code>,
 184       <code>__lt__</code>,
 185       <code>__mul__</code>,
 186       <code>__ne__</code>,
 187       <code>__new__</code>,
 188       <code>__reversed__</code>,
 189       <code>__rmul__</code>,
 190       <code>__setitem__</code>,
 191       <code>__setslice__</code>,
 192       <code>__sizeof__</code>,
 193       <code>append</code>,
 194       <code>count</code>,
 195       <code>extend</code>,
 196       <code>index</code>,
 197       <code>insert</code>,
 198       <code>pop</code>,
 199       <code>remove</code>,
 200       <code>reverse</code>,
 201       <code>sort</code>
 202       </p>
 203     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 204       <code>__delattr__</code>,
 205       <code>__format__</code>,
 206       <code>__reduce__</code>,
 207       <code>__reduce_ex__</code>,
 208       <code>__setattr__</code>,
 209       <code>__str__</code>,
 210       <code>__subclasshook__</code>
 211       </p>
 212     </td>
 213   </tr>
 214 </table>
 215 <!-- ==================== CLASS VARIABLES ==================== -->
 216 <a name="section-ClassVariables"></a>
 217 <table class="summary" border="1" cellpadding="3"
 218        cellspacing="0" width="100%" bgcolor="white">
 219 <tr bgcolor="#70b0f0" class="table-header">
 220   <td colspan="2" class="table-header">
 221     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 222       <tr valign="top">
 223         <td align="left"><span class="table-header">Class Variables</span></td>
 224         <td align="right" valign="top"
 225          ><span class="options">[<a href="#section-ClassVariables"
 226          class="privatelink" onclick="toggle_private();"
 227          >hide private</a>]</span></td>
 228       </tr>
 229     </table>
 230   </td>
 231 </tr>
 232   <tr>
 233     <td colspan="2" class="summary">
 234     <p class="indent-wrapped-lines"><b>Inherited from <code>list</code></b>:
 235       <code>__hash__</code>
 236       </p>
 237     </td>
 238   </tr>
 239 </table>
 240 <!-- ==================== PROPERTIES ==================== -->
 241 <a name="section-Properties"></a>
 242 <table class="summary" border="1" cellpadding="3"
 243        cellspacing="0" width="100%" bgcolor="white">
 244 <tr bgcolor="#70b0f0" class="table-header">
 245   <td colspan="2" class="table-header">
 246     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 247       <tr valign="top">
 248         <td align="left"><span class="table-header">Properties</span></td>
 249         <td align="right" valign="top"
 250          ><span class="options">[<a href="#section-Properties"
 251          class="privatelink" onclick="toggle_private();"
 252          >hide private</a>]</span></td>
 253       </tr>
 254     </table>
 255   </td>
 256 </tr>
 257 <tr>
 258     <td width="15%" align="right" valign="top" class="summary">
 259       <span class="summary-type">&nbsp;</span>
 260     </td><td class="summary">
 261         <a href="lxml.html.RadioGroup-class.html#value" class="summary-name">value</a><br />
 262       Get/set the value, which checks the radio with that value (and
 263 unchecks any other value).
 264     </td>
 265   </tr>
 266 <tr>
 267     <td width="15%" align="right" valign="top" class="summary">
 268       <span class="summary-type">&nbsp;</span>
 269     </td><td class="summary">
 270         <a href="lxml.html.RadioGroup-class.html#value_options" class="summary-name">value_options</a><br />
 271       Returns a list of all the possible values.
 272     </td>
 273   </tr>
 274   <tr>
 275     <td colspan="2" class="summary">
 276     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 277       <code>__class__</code>
 278       </p>
 279     </td>
 280   </tr>
 281 </table>
 282 <!-- ==================== METHOD DETAILS ==================== -->
 283 <a name="section-MethodDetails"></a>
 284 <table class="details" border="1" cellpadding="3"
 285        cellspacing="0" width="100%" bgcolor="white">
 286 <tr bgcolor="#70b0f0" class="table-header">
 287   <td colspan="2" class="table-header">
 288     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 289       <tr valign="top">
 290         <td align="left"><span class="table-header">Method Details</span></td>
 291         <td align="right" valign="top"
 292          ><span class="options">[<a href="#section-MethodDetails"
 293          class="privatelink" onclick="toggle_private();"
 294          >hide private</a>]</span></td>
 295       </tr>
 296     </table>
 297   </td>
 298 </tr>
 299 </table>
 300 <a name="__repr__"></a>
 301 <div>
 302 <table class="details" border="1" cellpadding="3"
 303        cellspacing="0" width="100%" bgcolor="white">
 304 <tr><td>
 305   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 306   <tr valign="top"><td>
 307   <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span>
 308     <br /><em class="fname">(Representation operator)</em>
 309   </h3>
 310   </td><td align="right" valign="top"
 311     ><span class="codelink"><a href="lxml.html-pysrc.html#RadioGroup.__repr__">source&nbsp;code</a></span>&nbsp;
 312     </td>
 313   </tr></table>
 314
 315   repr(x)
 316   <dl class="fields">
 317     <dt>Overrides:
 318         object.__repr__
 319         <dd><em class="note">(inherited documentation)</em></dd>
 320     </dt>
 321   </dl>
 322 </td></tr></table>
 323 </div>
 324 <br />
 325 <!-- ==================== PROPERTY DETAILS ==================== -->
 326 <a name="section-PropertyDetails"></a>
 327 <table class="details" border="1" cellpadding="3"
 328        cellspacing="0" width="100%" bgcolor="white">
 329 <tr bgcolor="#70b0f0" class="table-header">
 330   <td colspan="2" class="table-header">
 331     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 332       <tr valign="top">
 333         <td align="left"><span class="table-header">Property Details</span></td>
 334         <td align="right" valign="top"
 335          ><span class="options">[<a href="#section-PropertyDetails"
 336          class="privatelink" onclick="toggle_private();"
 337          >hide private</a>]</span></td>
 338       </tr>
 339     </table>
 340   </td>
 341 </tr>
 342 </table>
 343 <a name="value"></a>
 344 <div>
 345 <table class="details" border="1" cellpadding="3"
 346        cellspacing="0" width="100%" bgcolor="white">
 347 <tr><td>
 348   <h3 class="epydoc">value</h3>
 349   Get/set the value, which checks the radio with that value (and
 350 unchecks any other value).
 351   <dl class="fields">
 352     <dt>Get Method:</dt>
 353     <dd class="value"><span class="summary-sig"><a href="lxml.html.RadioGroup-class.html#_value__get" class="summary-sig-name" onclick="show_private();">_value__get</a>(<span class="summary-sig-arg">self</span>)</span>
 354         - Get/set the value, which checks the radio with that value (and
 355 unchecks any other value).
 356     </dd>
 357     <dt>Set Method:</dt>
 358     <dd class="value"><span class="summary-sig"><a href="lxml.html.RadioGroup-class.html#_value__set" class="summary-sig-name" onclick="show_private();">_value__set</a>(<span class="summary-sig-arg">self</span>,
 359         <span class="summary-sig-arg">value</span>)</span>
 360     </dd>
 361     <dt>Delete Method:</dt>
 362     <dd class="value"><span class="summary-sig"><a href="lxml.html.RadioGroup-class.html#_value__del" class="summary-sig-name" onclick="show_private();">_value__del</a>(<span class="summary-sig-arg">self</span>)</span>
 363     </dd>
 364   </dl>
 365 </td></tr></table>
 366 </div>
 367 <a name="value_options"></a>
 368 <div>
 369 <table class="details" border="1" cellpadding="3"
 370        cellspacing="0" width="100%" bgcolor="white">
 371 <tr><td>
 372   <h3 class="epydoc">value_options</h3>
 373   Returns a list of all the possible values.
 374   <dl class="fields">
 375     <dt>Get Method:</dt>
 376     <dd class="value"><span class="summary-sig"><i>unreachable</i>.value_options(<span class="summary-sig-arg">self</span>)</span>
 377         - Returns a list of all the possible values.
 378     </dd>
 379   </dl>
 380 </td></tr></table>
 381 </div>
 382 <br />
 383 <!-- ==================== NAVIGATION BAR ==================== -->
 384 <table class="navbar" border="0" width="100%" cellpadding="0"
 385        bgcolor="#a0c0ff" cellspacing="0">
 386   <tr valign="middle">
 387   <!-- Home link -->
 388       <th>&nbsp;&nbsp;&nbsp;<a
 389         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 390
 391   <!-- Tree link -->
 392       <th>&nbsp;&nbsp;&nbsp;<a
 393         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 394
 395   <!-- Index link -->
 396       <th>&nbsp;&nbsp;&nbsp;<a
 397         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 398
 399   <!-- Help link -->
 400       <th>&nbsp;&nbsp;&nbsp;<a
 401         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 402
 403   <!-- Project homepage -->
 404       <th class="navbar" align="right" width="100%">
 405         <table border="0" cellpadding="0" cellspacing="0">
 406           <tr><th class="navbar" align="center"
 407             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 408           </tr></table></th>
 409   </tr>
 410 </table>
 411 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 412   <tr>
 413     <td align="left" class="footer">
 414     Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:19 2012
 415     </td>
 416     <td align="right" class="footer">
 417       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 418         >http://epydoc.sourceforge.net</a>
 419     </td>
 420   </tr>
 421 </table>
 422
 423 <script type="text/javascript">
 424   <!--
 425   // Private objects are initially displayed (because if
 426   // javascript is turned off then we want them to be
 427   // visible); but by default, we want to hide them.  So hide
 428   // them unless we have a cookie that says to show them.
 429   checkCookie();
 430   // -->
 431 </script>
 432 </body>
 433 </html>