Package AccessEngine :: Package AEEvent :: Module MouseChange :: Class MouseChange

Class MouseChange

  object --+    
           |    
Base.AEEvent --+
               |
              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)
Contacts the AETierManager so it can manage the mouse event.

source code

dictionary

getDataForTask(self)
Fetches data out of this MouseChange for use by a AEScript.EventScript.onMouseChange-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 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.AEEvent: layer, 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.AEEvent.__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.AEEvent.__str__

execute(self)

source code

Contacts the AETierManager so it can manage the mouse event.

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

getDataForTask(self)

source code

Fetches data out of this MouseChange for use by a AEScript.EventScript.onMouseChange-Task.

Returns: dictionary

Dictionary of parameters to be passed to a AEScript.EventScript.onMouseChange-Task 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.AEEvent.getDataForTask

Class MouseChange

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

__str__(self) (Informal representation operator)

execute(self)

getDataForTask(self)

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

str(self)
(Informal representation operator)