From 6e498adf5845d9a84be448451a0ad2818231b603 Mon Sep 17 00:00:00 2001 From: Sean Robinson Date: Sun, 19 Apr 2009 14:32:59 -0700 Subject: [PATCH] Update developer docs Signed-off-by: Sean Robinson --- docs/developer/wifi-radar.html | 18 +- docs/developer/wifi-radar.py/ConfigFile.html | 2 +- .../developer/wifi-radar.py/ConnectionManager.html | 108 ++++-- docs/developer/wifi-radar.py/StatusWindow.html | 44 +-- docs/developer/wifi-radar.py/about_dialog.html | 2 +- .../wifi-radar.py/file_browse_button.html | 46 +-- .../wifi-radar.py/preferences_dialog.html | 29 +- docs/developer/wifi-radar.py/profile_dialog.html | 2 +- docs/developer/wifi-radar.py/radar_window.html | 376 +++++++++++++++------ 9 files changed, 434 insertions(+), 193 deletions(-) diff --git a/docs/developer/wifi-radar.html b/docs/developer/wifi-radar.html index dd4a08f..331c099 100644 --- a/docs/developer/wifi-radar.html +++ b/docs/developer/wifi-radar.html @@ -77,6 +77,7 @@ scanning_thread ( apQueue, commandQueue, logger, + exit_event, ) @@ -360,9 +361,9 @@ set_network_device ( device ) -

ConnectionManager

+

file_browse_button

-

Manage a connection; including reporting connection state,

+

Button to allow user to choose a file and put value into specified gtk.Entry

@@ -374,9 +375,9 @@ set_network_device ( device ) -

file_browse_button

+

ConnectionManager

-

Button to allow user to choose a file and put value into specified gtk.Entry

+

Manage a connection; including reporting connection state,

@@ -402,6 +403,13 @@ set_network_device ( device ) +

ErrorDialog

+ +

Simple dialog to report an error to the user.

+ + + +

radar_window

The main user interface window for WiFi Radar. This class also is the control

