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

Class MouseChange

source code

            object --+    
                     |    
Base.AccessEngineEvent --+
                         |
                        MouseChange

Event that fires when the mouse cursor moves or a button is pressed.

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, kind, pos=None, button=None, **kwargs)
Calls the base class and stores the kind and position or button number.		 source code
string
__str__(self)
Returns a human readable representation of this event including its name, its kind, and its absolute position.		 source code
boolean
execute(self, tier_manager, **kwargs)
Contacts the TierManager so it can manage the mouse event.		 source code
dictionary
getDataForTask(self)
Fetches data out of this MouseChange for use by a Task.MouseTask.		 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 button
Number of the button pressed
integer kind
Kind of mouse event
2-tuple of integer pos
Absolute position of the mouse pointer

Inherited from Base.AccessEngineEvent: focused, por, priority

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, kind, pos=None, button=None, **kwargs)
(Constructor)

source code 

Calls the base class and stores the kind and position or button number.

Parameters:
  • kind (integer) - Kind of mouse event
  • pos (2-tuple of integer) - Absolute position of the mouse pointer
  • button (integer) - Number of the button pressed or released
Overrides: Base.AccessEngineEvent.__init__

__str__(self)
(Informal representation operator)

source code 

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

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 mouse 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 MouseChange for use by a Task.MouseTask.

Returns: dictionary
Dictionary of parameters to be passed to a Task.MouseTask as follows:
  • kind: The kind of mouse event
  • pos: The new absolute position of the cursor
  • button: The number of the button pressed or released
Overrides: Base.AccessEngineEvent.getDataForTask

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