Table of Contents

Class: AboutDialog sam/AboutDialog.py

Creates, shows and hides the about dialog box.

Purpose: Creates a widget tree using a specified glade file, displays this GUI to the user, and hides itself when clicked on.

Used by: MainWindow

Uses: None

Attributes: None

SRS Refs: 5.2.3

Author: mayadm

Date: 9/7/02

Methods   
__init__
getWidgetTree
hide
show
  __init__ 
__init__ ( self )

Purpose: Creates a new instance of the class AboutDialog. If the environment variable RAMI_SAM_SHARE is set, the glade file is looked for in that directory, otherwise looked for in the current directory.

Used by: MainWindow

Uses: None

Input: None

Output: None

Preconditions: None

Postconditions: None

SRS Refs: 5.2.3

Author: mayadm

Date: 9/7/02

  getWidgetTree 
getWidgetTree ( self )

Purpose: Returns the widget tree of the about dialog class. Used for testing.

Used by: None

Uses: None

Input: None

Output: None

Preconditions: None

Postconditions: None

SRS Refs: 5.2.3

Author: mayadm

Date: 16/8/02

  hide 
hide ( self,  *args )

Purpose: Handles the user clicking on the about dialog box. Hides the about dialog GUI.

Used by: AboutDialog

Uses: None

Input: *args : unused arguments

Output: None

Preconditions: The subtree "about" contains the widget tree of the about dialog box.

Postconditions: None

SRS Refs: 5.2.3

Author: mayadm

Date: 9/7/02

Exceptions   
CustomError, "Error - about widget tree not found"
  show 
show ( self )

Purpose: Displays the about dialog box to the user using the widget tree "about" from the glade file contained by spec_filename. Connects up the handlers. Only allows one dialog box to be shown at any time (ie the dialog box is modal).

Used by: MainWindow

Uses: None

Input: None

Output: None

Preconditions: The subtree "about" contains the widget tree of the about dialog box.

Postconditions: None

SRS Refs: 5.2.3

Author: mayadm

Date: 9/7/02

Exceptions   
CustomError, "Error - About dialog box is already shown"

Table of Contents

This document was automatically generated on Wed Oct 30 23:04:21 2002 by HappyDoc version 2.0