HappyDoc Generated Documentation Class: radar_window

wifi-radar.py / radar_window 

The main user interface window for WiFi Radar. This class also is the control center for most of the rest of the operations.

Methods   
  update_network_info 
update_network_info ( self )

Update the current ip and essid shown to user.

Parameters:

nothing

Returns:

nothing

  on_network_selection 
on_network_selection (
        self,
        widget,
        data=None,
        )

Enable/disable buttons based on the selected network.

Parameters:

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

Returns:

nothing

  __init__ 
__init__ (
        self,
        confFile,
        apQueue,
        commQueue,
        logger,
        exit_event,
        )

Create a new radar_window.

Parameters:

confFile
ConfigFile - The config file in which to store/read settings.
apQueue
Queue - The Queue from which AP profiles are read.
commQueue
Queue - The Queue to which to send commands to the scanning thread.
logger
Logger - Python's logging facility

Returns:

radar_window instance

  disconnect_profile 
disconnect_profile (
        self,
        widget,
        data=None,
        )

Respond to a request to disconnect by calling ConnectionManager disconnect_interface().

Parameters:

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

Returns:

nothing

  edit_preferences 
edit_preferences (
        self,
        widget,
        data=None,
        )

Init and run the preferences dialog

Parameters:

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

Returns:

nothing

  destroy 
destroy ( self,  widget=None )

Quit application.

Parameters:

widget
gtk.Widget - The widget sending the event.

Returns:

nothing

  create_new_profile 
create_new_profile (
        self,
        widget,
        profile,
        data=None,
        )

Respond to a request to create a new AP profile

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)

Returns:

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

IOError( error_number, error_str )

  pixbuf_from_known 
pixbuf_from_known ( self,  known )

Return the proper icon for a value of known.

Parameters:

known
boolean - Whether the AP is known (i.e. configured)

Returns:

gtk.gdk.Pixbuf
icon for a known or unknown AP
  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 )

  delete_profile_with_check 
delete_profile_with_check (
        self,
        widget,
        data=None,
        )

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

  connect_profile 
connect_profile (
        self,
        widget,
        profile,
        data=None,
        )

Respond to a request to connect to an AP.

Parameters:

widget
gtk.Widget - The widget sending the event.
profile
dictionary - The AP profile to which to connect.
data
tuple - list of arbitrary arguments (not used)

Returns:

nothing

  update_ap_list 
update_ap_list ( self,  ap )

Updates the record-keeping profiles list.

Parameters:

ap
dictionary -- The AP found by scanning_thread.

Returns:

nothing

  pixbuf_from_signal 
pixbuf_from_signal ( self,  signal )

Return an icon indicating the signal level.

Parameters:

signal
integer - signal level reported by iwlist (may be arbitrary scale in 0-100 or -X dBm)

Returns:

gtk.gdk.Pixbuf
1 of 5 icons indicating signal level
  delete_event 
delete_event (
        self,
        widget,
        data=None,
        )

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

Parameters:

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

Returns:

boolean
always return False (i.e. do not propigate the signal which called)
  edit_profile 
edit_profile (
        self,
        widget,
        data=None,
        )

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.

Parameters:

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

Returns:

nothing

Exceptions   

IOError( error_number, error_str )

  delete_profile 
delete_profile (
        self,
        selected_iter,
        apname,
        )

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

Parameters:

selected_iter
gtk.TreeIter - The selected row.
apname
string - The configuration file section to remove

Returns:

gtk.TreeIter
the iter for the row removed from the gtk.ListStore
Exceptions   

IOError( error_number, error_str )

  main 
main ( self )

Begin running radar_window in Gtk event loop.

Parameters:

nothing

Returns:

nothing

  show_about_info 
show_about_info (
        self,
        widget,
        data=None,
        )

Init and run the about dialog

Parameters:

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

Returns:

nothing

  get_row_by_ap 
get_row_by_ap (
        self,
        essid,
        bssid,
        )

Return row which holds specified ESSID and BSSID.

Parameters:

essid
string - ESSID to match
bssid
string - BSSID to match

Returns:

gtk.TreeIter or None
pointer to the row containing the match or None for no match found
  update_connect_buttons 
update_connect_buttons ( self )

Set the state of connect/disconnect buttons based on whether we have a connection.

Parameters:

nothing

Returns:

nothing

  update_plist_items 
update_plist_items ( self,  ap )

Updates the on-screen profiles list.

Parameters:

ap
dictionary -- The AP found by scanning_thread.

Returns:

nothing

  update_window 
update_window ( self )

Updates the main user interface.

Parameters:

nothing

Returns:

boolean
always return True

This document was automatically generated Thu May 21 05:32:36 2009 by HappyDoc version 3.1