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

Class ScreenChange

source code

            object --+    
                     |    
Base.AccessEngineEvent --+
                         |
                        ScreenChange

Event that fires when some aspect of screen bounds or visible data changes.

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. The AEMonitor can use this information to build its menus.

Instance Methods [hide private]
 
__init__(self, por, kind, **kwargs)
Calls the base class and stores POR and type of event.		 source code
string
__str__(self)
Returns a human readable representation of this event including its name, its POR, and its kind.		 source code
boolean
execute(self, tier_manager, **kwargs)
Contacts the TierManager so it can manage the screen change event.		 source code
dictionary
getDataForTask(self)
Fetches data out of this ScreenChange for use by a Task.ScreenTask.		 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]
integer kind
One of the integer class variables in this class

Inherited from Base.AccessEngineEvent: focused, por, priority

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

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

source code 

Calls the base class and stores POR and type of event.

Parameters:
  • por (POR) - Point of regard to an object that changed on screen
  • kind (integer) - Kind of screen change event
Overrides: Base.AccessEngineEvent.__init__

__str__(self)
(Informal representation operator)

source code 

Returns a human readable representation of this event including its name, its POR, and its kind.

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

execute(self, tier_manager, **kwargs)

source code 

Contacts the TierManager so it can manage the screen change event.

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

getDataForTask(self)

source code 

Fetches data out of this ScreenChange for use by a Task.ScreenTask.

Returns: dictionary
Dictionary of parameters to be passed to a Task.ScreenTask as follows:
  • por: The POR pointing at the item at which selection changed or the current caret location for a text selection change
  • kind: The kind of screen change
Overrides: Base.AccessEngineEvent.getDataForTask

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