Package AccessEngine :: Package AEEvent :: Module ScreenChange :: Class ScreenChange

Class ScreenChange

  object --+    
           |    
Base.AEEvent --+
               |
              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 AEPor and type of event.

source code

string

__str__(self)
Returns a human readable representation of this event including its name, its AEPor, and its kind.

source code

boolean

execute(self)
Contacts the AETierManager so it can manage the screen change event.

source code

dictionary

getDataForTask(self)
Fetches data out of this ScreenChange for use by a AEScript.EventScript.onScreenChange-Task.

source code

Inherited from Base.AEEvent: 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.AEEvent: layer, 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 AEPor and type of event.

Parameters:

por (AEPor) - Point of regard to an object that changed on screen
kind (integer) - Kind of screen change event

Overrides: Base.AEEvent.__init__

str(self)
(Informal representation operator)

source code

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

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

execute(self)

source code

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

Returns: boolean: Always True to indicate the event executed properly
Overrides: Base.AEEvent.execute

getDataForTask(self)

source code

Fetches data out of this ScreenChange for use by a AEScript.EventScript.onScreenChange-Task.

Returns: dictionary

Dictionary of parameters to be passed to a AEScript.EventScript.onScreenChange-Task as follows:

por: The AEPor 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.AEEvent.getDataForTask

Class ScreenChange

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

__str__(self) (Informal representation operator)

execute(self)

getDataForTask(self)

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

str(self)
(Informal representation operator)