doc/html/api/lxml.html.CheckboxValues-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.CheckboxValues</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         CheckboxValues ::
  48         Class&nbsp;CheckboxValues
  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.CheckboxValues-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 CheckboxValues</h1><p class="nomargin-top"><span class="codelink"><a href="lxml.html-pysrc.html#CheckboxValues">source&nbsp;code</a></span></p>
  66 <pre class="base-tree">
  67        object --+
  68                 |
  69     _abcoll.Sized --+
  70                     |
  71        object --+   |
  72                 |   |
  73  _abcoll.Iterable --+
  74                     |
  75        object --+   |
  76                 |   |
  77 _abcoll.Container --+
  78                     |
  79           _abcoll.Set --+
  80                         |
  81        _abcoll.MutableSet --+
  82                             |
  83            _setmixin.SetMixin --+
  84                                 |
  85                                <strong class="uidshort">CheckboxValues</strong>
  86 </pre>
  87
  88 <hr />
  89 Represents the values of the checked checkboxes in a group of
  90 checkboxes with the same name.
  91
  92 <!-- ==================== NESTED CLASSES ==================== -->
  93 <a name="section-NestedClasses"></a>
  94 <table class="summary" border="1" cellpadding="3"
  95        cellspacing="0" width="100%" bgcolor="white">
  96 <tr bgcolor="#70b0f0" class="table-header">
  97   <td colspan="2" class="table-header">
  98     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  99       <tr valign="top">
 100         <td align="left"><span class="table-header">Nested Classes</span></td>
 101         <td align="right" valign="top"
 102          ><span class="options">[<a href="#section-NestedClasses"
 103          class="privatelink" onclick="toggle_private();"
 104          >hide private</a>]</span></td>
 105       </tr>
 106     </table>
 107   </td>
 108 </tr>
 109   <tr>
 110     <td colspan="2" class="summary">
 111     <p class="indent-wrapped-lines"><b>Inherited from <code>_abcoll.Sized</code></b>:
 112       <code><a href="abc.ABCMeta-class.html">__metaclass__</a></code>
 113       </p>
 114     </td>
 115   </tr>
 116 </table>
 117 <!-- ==================== INSTANCE METHODS ==================== -->
 118 <a name="section-InstanceMethods"></a>
 119 <table class="summary" border="1" cellpadding="3"
 120        cellspacing="0" width="100%" bgcolor="white">
 121 <tr bgcolor="#70b0f0" class="table-header">
 122   <td colspan="2" class="table-header">
 123     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 124       <tr valign="top">
 125         <td align="left"><span class="table-header">Instance Methods</span></td>
 126         <td align="right" valign="top"
 127          ><span class="options">[<a href="#section-InstanceMethods"
 128          class="privatelink" onclick="toggle_private();"
 129          >hide private</a>]</span></td>
 130       </tr>
 131     </table>
 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 href="lxml.html.CheckboxValues-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
 141         <span class="summary-sig-arg">group</span>)</span><br />
 142       x.__init__(...) initializes x; see help(type(x)) for signature</td>
 143           <td align="right" valign="top">
 144             <span class="codelink"><a href="lxml.html-pysrc.html#CheckboxValues.__init__">source&nbsp;code</a></span>
 145
 146           </td>
 147         </tr>
 148       </table>
 149
 150     </td>
 151   </tr>
 152 <tr>
 153     <td width="15%" align="right" valign="top" class="summary">
 154       <span class="summary-type">&nbsp;</span>
 155     </td><td class="summary">
 156       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 157         <tr>
 158           <td><span class="summary-sig"><a href="lxml.html.CheckboxValues-class.html#__iter__" class="summary-sig-name">__iter__</a>(<span class="summary-sig-arg">self</span>)</span></td>
 159           <td align="right" valign="top">
 160             <span class="codelink"><a href="lxml.html-pysrc.html#CheckboxValues.__iter__">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 href="lxml.html.CheckboxValues-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br />
 175       repr(x)</td>
 176           <td align="right" valign="top">
 177             <span class="codelink"><a href="lxml.html-pysrc.html#CheckboxValues.__repr__">source&nbsp;code</a></span>
 178
 179           </td>
 180         </tr>
 181       </table>
 182
 183     </td>
 184   </tr>
 185 <tr>
 186     <td width="15%" align="right" valign="top" class="summary">
 187       <span class="summary-type">&nbsp;</span>
 188     </td><td class="summary">
 189       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 190         <tr>
 191           <td><span class="summary-sig"><a href="lxml.html.CheckboxValues-class.html#add" class="summary-sig-name">add</a>(<span class="summary-sig-arg">self</span>,
 192         <span class="summary-sig-arg">value</span>)</span><br />
 193       Add an element.</td>
 194           <td align="right" valign="top">
 195             <span class="codelink"><a href="lxml.html-pysrc.html#CheckboxValues.add">source&nbsp;code</a></span>
 196
 197           </td>
 198         </tr>
 199       </table>
 200
 201     </td>
 202   </tr>
 203 <tr>
 204     <td width="15%" align="right" valign="top" class="summary">
 205       <span class="summary-type">&nbsp;</span>
 206     </td><td class="summary">
 207       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 208         <tr>
 209           <td><span class="summary-sig"><a href="lxml.html.CheckboxValues-class.html#remove" class="summary-sig-name">remove</a>(<span class="summary-sig-arg">self</span>,
 210         <span class="summary-sig-arg">value</span>)</span><br />
 211       Remove an element. If not a member, raise a KeyError.</td>
 212           <td align="right" valign="top">
 213             <span class="codelink"><a href="lxml.html-pysrc.html#CheckboxValues.remove">source&nbsp;code</a></span>
 214
 215           </td>
 216         </tr>
 217       </table>
 218
 219     </td>
 220   </tr>
 221   <tr>
 222     <td colspan="2" class="summary">
 223     <p class="indent-wrapped-lines"><b>Inherited from <code>_setmixin.SetMixin</code></b>:
 224       <code>__contains__</code>,
 225       <code>__len__</code>,
 226       <code>copy</code>,
 227       <code>difference</code>,
 228       <code>difference_update</code>,
 229       <code>discard</code>,
 230       <code>intersection</code>,
 231       <code>intersection_update</code>,
 232       <code>issubset</code>,
 233       <code>issuperset</code>,
 234       <code>symmetric_difference</code>,
 235       <code>symmetric_difference_update</code>,
 236       <code>union</code>,
 237       <code>update</code>
 238       </p>
 239     <p class="indent-wrapped-lines"><b>Inherited from <code>_abcoll.MutableSet</code></b>:
 240       <code>__iand__</code>,
 241       <code>__ior__</code>,
 242       <code>__isub__</code>,
 243       <code>__ixor__</code>,
 244       <code>clear</code>,
 245       <code>pop</code>
 246       </p>
 247     <p class="indent-wrapped-lines"><b>Inherited from <code>_abcoll.Set</code></b>:
 248       <code>__and__</code>,
 249       <code>__eq__</code>,
 250       <code>__ge__</code>,
 251       <code>__gt__</code>,
 252       <code>__le__</code>,
 253       <code>__lt__</code>,
 254       <code>__ne__</code>,
 255       <code>__or__</code>,
 256       <code>__rand__</code>,
 257       <code>__ror__</code>,
 258       <code>__rsub__</code>,
 259       <code>__rxor__</code>,
 260       <code>__sub__</code>,
 261       <code>__xor__</code>,
 262       <code>isdisjoint</code>
 263       </p>
 264     <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code>_abcoll.Set</code></b> (private):
 265       <code>_hash</code>
 266       </p></div>
 267     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 268       <code>__delattr__</code>,
 269       <code>__format__</code>,
 270       <code>__getattribute__</code>,
 271       <code>__new__</code>,
 272       <code>__reduce__</code>,
 273       <code>__reduce_ex__</code>,
 274       <code>__setattr__</code>,
 275       <code>__sizeof__</code>,
 276       <code>__str__</code>
 277       </p>
 278     </td>
 279   </tr>
 280 </table>
 281 <!-- ==================== CLASS METHODS ==================== -->
 282 <a name="section-ClassMethods"></a>
 283 <table class="summary" border="1" cellpadding="3"
 284        cellspacing="0" width="100%" bgcolor="white">
 285 <tr bgcolor="#70b0f0" class="table-header">
 286   <td colspan="2" class="table-header">
 287     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 288       <tr valign="top">
 289         <td align="left"><span class="table-header">Class Methods</span></td>
 290         <td align="right" valign="top"
 291          ><span class="options">[<a href="#section-ClassMethods"
 292          class="privatelink" onclick="toggle_private();"
 293          >hide private</a>]</span></td>
 294       </tr>
 295     </table>
 296   </td>
 297 </tr>
 298   <tr>
 299     <td colspan="2" class="summary">
 300     <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code>_setmixin.SetMixin</code></b> (private):
 301       <code>_from_iterable</code>
 302       </p></div>
 303     <p class="indent-wrapped-lines"><b>Inherited from <code>_abcoll.Sized</code></b>:
 304       <code>__subclasshook__</code>
 305       </p>
 306     </td>
 307   </tr>
 308 </table>
 309 <!-- ==================== CLASS VARIABLES ==================== -->
 310 <a name="section-ClassVariables"></a>
 311 <table class="summary" border="1" cellpadding="3"
 312        cellspacing="0" width="100%" bgcolor="white">
 313 <tr bgcolor="#70b0f0" class="table-header">
 314   <td colspan="2" class="table-header">
 315     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 316       <tr valign="top">
 317         <td align="left"><span class="table-header">Class Variables</span></td>
 318         <td align="right" valign="top"
 319          ><span class="options">[<a href="#section-ClassVariables"
 320          class="privatelink" onclick="toggle_private();"
 321          >hide private</a>]</span></td>
 322       </tr>
 323     </table>
 324   </td>
 325 </tr>
 326 <tr>
 327     <td width="15%" align="right" valign="top" class="summary">
 328       <span class="summary-type">&nbsp;</span>
 329     </td><td class="summary">
 330         <a name="__abstractmethods__"></a><span class="summary-name">__abstractmethods__</span> = <code title="frozenset([])"><code class="variable-group">frozenset([</code><code class="variable-group">])</code></code>
 331     </td>
 332   </tr>
 333   <tr>
 334     <td colspan="2" class="summary">
 335     <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code>_setmixin.SetMixin</code></b> (private):
 336       <code>_abc_negative_cache</code>,
 337       <code>_abc_negative_cache_version</code>,
 338       <code>_abc_registry</code>
 339       </p></div>
 340     <p class="indent-wrapped-lines"><b>Inherited from <code>_abcoll.Set</code></b>:
 341       <code>__hash__</code>
 342       </p>
 343     <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code>_abcoll.Sized</code></b> (private):
 344       <code>_abc_cache</code>
 345       </p></div>
 346     </td>
 347   </tr>
 348 </table>
 349 <!-- ==================== PROPERTIES ==================== -->
 350 <a name="section-Properties"></a>
 351 <table class="summary" border="1" cellpadding="3"
 352        cellspacing="0" width="100%" bgcolor="white">
 353 <tr bgcolor="#70b0f0" class="table-header">
 354   <td colspan="2" class="table-header">
 355     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 356       <tr valign="top">
 357         <td align="left"><span class="table-header">Properties</span></td>
 358         <td align="right" valign="top"
 359          ><span class="options">[<a href="#section-Properties"
 360          class="privatelink" onclick="toggle_private();"
 361          >hide private</a>]</span></td>
 362       </tr>
 363     </table>
 364   </td>
 365 </tr>
 366   <tr>
 367     <td colspan="2" class="summary">
 368     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 369       <code>__class__</code>
 370       </p>
 371     </td>
 372   </tr>
 373 </table>
 374 <!-- ==================== METHOD DETAILS ==================== -->
 375 <a name="section-MethodDetails"></a>
 376 <table class="details" border="1" cellpadding="3"
 377        cellspacing="0" width="100%" bgcolor="white">
 378 <tr bgcolor="#70b0f0" class="table-header">
 379   <td colspan="2" class="table-header">
 380     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 381       <tr valign="top">
 382         <td align="left"><span class="table-header">Method Details</span></td>
 383         <td align="right" valign="top"
 384          ><span class="options">[<a href="#section-MethodDetails"
 385          class="privatelink" onclick="toggle_private();"
 386          >hide private</a>]</span></td>
 387       </tr>
 388     </table>
 389   </td>
 390 </tr>
 391 </table>
 392 <a name="__init__"></a>
 393 <div>
 394 <table class="details" border="1" cellpadding="3"
 395        cellspacing="0" width="100%" bgcolor="white">
 396 <tr><td>
 397   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 398   <tr valign="top"><td>
 399   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
 400         <span class="sig-arg">group</span>)</span>
 401     <br /><em class="fname">(Constructor)</em>
 402   </h3>
 403   </td><td align="right" valign="top"
 404     ><span class="codelink"><a href="lxml.html-pysrc.html#CheckboxValues.__init__">source&nbsp;code</a></span>&nbsp;
 405     </td>
 406   </tr></table>
 407
 408   x.__init__(...) initializes x; see help(type(x)) for signature
 409   <dl class="fields">
 410     <dt>Overrides:
 411         object.__init__
 412         <dd><em class="note">(inherited documentation)</em></dd>
 413     </dt>
 414   </dl>
 415 </td></tr></table>
 416 </div>
 417 <a name="__iter__"></a>
 418 <div>
 419 <table class="details" border="1" cellpadding="3"
 420        cellspacing="0" width="100%" bgcolor="white">
 421 <tr><td>
 422   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 423   <tr valign="top"><td>
 424   <h3 class="epydoc"><span class="sig"><span class="sig-name">__iter__</span>(<span class="sig-arg">self</span>)</span>
 425   </h3>
 426   </td><td align="right" valign="top"
 427     ><span class="codelink"><a href="lxml.html-pysrc.html#CheckboxValues.__iter__">source&nbsp;code</a></span>&nbsp;
 428     </td>
 429   </tr></table>
 430
 431
 432   <dl class="fields">
 433     <dt>Overrides:
 434         _abcoll.Iterable.__iter__
 435     </dt>
 436   </dl>
 437 </td></tr></table>
 438 </div>
 439 <a name="__repr__"></a>
 440 <div>
 441 <table class="details" border="1" cellpadding="3"
 442        cellspacing="0" width="100%" bgcolor="white">
 443 <tr><td>
 444   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 445   <tr valign="top"><td>
 446   <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span>
 447     <br /><em class="fname">(Representation operator)</em>
 448   </h3>
 449   </td><td align="right" valign="top"
 450     ><span class="codelink"><a href="lxml.html-pysrc.html#CheckboxValues.__repr__">source&nbsp;code</a></span>&nbsp;
 451     </td>
 452   </tr></table>
 453
 454   repr(x)
 455   <dl class="fields">
 456     <dt>Overrides:
 457         object.__repr__
 458         <dd><em class="note">(inherited documentation)</em></dd>
 459     </dt>
 460   </dl>
 461 </td></tr></table>
 462 </div>
 463 <a name="add"></a>
 464 <div>
 465 <table class="details" border="1" cellpadding="3"
 466        cellspacing="0" width="100%" bgcolor="white">
 467 <tr><td>
 468   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 469   <tr valign="top"><td>
 470   <h3 class="epydoc"><span class="sig"><span class="sig-name">add</span>(<span class="sig-arg">self</span>,
 471         <span class="sig-arg">value</span>)</span>
 472   </h3>
 473   </td><td align="right" valign="top"
 474     ><span class="codelink"><a href="lxml.html-pysrc.html#CheckboxValues.add">source&nbsp;code</a></span>&nbsp;
 475     </td>
 476   </tr></table>
 477
 478   Add an element.
 479   <dl class="fields">
 480     <dt>Overrides:
 481         _abcoll.MutableSet.add
 482         <dd><em class="note">(inherited documentation)</em></dd>
 483     </dt>
 484   </dl>
 485 </td></tr></table>
 486 </div>
 487 <a name="remove"></a>
 488 <div>
 489 <table class="details" border="1" cellpadding="3"
 490        cellspacing="0" width="100%" bgcolor="white">
 491 <tr><td>
 492   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 493   <tr valign="top"><td>
 494   <h3 class="epydoc"><span class="sig"><span class="sig-name">remove</span>(<span class="sig-arg">self</span>,
 495         <span class="sig-arg">value</span>)</span>
 496   </h3>
 497   </td><td align="right" valign="top"
 498     ><span class="codelink"><a href="lxml.html-pysrc.html#CheckboxValues.remove">source&nbsp;code</a></span>&nbsp;
 499     </td>
 500   </tr></table>
 501
 502   Remove an element. If not a member, raise a KeyError.
 503   <dl class="fields">
 504     <dt>Overrides:
 505         _abcoll.MutableSet.remove
 506         <dd><em class="note">(inherited documentation)</em></dd>
 507     </dt>
 508   </dl>
 509 </td></tr></table>
 510 </div>
 511 <br />
 512 <!-- ==================== NAVIGATION BAR ==================== -->
 513 <table class="navbar" border="0" width="100%" cellpadding="0"
 514        bgcolor="#a0c0ff" cellspacing="0">
 515   <tr valign="middle">
 516   <!-- Home link -->
 517       <th>&nbsp;&nbsp;&nbsp;<a
 518         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 519
 520   <!-- Tree link -->
 521       <th>&nbsp;&nbsp;&nbsp;<a
 522         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 523
 524   <!-- Index link -->
 525       <th>&nbsp;&nbsp;&nbsp;<a
 526         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 527
 528   <!-- Help link -->
 529       <th>&nbsp;&nbsp;&nbsp;<a
 530         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 531
 532   <!-- Project homepage -->
 533       <th class="navbar" align="right" width="100%">
 534         <table border="0" cellpadding="0" cellspacing="0">
 535           <tr><th class="navbar" align="center"
 536             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 537           </tr></table></th>
 538   </tr>
 539 </table>
 540 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 541   <tr>
 542     <td align="left" class="footer">
 543     Generated by Epydoc 3.0.1
 544     on Thu Jul  9 18:29:53 2020
 545     </td>
 546     <td align="right" class="footer">
 547       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 548         >http://epydoc.sourceforge.net</a>
 549     </td>
 550   </tr>
 551 </table>
 552
 553 <script type="text/javascript">
 554   <!--
 555   // Private objects are initially displayed (because if
 556   // javascript is turned off then we want them to be
 557   // visible); but by default, we want to hide them.  So hide
 558   // them unless we have a cookie that says to show them.
 559   checkCookie();
 560   // -->
 561 </script>
 562 </body>
 563 </html>