Trees       Indices       Help   
SUE - Revision 232
Package AccessEngine :: Package AEEvent :: Module SelectorChange :: Class SelectorChange
[hide private]
[frames] | no frames]

Class SelectorChange

source code

  object --+    
           |    
Base.AEEvent --+
               |
              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 AETier as part of the event.		 source code
string
__str__(self)
Returns a human readable representation of this event including its name, its AEPor, and its item text.		 source code
boolean
execute(self)
Contacts the AETierManager so it can manage the selector change event.		 source code
AEPor
getFocusPOR(self)
Returns the AEPor for active item events.		 source code
dictionary
getDataForTask(self)
Fetches data out of this SelectorChange for use by a AEScript.EventScript.onSelectorChange-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]
string text
Accessible text associated with the event, typically the item text or the selected text

Inherited from Base.AEEvent: layer, 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 AETier as part of the event.
Parameters:
  • por (AEPor) - 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.AEEvent.__init__

__str__(self)
(Informal representation operator)

source code 
Returns a human readable representation of this event including its name, its AEPor, and its item text.
Returns: string
Information about this event
Overrides: Base.AEEvent.__str__

execute(self)

source code 
Contacts the AETierManager so it can manage the selector change event.
Returns: boolean
True if there is an active view, False if not to delay execution of this event until there is
Overrides: Base.AEEvent.execute

getFocusPOR(self)

source code 
Returns the AEPor for active item events. Used by AETier to maintain a focus AEPor.
Returns: AEPor
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 AEScript.EventScript.onSelectorChange-Task.
Returns: dictionary
Dictionary of parameters to be passed to a AEScript.EventScript.onCaretChange-Task as follows:
  • por: The AEPor 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.AEEvent.getDataForTask

   Trees       Indices       Help   
SUE - Revision 232
Generated by Epydoc 3.0beta1 on Mon Jun 30 13:05:55 2008 http://epydoc.sourceforge.net