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