Trees       Indices       Help   
Package AEEvent :: Module ViewChange :: Class ViewChange
[hide private]
[frames] | no frames]

Class ViewChange

source code

            object --+    
                     |    
Base.AccessEngineEvent --+
                         |
                        ViewChange

Event that fires when the ViewManager is creating or updating its view.

This class registers its name and whether it should be monitored by default in an AEMonitor using the Base.registerEventType function when this module is first imported. An AEMonitor can use this information to build its menus.

Instance Methods [hide private]
 
__init__(self, por, gained, **kwargs)
Stores the type of view change and intializes the title attribute to an empty string.		 source code
string
__str__(self)
Returns a human readable representation of this event including its name, its POR, its type, and the title of the new view.		 source code
boolean
execute(self, tier_manager, view_manager, **kwargs)
Stores the name of the root element of the new view in the title attribute.		 source code
dictionary
getDataForTask(self)
Fetches data out of this ViewChange for use by a Task.ViewTask.		 source code

Inherited from Base.AccessEngineEvent: getAppID, getLayer, getPOR, getPriority, getTimestamp, setLayer, setPriority

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__

Instance Variables [hide private]
boolean gained
Type of view change
string title
Name of the root element of the new view (e.g.

Inherited from Base.AccessEngineEvent: focused, por, priority

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, por, gained, **kwargs)
(Constructor)

source code 

Stores the type of view change and intializes the title attribute to an empty string.

Parameters:
  • por (POR) - Point-of-regard to the accessible at the root of the new view
  • gained (integer) - Type of view change
Overrides: Base.AccessEngineEvent.__init__

__str__(self)
(Informal representation operator)

source code 

Returns a human readable representation of this event including its name, its POR, its type, and the title of the new view.

Returns: string
Information about this event
Overrides: Base.AccessEngineEvent.__str__

execute(self, tier_manager, view_manager, **kwargs)

source code 

Stores the name of the root element of the new view in the title attribute. Calls TierManager.TierManager.switchTier to switch to the appropriate Tier for this view. Calls TierManager.TierManager.manageEvent to allow it to dispatch this AEEvent to the active Tier and its registered Perk.

Parameters:
  • tier_manager (TierManager) - TierManager that will handle the event
  • view_manager (ViewManager) - ViewManager defining the current View
  • kwargs (dictionary) - Packed references to other managers not of interest here
Returns: boolean
True to indicate the event executed properly
Overrides: Base.AccessEngineEvent.execute

getDataForTask(self)

source code 

Fetches data out of this ViewChange for use by a Task.ViewTask.

Returns: dictionary
Dictionary of parameters to be passed to a Task.ViewTask as follows:
  • por: Point of regard to the top of the new view
  • title: String containing the window title of the view which changed
  • gained: The type of view change, indicated by one of the integer class variables
Overrides: Base.AccessEngineEvent.getDataForTask

Instance Variable Details [hide private]

title

Name of the root element of the new view (e.g. title of the foreground window)
Type:
string

   Trees       Indices       Help   
Generated by Epydoc 3.0beta1 on Mon Jun 4 15:33:16 2007 http://epydoc.sourceforge.net