docs/developer/wifi-radar.py/profile_dialog.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: profile_dialog</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;profile_dialog&nbsp;</small></p>
  31
  32 <!-- /breadcrumbs -->
  33
  34 <p>Edit and return an AP profile.</p>
  35 <table border="0" cellpadding="5" cellspacing="0" width="100%">
  36
  37         <tr>
  38             <th bgcolor="#99ccff"
  39                 rowspan="2"
  40                 valign="top"
  41                 align="left"
  42                 width="20%"
  43                 >
  44                 <font color="#000000">
  45                   <a name="">Methods</a>&nbsp;
  46                 </font>
  47             </th>
  48             <th bgcolor="#99ccff"
  49                 valign="top"
  50                 align="left"
  51                 width="80%"
  52                 >
  53                 <font color="#000000">&nbsp;</font>
  54             </th>
  55         </tr>
  56         <tr>
  57         <td>
  58         <table border="0" cellpadding="5" cellspacing="0" width="100%">
  59
  60         <tr>
  61             <th bgcolor="#99ccff"
  62                 rowspan="2"
  63                 valign="top"
  64                 align="left"
  65                 width="20%"
  66                 >
  67                 <font color="#000000">
  68                   <a name="get_array_index"></a>&nbsp;
  69                 </font>
  70             </th>
  71             <th bgcolor="#99ccff"
  72                 valign="top"
  73                 align="left"
  74                 width="80%"
  75                 >
  76                 <font color="#000000">get_array_index&nbsp;</font>
  77             </th>
  78         </tr>
  79         <tr>
  80         <td>
  81         <pre>
  82 get_array_index (
  83         self,
  84         item,
  85         array,
  86         )
  87 </pre>
  88
  89 <p>Return the index where item matches a cell in array.</p>
  90 <h4>Parameters:</h4>
  91 <dl>
  92 <dt>        <code>item</code></dt>
  93 <dd>string - Item to find in array</dd>
  94 <dt>        <code>array</code></dt>
  95 <dd>list - List in which to find match.</dd>
  96 </dl>
  97 <h4>Returns:</h4>
  98 <p>        integer - 0 (no match) or higher (index of match)</p>
  99 </td></tr>
 100 </table><table border="0" cellpadding="5" cellspacing="0" width="100%">
 101
 102         <tr>
 103             <th bgcolor="#99ccff"
 104                 rowspan="2"
 105                 valign="top"
 106                 align="left"
 107                 width="20%"
 108                 >
 109                 <font color="#000000">
 110                   <a name="run"></a>&nbsp;
 111                 </font>
 112             </th>
 113             <th bgcolor="#99ccff"
 114                 valign="top"
 115                 align="left"
 116                 width="80%"
 117                 >
 118                 <font color="#000000">run&nbsp;</font>
 119             </th>
 120         </tr>
 121         <tr>
 122         <td>
 123         <pre>
 124 run ( self )
 125 </pre>
 126
 127 <p>Display profile dialog, operate until canceled or okayed, and, possibly, return edited profile values.</p>
 128 <h4>Parameters:</h4>
 129 <p>        nothing</p>
 130 <h4>Returns:</h4>
 131 <dl>
 132 <dt>        dictionary or None</dt>
 133 <dd>a profile, or None on cancel</dd>
 134 </dl>
 135 <h4>NOTES:</h4>
 136 <p>        Raises ValueError if an attempt is made to save an ESSID with no name.</p>
 137 <table border="0" cellpadding="5" cellspacing="0" width="100%">
 138
 139         <tr>
 140             <th bgcolor="#99ccff"
 141                 rowspan="2"
 142                 valign="top"
 143                 align="left"
 144                 width="20%"
 145                 >
 146                 <font color="#000000">
 147                   <a name="">Exceptions</a>&nbsp;
 148                 </font>
 149             </th>
 150             <th bgcolor="#99ccff"
 151                 valign="top"
 152                 align="left"
 153                 width="80%"
 154                 >
 155                 <font color="#000000">&nbsp;</font>
 156             </th>
 157         </tr>
 158         <tr>
 159         <td>
 160         <p>
 161 ValueError<br>
 162 </p>
 163 </td></tr>
 164 </table></td></tr>
 165 </table><table border="0" cellpadding="5" cellspacing="0" width="100%">
 166
 167         <tr>
 168             <th bgcolor="#99ccff"
 169                 rowspan="2"
 170                 valign="top"
 171                 align="left"
 172                 width="20%"
 173                 >
 174                 <font color="#000000">
 175                   <a name="toggle_use_dhcp"></a>&nbsp;
 176                 </font>
 177             </th>
 178             <th bgcolor="#99ccff"
 179                 valign="top"
 180                 align="left"
 181                 width="80%"
 182                 >
 183                 <font color="#000000">toggle_use_dhcp&nbsp;</font>
 184             </th>
 185         </tr>
 186         <tr>
 187         <td>
 188         <pre>
 189 toggle_use_dhcp (
 190         self,
 191         widget,
 192         data=None,
 193         )
 194 </pre>
 195
 196 <p>Respond to expanding/hiding IP segment.</p>
 197 <h4>Parameters:</h4>
 198 <dl>
 199 <dt>        <code>widget</code></dt>
 200 <dd>gtk.Widget - The widget sending the event.</dd>
 201 <dt>        <code>data</code></dt>
 202 <dd>tuple - List of arbitrary arguments (not used)</dd>
 203 </dl>
 204 <h4>Returns:</h4>
 205 <p>        nothing</p>
 206 </td></tr>
 207 </table><table border="0" cellpadding="5" cellspacing="0" width="100%">
 208
 209         <tr>
 210             <th bgcolor="#99ccff"
 211                 rowspan="2"
 212                 valign="top"
 213                 align="left"
 214                 width="20%"
 215                 >
 216                 <font color="#000000">
 217                   <a name="toggle_use_wpa"></a>&nbsp;
 218                 </font>
 219             </th>
 220             <th bgcolor="#99ccff"
 221                 valign="top"
 222                 align="left"
 223                 width="80%"
 224                 >
 225                 <font color="#000000">toggle_use_wpa&nbsp;</font>
 226             </th>
 227         </tr>
 228         <tr>
 229         <td>
 230         <pre>
 231 toggle_use_wpa (
 232         self,
 233         widget,
 234         data=None,
 235         )
 236 </pre>
 237
 238 <p>Respond to expanding/hiding WPA segment.</p>
 239 <h4>Parameters:</h4>
 240 <dl>
 241 <dt>        <code>widget</code></dt>
 242 <dd>gtk.Widget - The widget sending the event.</dd>
 243 <dt>        <code>data</code></dt>
 244 <dd>tuple - List of arbitrary arguments (not used)</dd>
 245 </dl>
 246 <h4>Returns:</h4>
 247 <p>        nothing</p>
 248 </td></tr>
 249 </table><table border="0" cellpadding="5" cellspacing="0" width="100%">
 250
 251         <tr>
 252             <th bgcolor="#99ccff"
 253                 rowspan="2"
 254                 valign="top"
 255                 align="left"
 256                 width="20%"
 257                 >
 258                 <font color="#000000">
 259                   <a name="destroy"></a>&nbsp;
 260                 </font>
 261             </th>
 262             <th bgcolor="#99ccff"
 263                 valign="top"
 264                 align="left"
 265                 width="80%"
 266                 >
 267                 <font color="#000000">destroy&nbsp;</font>
 268             </th>
 269         </tr>
 270         <tr>
 271         <td>
 272         <pre>
 273 destroy ( self )
 274 </pre>
 275
 276 <p>Remove profile dialog.</p>
 277 <h4>Parameters:</h4>
 278 <p>        nothing</p>
 279 <h4>Returns:</h4>
 280 <p>        nothing</p>
 281 </td></tr>
 282 </table><table border="0" cellpadding="5" cellspacing="0" width="100%">
 283
 284         <tr>
 285             <th bgcolor="#99ccff"
 286                 rowspan="2"
 287                 valign="top"
 288                 align="left"
 289                 width="20%"
 290                 >
 291                 <font color="#000000">
 292                   <a name="__init__"></a>&nbsp;
 293                 </font>
 294             </th>
 295             <th bgcolor="#99ccff"
 296                 valign="top"
 297                 align="left"
 298                 width="80%"
 299                 >
 300                 <font color="#000000">__init__&nbsp;</font>
 301             </th>
 302         </tr>
 303         <tr>
 304         <td>
 305         <pre>
 306 __init__ (
 307         self,
 308         parent,
 309         profile,
 310         )
 311 </pre>
 312
 313 <p>Create a new profile_dialog.</p>
 314 <h4>Parameters:</h4>
 315 <dl>
 316 <dt>        <code>parent</code></dt>
 317 <dd>gtk.Object - Usually, the calling window.</dd>
 318 <dt>        <code>profile</code></dt>
 319 <dd>dictionary - The profile to edit.  May be mostly-empty default profile.</dd>
 320 </dl>
 321 <h4>Returns:</h4>
 322 <p>        profile_dialog instance</p>
 323 </td></tr>
 324 </table><table border="0" cellpadding="5" cellspacing="0" width="100%">
 325
 326         <tr>
 327             <th bgcolor="#99ccff"
 328                 rowspan="2"
 329                 valign="top"
 330                 align="left"
 331                 width="20%"
 332                 >
 333                 <font color="#000000">
 334                   <a name="get_array_item"></a>&nbsp;
 335                 </font>
 336             </th>
 337             <th bgcolor="#99ccff"
 338                 valign="top"
 339                 align="left"
 340                 width="80%"
 341                 >
 342                 <font color="#000000">get_array_item&nbsp;</font>
 343             </th>
 344         </tr>
 345         <tr>
 346         <td>
 347         <pre>
 348 get_array_item (
 349         self,
 350         index,
 351         array,
 352         )
 353 </pre>
 354
 355 <p>Return the value in array[ index ]</p>
 356 <h4>Parameters:</h4>
 357 <dl>
 358 <dt>        <code>index</code></dt>
 359 <dd>integer - The index to look up.</dd>
 360 <dt>        <code>array</code></dt>
 361 <dd>list - List in which to look up value.</dd>
 362 </dl>
 363 <h4>Returns:</h4>
 364 <dl>
 365 <dt>        string</dt>
 366 <dd>empty string (no match) or looked up value</dd>
 367 </dl>
 368 </td></tr>
 369 </table></td></tr>
 370 </table>
 371         </td>
 372         </tr>
 373         </table>
 374
 375     <hr>
 376
 377     <font size="-2"><i>This document was automatically generated
 378     Sun Apr 19 14:31:33 2009 by <a
 379     href="http://happydoc.sourceforge.net">HappyDoc</a> version
 380     3.1</i></font>
 381
 382   </body>
 383 </html>
 384