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