docs/developer/wifi-radar.py/StatusWindow.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
   2           "http://www.w3.org/TR/html40/loose.dtd">
   3
   4 <html>
   5
   6   <head>
   7     <title>HappyDoc Generated Documentation</title>
   8   </head>
   9
  10   <body bgcolor="#ffffff">
  11
  12
  13         <table border="0" cellpadding="5" cellspacing="0" width="100%">
  14         <tr>
  15             <th rowspan="2"
  16                 valign="top"
  17                 align="left"
  18                 width="10%"
  19                 bgcolor="#88bbee"><font color="#000000">HappyDoc Generated Documentation</font>
  20             </th>
  21             <th bgcolor="#88bbee"
  22                 width="90%"
  23                 align="right"><font color="#000000">Class: StatusWindow</font>
  24             </th>
  25         </tr>
  26         <tr>
  27         <td>
  28         <!-- breadcrumbs -->
  29 <p><small>
  30 /&nbsp;<a href="../wifi-radar.html">wifi-radar.py</a>&nbsp;/&nbsp;StatusWindow&nbsp;</small></p>
  31
  32 <!-- /breadcrumbs -->
  33
  34 <p>A simple class for putting up a "Please wait" dialog so the user
  35  doesn't think we've forgotten about them.  Implements the status interface.</p>
  36 <table border="0" cellpadding="5" cellspacing="0" width="100%">
  37
  38         <tr>
  39             <th bgcolor="#99ccff"
  40                 rowspan="2"
  41                 valign="top"
  42                 align="left"
  43                 width="20%"
  44                 >
  45                 <font color="#000000">
  46                   <a name="">Methods</a>&nbsp;
  47                 </font>
  48             </th>
  49             <th bgcolor="#99ccff"
  50                 valign="top"
  51                 align="left"
  52                 width="80%"
  53                 >
  54                 <font color="#000000">&nbsp;</font>
  55             </th>
  56         </tr>
  57         <tr>
  58         <td>
  59         <table border="0" cellpadding="5" cellspacing="0" width="100%">
  60
  61         <tr>
  62             <th bgcolor="#99ccff"
  63                 rowspan="2"
  64                 valign="top"
  65                 align="left"
  66                 width="20%"
  67                 >
  68                 <font color="#000000">
  69                   <a name="hide"></a>&nbsp;
  70                 </font>
  71             </th>
  72             <th bgcolor="#99ccff"
  73                 valign="top"
  74                 align="left"
  75                 width="80%"
  76                 >
  77                 <font color="#000000">hide&nbsp;</font>
  78             </th>
  79         </tr>
  80         <tr>
  81         <td>
  82         <pre>
  83 hide ( self )
  84 </pre>
  85
  86 <p>Hide all the widgets of the StatusWindow.</p>
  87 <h4>Parameters:</h4>
  88 <p>        nothing</p>
  89 <h4>Returns:</h4>
  90 <p>        nothing</p>
  91 </td></tr>
  92 </table><table border="0" cellpadding="5" cellspacing="0" width="100%">
  93
  94         <tr>
  95             <th bgcolor="#99ccff"
  96                 rowspan="2"
  97                 valign="top"
  98                 align="left"
  99                 width="20%"
 100                 >
 101                 <font color="#000000">
 102                   <a name="update_message"></a>&nbsp;
 103                 </font>
 104             </th>
 105             <th bgcolor="#99ccff"
 106                 valign="top"
 107                 align="left"
 108                 width="80%"
 109                 >
 110                 <font color="#000000">update_message&nbsp;</font>
 111             </th>
 112         </tr>
 113         <tr>
 114         <td>
 115         <pre>
 116 update_message ( self,  message )
 117 </pre>
 118
 119 <p>Change the message displayed to the user.</p>
 120 <h4>Parameters:</h4>
 121 <dl>
 122 <dt>        <code>message</code></dt>
 123 <dd>string - The message to show to the user.</dd>
 124 </dl>
 125 <h4>Returns:</h4>
 126 <p>        nothing</p>
 127 </td></tr>
 128 </table><table border="0" cellpadding="5" cellspacing="0" width="100%">
 129
 130         <tr>
 131             <th bgcolor="#99ccff"
 132                 rowspan="2"
 133                 valign="top"
 134                 align="left"
 135                 width="20%"
 136                 >
 137                 <font color="#000000">
 138                   <a name="show"></a>&nbsp;
 139                 </font>
 140             </th>
 141             <th bgcolor="#99ccff"
 142                 valign="top"
 143                 align="left"
 144                 width="80%"
 145                 >
 146                 <font color="#000000">show&nbsp;</font>
 147             </th>
 148         </tr>
 149         <tr>
 150         <td>
 151         <pre>
 152 show ( self )
 153 </pre>
 154
 155 <p>Show all the widgets of the StatusWindow.</p>
 156 <h4>Parameters:</h4>
 157 <p>        nothing</p>
 158 <h4>Returns:</h4>
 159 <p>        nothing</p>
 160 </td></tr>
 161 </table><table border="0" cellpadding="5" cellspacing="0" width="100%">
 162
 163         <tr>
 164             <th bgcolor="#99ccff"
 165                 rowspan="2"
 166                 valign="top"
 167                 align="left"
 168                 width="20%"
 169                 >
 170                 <font color="#000000">
 171                   <a name="destroy"></a>&nbsp;
 172                 </font>
 173             </th>
 174             <th bgcolor="#99ccff"
 175                 valign="top"
 176                 align="left"
 177                 width="80%"
 178                 >
 179                 <font color="#000000">destroy&nbsp;</font>
 180             </th>
 181         </tr>
 182         <tr>
 183         <td>
 184         <pre>
 185 destroy ( self )
 186 </pre>
 187
 188 <p>Remove the StatusWindow.</p>
 189 <h4>Parameters:</h4>
 190 <p>        nothing</p>
 191 <h4>Returns:</h4>
 192 <p>        nothing</p>
 193 </td></tr>
 194 </table><table border="0" cellpadding="5" cellspacing="0" width="100%">
 195
 196         <tr>
 197             <th bgcolor="#99ccff"
 198                 rowspan="2"
 199                 valign="top"
 200                 align="left"
 201                 width="20%"
 202                 >
 203                 <font color="#000000">
 204                   <a name="run"></a>&nbsp;
 205                 </font>
 206             </th>
 207             <th bgcolor="#99ccff"
 208                 valign="top"
 209                 align="left"
 210                 width="80%"
 211                 >
 212                 <font color="#000000">run&nbsp;</font>
 213             </th>
 214         </tr>
 215         <tr>
 216         <td>
 217         <pre>
 218 run ( self )
 219 </pre>
 220
 221 <p>Display and operate the StatusWindow.</p>
 222 <h4>Parameters:</h4>
 223 <p>        nothing</p>
 224 <h4>Returns:</h4>
 225 <p>        nothing</p>
 226 </td></tr>
 227 </table><table border="0" cellpadding="5" cellspacing="0" width="100%">
 228
 229         <tr>
 230             <th bgcolor="#99ccff"
 231                 rowspan="2"
 232                 valign="top"
 233                 align="left"
 234                 width="20%"
 235                 >
 236                 <font color="#000000">
 237                   <a name="__init__"></a>&nbsp;
 238                 </font>
 239             </th>
 240             <th bgcolor="#99ccff"
 241                 valign="top"
 242                 align="left"
 243                 width="80%"
 244                 >
 245                 <font color="#000000">__init__&nbsp;</font>
 246             </th>
 247         </tr>
 248         <tr>
 249         <td>
 250         <pre>
 251 __init__ ( self,  parent )
 252 </pre>
 253
 254 <p>Create a new StatusWindow.</p>
 255 <h4>Parameters:</h4>
 256 <dl>
 257 <dt>        <code>parent</code></dt>
 258 <dd>gtk.Object - Usually, the calling window.</dd>
 259 </dl>
 260 <h4>Returns:</h4>
 261 <p>        StatusWindow instance</p>
 262 <h4>NOTE:</h4>
 263 <p>        Sample implementation of status interface.  Status interface
 264 requires .show(), .update_message(message), and .hide() methods.</p>
 265 </td></tr>
 266 </table><table border="0" cellpadding="5" cellspacing="0" width="100%">
 267
 268         <tr>
 269             <th bgcolor="#99ccff"
 270                 rowspan="2"
 271                 valign="top"
 272                 align="left"
 273                 width="20%"
 274                 >
 275                 <font color="#000000">
 276                   <a name="update_window"></a>&nbsp;
 277                 </font>
 278             </th>
 279             <th bgcolor="#99ccff"
 280                 valign="top"
 281                 align="left"
 282                 width="80%"
 283                 >
 284                 <font color="#000000">update_window&nbsp;</font>
 285             </th>
 286         </tr>
 287         <tr>
 288         <td>
 289         <pre>
 290 update_window ( self )
 291 </pre>
 292
 293 <p>Update the StatusWindow progress bar.</p>
 294 <h4>Parameters:</h4>
 295 <p>        nothing</p>
 296 <h4>Returns:</h4>
 297 <dl>
 298 <dt>        True</dt>
 299 <dd>always return True</dd>
 300 </dl>
 301 </td></tr>
 302 </table></td></tr>
 303 </table>
 304         </td>
 305         </tr>
 306         </table>
 307
 308     <hr>
 309
 310     <font size="-2"><i>This document was automatically generated
 311     Sun Apr 19 14:31:33 2009 by <a
 312     href="http://happydoc.sourceforge.net">HappyDoc</a> version
 313     3.1</i></font>
 314
 315   </body>
 316 </html>
 317