<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html40/loose.dtd">
<html>
<head>
<title>HappyDoc Generated Documentation</title>
</head>
<body bgcolor="#ffffff">
<table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th rowspan="2"
valign="top"
align="left"
width="10%"
bgcolor="#88bbee"><font color="#000000">HappyDoc Generated Documentation</font>
</th>
<th bgcolor="#88bbee"
width="90%"
align="right"><font color="#000000">Class: radar_window</font>
</th>
</tr>
<tr>
<td>
<!-- breadcrumbs -->
<p><small>
/ <a href="../wifi-radar.html">wifi-radar.py</a> / radar_window </small></p>
<!-- /breadcrumbs -->
<p>The main user interface window for WiFi Radar. This class also is the control
center for most of the rest of the operations.</p>
<table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="">Methods</a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000"> </font>
</th>
</tr>
<tr>
<td>
<table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="update_network_info"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">update_network_info </font>
</th>
</tr>
<tr>
<td>
<pre>
update_network_info ( self )
</pre>
<p>Update the current ip and essid shown to user.</p>
<h4>Parameters:</h4>
<p> nothing</p>
<h4>Returns:</h4>
<p> nothing</p>
</td></tr>
</table><table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="on_network_selection"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">on_network_selection </font>
</th>
</tr>
<tr>
<td>
<pre>
on_network_selection (
self,
widget,
data=None,
)
</pre>
<p>Enable/disable buttons based on the selected network.</p>
<h4>Parameters:</h4>
<dl>
<dt> <code>widget</code></dt>
<dd>gtk.Widget - The widget sending the event.</dd>
<dt> <code>data</code></dt>
<dd>tuple - list of arbitrary arguments (not used)</dd>
</dl>
<h4>Returns:</h4>
<p> nothing</p>
</td></tr>
</table><table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="__init__"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">__init__ </font>
</th>
</tr>
<tr>
<td>
<pre>
__init__ (
self,
confFile,
apQueue,
commQueue,
logger,
exit_event,
)
</pre>
<p>Create a new radar_window.</p>
<h4>Parameters:</h4>
<dl>
<dt> <code>confFile</code></dt>
<dd>ConfigFile - The config file in which to store/read settings.</dd>
<dt> <code>apQueue</code></dt>
<dd>Queue - The Queue from which AP profiles are read.</dd>
<dt> <code>commQueue</code></dt>
<dd>Queue - The Queue to which to send commands to the scanning thread.</dd>
<dt> <code>logger</code></dt>
<dd>Logger - Python's logging facility</dd>
</dl>
<h4>Returns:</h4>
<p> radar_window instance</p>
</td></tr>
</table><table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="disconnect_profile"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">disconnect_profile </font>
</th>
</tr>
<tr>
<td>
<pre>
disconnect_profile (
self,
widget,
data=None,
)
</pre>
<p>Respond to a request to disconnect by calling ConnectionManager disconnect_interface().</p>
<h4>Parameters:</h4>
<dl>
<dt> <code>widget</code></dt>
<dd>gtk.Widget - The widget sending the event.</dd>
<dt> <code>data</code></dt>
<dd>tuple - list of arbitrary arguments (not used)</dd>
</dl>
<h4>Returns:</h4>
<p> nothing</p>
</td></tr>
</table><table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="edit_preferences"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">edit_preferences </font>
</th>
</tr>
<tr>
<td>
<pre>
edit_preferences (
self,
widget,
data=None,
)
</pre>
<p>Init and run the preferences dialog</p>
<h4>Parameters:</h4>
<dl>
<dt> <code>widget</code></dt>
<dd>gtk.Widget - The widget sending the event.</dd>
<dt> <code>data</code></dt>
<dd>tuple - list of arbitrary arguments (not used)</dd>
</dl>
<h4>Returns:</h4>
<p> nothing</p>
</td></tr>
</table><table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="destroy"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">destroy </font>
</th>
</tr>
<tr>
<td>
<pre>
destroy ( self, widget=None )
</pre>
<p>Quit application.</p>
<h4>Parameters:</h4>
<dl>
<dt> <code>widget</code></dt>
<dd>gtk.Widget - The widget sending the event.</dd>
</dl>
<h4>Returns:</h4>
<p> nothing</p>
</td></tr>
</table><table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="create_new_profile"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">create_new_profile </font>
</th>
</tr>
<tr>
<td>
<pre>
create_new_profile (
self,
widget,
profile,
data=None,
)
</pre>
<p>Respond to a request to create a new AP profile</p>
<h4>Parameters:</h4>
<dl>
<dt> <code>widget</code></dt>
<dd>gtk.Widget - The widget sending the event.</dd>
<dt> <code>profile</code></dt>
<dd>dictionary - The AP profile to use as basis for new profile.</dd>
<dt> <code>data</code></dt>
<dd>tuple - list of arbitrary arguments (not used)</dd>
</dl>
<h4>Returns:</h4>
<dl>
<dt> boolean</dt>
<dd>True if a profile was created and False if profile creation was canceled.</dd>
</dl>
<table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="">Exceptions</a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000"> </font>
</th>
</tr>
<tr>
<td>
<p>
IOError( error_number, error_str )<br>
</p>
</td></tr>
</table></td></tr>
</table><table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="pixbuf_from_known"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">pixbuf_from_known </font>
</th>
</tr>
<tr>
<td>
<pre>
pixbuf_from_known ( self, known )
</pre>
<p>Return the proper icon for a value of known.</p>
<h4>Parameters:</h4>
<dl>
<dt> <code>known</code></dt>
<dd>boolean - Whether the AP is known (i.e. configured)</dd>
</dl>
<h4>Returns:</h4>
<dl>
<dt> gtk.gdk.Pixbuf</dt>
<dd>icon for a known or unknown AP</dd>
</dl>
</td></tr>
</table><table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="update_auto_profile_order"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">update_auto_profile_order </font>
</th>
</tr>
<tr>
<td>
<pre>
update_auto_profile_order (
self,
widget=None,
data=None,
data2=None,
)
</pre>
<p>Update the config file auto profile order from the on-screen order</p>
<h4>Parameters:</h4>
<dl>
<dt> <code>widget</code></dt>
<dd>gtk.Widget - The widget sending the event.</dd>
<dt> <code>data</code></dt>
<dd>tuple - list of arbitrary arguments (not used)</dd>
<dt> <code>data2</code></dt>
<dd>tuple - list of arbitrary arguments (not used)</dd>
</dl>
<h4>Returns:</h4>
<p> nothing</p>
<table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="">Exceptions</a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000"> </font>
</th>
</tr>
<tr>
<td>
<p>
IOError( error_number, error_str )<br>
</p>
</td></tr>
</table></td></tr>
</table><table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="delete_profile_with_check"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">delete_profile_with_check </font>
</th>
</tr>
<tr>
<td>
<pre>
delete_profile_with_check (
self,
widget,
data=None,
)
</pre>
<p>Respond to a request to delete an AP profile (i.e. make profile unknown)
Check with user first.</p>
<h4>Parameters:</h4>
<dl>
<dt> <code>widget</code></dt>
<dd>gtk.Widget - The widget sending the event.</dd>
<dt> <code>data</code></dt>
<dd>tuple - list of arbitrary arguments (not used)</dd>
</dl>
<h4>Returns:</h4>
<p> nothing</p>
</td></tr>
</table><table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="connect_profile"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">connect_profile </font>
</th>
</tr>
<tr>
<td>
<pre>
connect_profile (
self,
widget,
profile,
data=None,
)
</pre>
<p>Respond to a request to connect to an AP.</p>
<h4>Parameters:</h4>
<dl>
<dt> <code>widget</code></dt>
<dd>gtk.Widget - The widget sending the event.</dd>
<dt> <code>profile</code></dt>
<dd>dictionary - The AP profile to which to connect.</dd>
<dt> <code>data</code></dt>
<dd>tuple - list of arbitrary arguments (not used)</dd>
</dl>
<h4>Returns:</h4>
<p> nothing</p>
</td></tr>
</table><table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="update_ap_list"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">update_ap_list </font>
</th>
</tr>
<tr>
<td>
<pre>
update_ap_list ( self, ap )
</pre>
<p>Updates the record-keeping profiles list.</p>
<h4>Parameters:</h4>
<dl>
<dt> <code>ap</code></dt>
<dd>dictionary -- The AP found by scanning_thread.</dd>
</dl>
<h4>Returns:</h4>
<p> nothing</p>
</td></tr>
</table><table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="pixbuf_from_signal"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">pixbuf_from_signal </font>
</th>
</tr>
<tr>
<td>
<pre>
pixbuf_from_signal ( self, signal )
</pre>
<p>Return an icon indicating the signal level.</p>
<h4>Parameters:</h4>
<dl>
<dt> <code>signal</code></dt>
<dd>integer - signal level reported by iwlist (may be arbitrary scale in 0-100 or -X dBm)</dd>
</dl>
<h4>Returns:</h4>
<dl>
<dt> gtk.gdk.Pixbuf</dt>
<dd>1 of 5 icons indicating signal level</dd>
</dl>
</td></tr>
</table><table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="delete_event"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">delete_event </font>
</th>
</tr>
<tr>
<td>
<pre>
delete_event (
self,
widget,
data=None,
)
</pre>
<p>Kill scanning thread, update profile order for config file, and ask to be destroyed.</p>
<h4>Parameters:</h4>
<dl>
<dt> <code>widget</code></dt>
<dd>gtk.Widget - The widget sending the event.</dd>
<dt> <code>data</code></dt>
<dd>tuple - list of arbitrary arguments (not used)</dd>
</dl>
<h4>Returns:</h4>
<dl>
<dt> boolean</dt>
<dd>always return False (i.e. do not propigate the signal which called)</dd>
</dl>
</td></tr>
</table><table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="edit_profile"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">edit_profile </font>
</th>
</tr>
<tr>
<td>
<pre>
edit_profile (
self,
widget,
data=None,
)
</pre>
<p>Respond to a request to edit an AP profile. Edit selected AP profile if it
is known. Otherwise, create a new profile with the selected ESSID and BSSID.</p>
<h4>Parameters:</h4>
<dl>
<dt> <code>widget</code></dt>
<dd>gtk.Widget - The widget sending the event.</dd>
<dt> <code>data</code></dt>
<dd>tuple - list of arbitrary arguments (not used)</dd>
</dl>
<h4>Returns:</h4>
<p> nothing</p>
<table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="">Exceptions</a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000"> </font>
</th>
</tr>
<tr>
<td>
<p>
IOError( error_number, error_str )<br>
</p>
</td></tr>
</table></td></tr>
</table><table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="delete_profile"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">delete_profile </font>
</th>
</tr>
<tr>
<td>
<pre>
delete_profile (
self,
selected_iter,
apname,
)
</pre>
<p>Delete an AP profile (i.e. make profile unknown)</p>
<h4>Parameters:</h4>
<dl>
<dt> <code>selected_iter</code></dt>
<dd>gtk.TreeIter - The selected row.</dd>
<dt> <code>apname</code></dt>
<dd>string - The configuration file section to remove</dd>
</dl>
<h4>Returns:</h4>
<dl>
<dt> gtk.TreeIter</dt>
<dd>the iter for the row removed from the gtk.ListStore</dd>
</dl>
<table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="">Exceptions</a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000"> </font>
</th>
</tr>
<tr>
<td>
<p>
IOError( error_number, error_str )<br>
</p>
</td></tr>
</table></td></tr>
</table><table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="main"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">main </font>
</th>
</tr>
<tr>
<td>
<pre>
main ( self )
</pre>
<p>Begin running radar_window in Gtk event loop.</p>
<h4>Parameters:</h4>
<p> nothing</p>
<h4>Returns:</h4>
<p> nothing</p>
</td></tr>
</table><table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="show_about_info"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">show_about_info </font>
</th>
</tr>
<tr>
<td>
<pre>
show_about_info (
self,
widget,
data=None,
)
</pre>
<p>Init and run the about dialog</p>
<h4>Parameters:</h4>
<dl>
<dt> <code>widget</code></dt>
<dd>gtk.Widget - The widget sending the event.</dd>
<dt> <code>data</code></dt>
<dd>tuple - list of arbitrary arguments (not used)</dd>
</dl>
<h4>Returns:</h4>
<p> nothing</p>
</td></tr>
</table><table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="get_row_by_ap"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">get_row_by_ap </font>
</th>
</tr>
<tr>
<td>
<pre>
get_row_by_ap (
self,
essid,
bssid,
)
</pre>
<p>Return row which holds specified ESSID and BSSID.</p>
<h4>Parameters:</h4>
<dl>
<dt> <code>essid</code></dt>
<dd>string - ESSID to match</dd>
<dt> <code>bssid</code></dt>
<dd>string - BSSID to match</dd>
</dl>
<h4>Returns:</h4>
<dl>
<dt> gtk.TreeIter or None</dt>
<dd>pointer to the row containing the match or None for no match found</dd>
</dl>
</td></tr>
</table><table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="update_connect_buttons"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">update_connect_buttons </font>
</th>
</tr>
<tr>
<td>
<pre>
update_connect_buttons ( self )
</pre>
<p>Set the state of connect/disconnect buttons based on whether we have a connection.</p>
<h4>Parameters:</h4>
<p> nothing</p>
<h4>Returns:</h4>
<p> nothing</p>
</td></tr>
</table><table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="update_plist_items"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">update_plist_items </font>
</th>
</tr>
<tr>
<td>
<pre>
update_plist_items ( self, ap )
</pre>
<p>Updates the on-screen profiles list.</p>
<h4>Parameters:</h4>
<dl>
<dt> <code>ap</code></dt>
<dd>dictionary -- The AP found by scanning_thread.</dd>
</dl>
<h4>Returns:</h4>
<p> nothing</p>
</td></tr>
</table><table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="update_window"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">update_window </font>
</th>
</tr>
<tr>
<td>
<pre>
update_window ( self )
</pre>
<p>Updates the main user interface.</p>
<h4>Parameters:</h4>
<p> nothing</p>
<h4>Returns:</h4>
<dl>
<dt> boolean</dt>
<dd>always return True</dd>
</dl>
</td></tr>
</table></td></tr>
</table>
</td>
</tr>
</table>
<hr>
<font size="-2"><i>This document was automatically generated
Thu May 21 05:32:36 2009 by <a
href="http://happydoc.sourceforge.net">HappyDoc</a> version
3.1</i></font>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
f6a709d1edccf793d4ecae90b649467b
>
files
>
29
