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

Class SelectorChange

source code

            object --+    
                     |    
Base.AccessEngineEvent --+
                         |
                        SelectorChange

Event that fires when the selector moves.

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, text, kind=AEConstants.EVENT_ACTIVE_ITEM_SELECT, **kwargs)
Calls the base class (which set the event priority) and then stores the item to be passed along to the Tier as part of the event.		 source code
string
__str__(self)
Returns a human readable representation of this event including its name, its POR, and its item text.		 source code
boolean
execute(self, tier_manager, view_manager, **kwargs)
Contacts the TierManager so it can manage the selector change event.		 source code
POR
getFocusPOR(self)
Returns the POR for active item events.		 source code
dictionary
getDataForTask(self)
Fetches data out of this SelectorChange for use by a Task.SelectorTask.		 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]
string text
Accessible text associated with the event, typically the item text or the selected text

Inherited from Base.AccessEngineEvent: focused, por, priority

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, por, text, kind=AEConstants.EVENT_ACTIVE_ITEM_SELECT, **kwargs)
(Constructor)

source code 

Calls the base class (which set the event priority) and then stores the item to be passed along to the Tier as part of the event.

Parameters:
  • por (POR) - Point-of-regard
  • text (string) - Accessible text associated with the event, typically the item text or the selected text
  • kind (integer) - Kind of selection 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 item text.

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

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

source code 

Contacts the TierManager so it can manage the selector 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
True if there is an active view, False if not to delay execution of this event until there is
Overrides: Base.AccessEngineEvent.execute

getFocusPOR(self)

source code 

Returns the POR for active item events. Used by Tier to maintain a focus POR.

Returns: POR
Point-of-regard for this focus event
Raises:
  • AttributeError - When the event does not represent a change in the focus

getDataForTask(self)

source code 

Fetches data out of this SelectorChange for use by a Task.SelectorTask.

Returns: dictionary
Dictionary of parameters to be passed to a Task.SelectorTask as follows:
  • por: The POR pointing at the item at which selection changed or the current caret location for a text selection change
  • text: The text now selected or unselected
  • kind: The kind of selection 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