@@ -416,7 +424,7 @@ set_network_device ( device )
This document was automatically generated - Thu Apr 2 20:36:40 2009 by HappyDoc version 3.1 diff --git a/docs/developer/wifi-radar.py/ConfigFile.html b/docs/developer/wifi-radar.py/ConfigFile.html index a56f783..64c687a 100644 --- a/docs/developer/wifi-radar.py/ConfigFile.html +++ b/docs/developer/wifi-radar.py/ConfigFile.html @@ -676,7 +676,7 @@ get_profile ( self, section_name )
This document was automatically generated - Thu Apr 2 20:36:40 2009 by HappyDoc version 3.1 diff --git a/docs/developer/wifi-radar.py/ConnectionManager.html b/docs/developer/wifi-radar.py/ConnectionManager.html index 1f26bce..b210338 100644 --- a/docs/developer/wifi-radar.py/ConnectionManager.html +++ b/docs/developer/wifi-radar.py/ConnectionManager.html @@ -169,7 +169,34 @@ connect_to_network (

Returns:

nothing

+ + + + + + + + +
+ + Exceptions  + + +   +
+

+TypeError( "Empty AP address" )
+

@@ -180,7 +207,7 @@ connect_to_network ( width="20%" > -   +  
- disconnect_interface  + __init__  
-disconnect_interface ( self )
+__init__ (
+        self,
+        confFile,
+        commandQueue,
+        logger,
+        )
-

Disconnect from the AP with which a connection has been established/attempted.

+

Create a new connection manager which can read a config file and send to scanning thread + command Queue. A new manager checks for a pre-existing connection and takes + its AP profile from the ESSID and BSSID to which it is currently attached.

Parameters:

-

nothing

+
+
confFile
+
ConfigFile - Config file object
+
commandQueue
+
Queue - The Queue on which to put commands to the scanning thread
+
logger
+
Logger - Python's logging facility
+

Returns:

-

nothing

+

ConnectionManager instance

@@ -285,7 +326,7 @@ get_current_ip ( self ) width="20%" > -   +   +
- __init__  + disconnect_interface  
-__init__ (
-        self,
-        confFile,
-        commandQueue,
-        logger,
-        )
+disconnect_interface ( self )
-

Create a new connection manager which can read a config file and send to scanning thread - command Queue. A new manager checks for a pre-existing connection and takes - its AP profile from the ESSID and BSSID to which it is currently attached.

+

Disconnect from the AP with which a connection has been established/attempted.

Parameters:

-
-
confFile
-
ConfigFile - Config file object
-
commandQueue
-
Queue - The Queue on which to put commands to the scanning thread
-
logger
-
Logger - Python's logging facility
-
+

nothing

Returns:

-

ConnectionManager instance

+

nothing

+ + + + + + + +
+ + Exceptions  + + +   +
+

+KeyError
+

@@ -331,7 +385,7 @@ __init__ (
This document was automatically generated - Thu Apr 2 20:36:40 2009 by HappyDoc version 3.1 diff --git a/docs/developer/wifi-radar.py/StatusWindow.html b/docs/developer/wifi-radar.py/StatusWindow.html index 60dc578..de0f4a3 100644 --- a/docs/developer/wifi-radar.py/StatusWindow.html +++ b/docs/developer/wifi-radar.py/StatusWindow.html @@ -99,7 +99,7 @@ hide ( self ) width="20%" > -   +   - run  + update_message  
-run ( self )
+update_message ( self,  message )
-

Display and operate the StatusWindow.

+

Change the message displayed to the user.

Parameters:

-

nothing

+
+
message
+
string - The message to show to the user.
+

Returns:

nothing

@@ -132,7 +135,7 @@ run ( self ) width="20%" > -   +   - update_message  + show  
-update_message ( self,  message )
+show ( self )
-

Change the message displayed to the user.

+

Show all the widgets of the StatusWindow.

Parameters:

-
-
message
-
string - The message to show to the user.
-
+

nothing

Returns:

nothing

@@ -168,7 +168,7 @@ update_message ( self, message ) width="20%" > -   +   - show  + destroy  
-show ( self )
+destroy ( self )
-

Show all the widgets of the StatusWindow.

+

Remove the StatusWindow.

Parameters:

nothing

Returns:

@@ -201,7 +201,7 @@ show ( self ) width="20%" > -   +   - destroy  + run  
-destroy ( self )
+run ( self )
-

Remove the StatusWindow.

+

Display and operate the StatusWindow.

Parameters:

nothing

Returns:

@@ -308,7 +308,7 @@ update_window ( self )
This document was automatically generated - Thu Apr 2 20:36:40 2009 by HappyDoc version 3.1 diff --git a/docs/developer/wifi-radar.py/about_dialog.html b/docs/developer/wifi-radar.py/about_dialog.html index f55bf88..25b74f9 100644 --- a/docs/developer/wifi-radar.py/about_dialog.html +++ b/docs/developer/wifi-radar.py/about_dialog.html @@ -97,7 +97,7 @@ __init__ ( self )
This document was automatically generated - Thu Apr 2 20:36:40 2009 by HappyDoc version 3.1 diff --git a/docs/developer/wifi-radar.py/file_browse_button.html b/docs/developer/wifi-radar.py/file_browse_button.html index d649f49..f1a3da3 100644 --- a/docs/developer/wifi-radar.py/file_browse_button.html +++ b/docs/developer/wifi-radar.py/file_browse_button.html @@ -65,7 +65,7 @@ width="20%" > -   +   - __init__  + browse_files  
-__init__ (
-        self,
-        parent,
-        entry,
-        )
+browse_files ( self,  widget )
-

Create a button to simulate a File/Open

+

Show filechooser dialog and get user selection

Parameters:

-
parent
-
gtk.Object -- Usually, the calling window.
-
entry
-
gtk.Entry -- The text entry to update with user selection.
+
widget
+
gtk.Widget -- The widget sending the event.

Returns:

-

file_browse_button instance

+

nothing

+

NOTES:

+

updates entry value

@@ -107,7 +103,7 @@ __init__ ( width="20%" > -   +  
- browse_files  + __init__  
-browse_files ( self,  widget )
+__init__ (
+        self,
+        parent,
+        entry,
+        )
-

Show filechooser dialog and get user selection

+

Create a button to simulate a File/Open

Parameters:

-
widget
-
gtk.Widget -- The widget sending the event.
+
parent
+
gtk.Object -- Usually, the calling window.
+
entry
+
gtk.Entry -- The text entry to update with user selection.

Returns:

-

nothing

-

NOTES:

-

updates entry value

+

file_browse_button instance

@@ -144,7 +144,7 @@ browse_files ( self, widget )
This document was automatically generated - Thu Apr 2 20:36:40 2009 by HappyDoc version 3.1 diff --git a/docs/developer/wifi-radar.py/preferences_dialog.html b/docs/developer/wifi-radar.py/preferences_dialog.html index 3311797..39db669 100644 --- a/docs/developer/wifi-radar.py/preferences_dialog.html +++ b/docs/developer/wifi-radar.py/preferences_dialog.html @@ -240,7 +240,34 @@ save ( self )

nothing

Returns:

nothing

+ + + + + + + + +
+ + Exceptions  + + +   +
+

+IOError( error_number, error_str )
+

@@ -292,7 +319,7 @@ __init__ (
This document was automatically generated - Thu Apr 2 20:36:40 2009 by HappyDoc version 3.1 diff --git a/docs/developer/wifi-radar.py/profile_dialog.html b/docs/developer/wifi-radar.py/profile_dialog.html index 9ad6edc..4f473d1 100644 --- a/docs/developer/wifi-radar.py/profile_dialog.html +++ b/docs/developer/wifi-radar.py/profile_dialog.html @@ -375,7 +375,7 @@ get_array_item (
This document was automatically generated - Thu Apr 2 20:36:40 2009 by HappyDoc version 3.1 diff --git a/docs/developer/wifi-radar.py/radar_window.html b/docs/developer/wifi-radar.py/radar_window.html index 681289d..6088af7 100644 --- a/docs/developer/wifi-radar.py/radar_window.html +++ b/docs/developer/wifi-radar.py/radar_window.html @@ -66,7 +66,7 @@ width="20%" > -   +  
- delete_event  + get_row_by_ap  
-delete_event (
+get_row_by_ap (
         self,
-        widget,
-        data=None,
+        essid,
+        bssid,
         )
-

Kill scanning thread, update profile order for config file, and ask to be destroyed.

+

Return row which holds specified ESSID and BSSID.

Parameters:

-
widget
-
gtk.Widget - The widget sending the event.
-
data
-
tuple - list of arbitrary arguments (not used)
+
essid
+
string - ESSID to match
+
bssid
+
string - BSSID to match

Returns:

-
boolean
-
always return False (i.e. do not propigate the signal which called)
+
gtk.TreeIter or None
+
pointer to the row containing the match or None for no match found
@@ -153,7 +153,7 @@ disconnect_profile ( width="20%" > -   +  
- on_network_selection  + edit_preferences  
-on_network_selection (
+edit_preferences (
         self,
         widget,
         data=None,
         )
-

Enable/disable buttons based on the selected network.

+

Init and run the preferences dialog

Parameters:

widget
@@ -195,7 +195,7 @@ on_network_selection ( width="20%" > -   +  
- delete_profile  + on_network_selection  
-delete_profile (
+on_network_selection (
         self,
         widget,
         data=None,
         )
-

Respond to a request to delete an AP profile (i.e. make profile unknown)

+

Enable/disable buttons based on the selected network.

Parameters:

widget
@@ -237,7 +237,7 @@ delete_profile ( width="20%" > -   +  
- edit_preferences  + pixbuf_from_signal  
-edit_preferences (
-        self,
-        widget,
-        data=None,
-        )
+pixbuf_from_signal ( self,  signal )
-

Init and run the preferences dialog

+

Return an icon indicating the signal level.

Parameters:

-
widget
-
gtk.Widget - The widget sending the event.
-
data
-
tuple - list of arbitrary arguments (not used)
+
signal
+
integer - signal level reported by iwlist (may be arbitrary scale in 0-100 or -X dBm)

Returns:

-

nothing

+
+
gtk.gdk.Pixbuf
+
1 of 5 icons indicating signal level
+
@@ -279,7 +276,7 @@ edit_preferences ( width="20%" > -   +  
- pixbuf_from_signal  + show_about_info  
-pixbuf_from_signal ( self,  signal )
+show_about_info (
+        self,
+        widget,
+        data=None,
+        )
-

Return an icon indicating the signal level.

+

Init and run the about dialog

Parameters:

-
signal
-
integer - signal level reported by iwlist (may be arbitrary scale in 0-100 or -X dBm)
+
widget
+
gtk.Widget - The widget sending the event.
+
data
+
tuple - list of arbitrary arguments (not used)

Returns:

-
-
gtk.gdk.Pixbuf
-
1 of 5 icons indicating signal level
-
+

nothing

@@ -318,7 +318,7 @@ pixbuf_from_signal ( self, signal ) width="20%" > -   +  
- show_about_info  + delete_event  
-show_about_info (
+delete_event (
         self,
         widget,
         data=None,
         )
-

Init and run the about dialog

+

Kill scanning thread, update profile order for config file, and ask to be destroyed.

Parameters:

widget
@@ -348,7 +348,10 @@ show_about_info (
tuple - list of arbitrary arguments (not used)

Returns:

-

nothing

+
+
boolean
+
always return False (i.e. do not propigate the signal which called)
+
@@ -360,7 +363,7 @@ show_about_info ( width="20%" > -   +  
- get_row_by_ap  + create_new_profile  
-get_row_by_ap (
+create_new_profile (
         self,
-        essid,
-        bssid,
+        widget,
+        profile,
+        data=None,
         )
-

Return row which holds specified ESSID and BSSID.

+

Respond to a request to create a new AP profile

Parameters:

-
essid
-
string - ESSID to match
-
bssid
-
string - BSSID to match
+
widget
+
gtk.Widget - The widget sending the event.
+
profile
+
dictionary - The AP profile to use as basis for new profile.
+
data
+
tuple - list of arbitrary arguments (not used)

Returns:

-
gtk.TreeIter or None
-
pointer to the row containing the match or None for no match found
+
boolean
+
True if a profile was created and False if profile creation was canceled.
+ + + + + + + + +
+ + Exceptions  + + +   +
+

+IOError( error_number, error_str )
+

@@ -450,7 +483,7 @@ connect_profile ( width="20%" > -   +  
- destroy  + delete_profile_with_check  
-destroy ( self,  widget=None )
+delete_profile_with_check (
+        self,
+        widget,
+        data=None,
+        )
-

Quit application.

+

Respond to a request to delete an AP profile (i.e. make profile unknown) + Check with user first.

Parameters:

widget
gtk.Widget - The widget sending the event.
+
data
+
tuple - list of arbitrary arguments (not used)

Returns:

nothing

@@ -486,7 +526,7 @@ destroy ( self, widget=None ) width="20%" > -   +   		- main  + update_plist_items  
-main ( self )
+update_plist_items ( self )
-

Begin running radar_window in Gtk event loop.

+

Updates the on-screen profiles list.

Parameters:

nothing

Returns:

-

nothing

+
+
boolean
+
always return True
+
@@ -519,7 +562,7 @@ main ( self ) width="20%" > -   +  
- update_plist_items  + destroy  
-update_plist_items ( self )
+destroy ( self,  widget=None )
-

Updates the on-screen profiles list.

+

Quit application.

Parameters:

-

nothing

-

Returns:

-
boolean
-
always return True
+
widget
+
gtk.Widget - The widget sending the event.
+

Returns:

+

nothing

@@ -587,7 +630,34 @@ edit_profile (

Returns:

nothing

+
+ + + + + + + +
+ + Exceptions  + + +   +
+

+IOError( error_number, error_str )
+

@@ -598,7 +668,7 @@ edit_profile ( width="20%" > -   +  
- create_new_profile  + main  
-create_new_profile (
-        self,
-        widget,
-        profile,
-        data=None,
-        )
+main ( self )
-

Respond to a request to create a new AP profile

+

Begin running radar_window in Gtk event loop.

Parameters:

-
-
widget
-
gtk.Widget - The widget sending the event.
-
profile
-
dictionary - The AP profile to use as basis for new profile.
-
data
-
tuple - list of arbitrary arguments (not used)
-
+

nothing

Returns:

-
-
boolean
-
True if a profile was created and False if profile creation was canceled.
-
+

nothing

@@ -685,7 +740,7 @@ pixbuf_from_known ( self, known ) width="20%" > -   +  
- update_auto_profile_order  + delete_profile  
-update_auto_profile_order (
+delete_profile (
         self,
-        widget=None,
-        data=None,
-        data2=None,
+        selected_iter,
+        apname,
         )
-

Update the config file auto profile order from the on-screen order

+

Delete an AP profile (i.e. make profile unknown)

Parameters:

-
widget
-
gtk.Widget - The widget sending the event.
-
data
-
tuple - list of arbitrary arguments (not used)
-
data2
-
tuple - list of arbitrary arguments (not used)
+
selected_iter
+
gtk.TreeIter - The selected row.
+
apname
+
string - The configuration file section to remove

Returns:

nothing

+ + + + + + + + +
+ + Exceptions  + + +   +
+

+IOError( error_number, error_str )
+

@@ -750,6 +829,7 @@ __init__ ( apQueue, commQueue, logger, + exit_event, ) @@ -768,6 +848,78 @@ __init__ (

Returns:

radar_window instance

+
+ + + + + + +
+ +   + + + update_auto_profile_order  +
+ 
+update_auto_profile_order (
+        self,
+        widget=None,
+        data=None,
+        data2=None,
+        )
+
+ +

Update the config file auto profile order from the on-screen order

+

Parameters:

+
+
widget
+
gtk.Widget - The widget sending the event.
+
data
+
tuple - list of arbitrary arguments (not used)
+
data2
+
tuple - list of arbitrary arguments (not used)
+
+

Returns:

+

nothing

+ + + + + + + + +
+ + Exceptions  + + +   +
+

+IOError( error_number, error_str )
+

+
@@ -777,7 +929,7 @@ __init__ (
This document was automatically generated - Thu Apr 2 20:36:41 2009 by HappyDoc version 3.1 -- 2.11.4.GIT