Python API 2.0 Reference: OpenMayaUI.MEvent Class Reference

+ Inheritance diagram for OpenMayaUI.MEvent:

Public Member Functions

__init__ ()
 
getWindowPosition ()
 
isModifierControl ()
 
isModifierKeyRelease ()
 
isModifierLeftMouseButton ()
 
isModifierMiddleMouseButton ()
 
isModifierNone ()
 
isModifierShift ()
 
mouseButton ()
 

Static Public Attributes

int controlKey = 4
 
int kLeftMouse = 64
 
int kMiddleMouse = 128
 
int shiftKey = 1
 

Properties

 modifiers
 
 position
 

Detailed Description

Query interactive system events.

Constructor & Destructor Documentation

OpenMayaUI.MEvent.__init__ ( )
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Member Function Documentation

OpenMayaUI.MEvent.getWindowPosition ( )
getWindowPosition() -> (x, y)

This routine is used by responders to query the position of the
pointer when the event occurred.  It is given in screen co-ordinates.


Returns a tuple containing the x and y position of the event.
OpenMayaUI.MEvent.isModifierControl ( )
isModifierControl() -> bool

Return the state of the control key.


Returns True if the control key was pressed at the time the event was triggered, False otherwise.
OpenMayaUI.MEvent.isModifierKeyRelease ( )
isModifierKeyRelease() -> bool

Was a modifier key released.


Returns True if a modifier key was released, False otherwise.
OpenMayaUI.MEvent.isModifierLeftMouseButton ( )
isModifierLeftMouseButton() -> bool

Return the state of the left mouse button.


This method is only valid when called in the hold event for
another mouse press.


Returns True if the left mouse button was pressed at the time the event was triggered, False otherwise.
OpenMayaUI.MEvent.isModifierMiddleMouseButton ( )
isModifierMiddleMouseButton() -> bool

Return the state of the middle mouse button.


This method is only valid when called in the hold event for
another mouse press.


Returns True if the left mouse button was pressed at the time the event was triggered, False otherwise.
OpenMayaUI.MEvent.isModifierNone ( )
isModifierNone() -> bool

Determines if there are any modifiers for this event.


Returns True if there are modifiers for this event, False otherwise.
OpenMayaUI.MEvent.isModifierShift ( )
isModifierShift() -> bool

Return the state of the shift key.


Returns True if the shift key was pressed at the time the event was triggered, False otherwise.
OpenMayaUI.MEvent.mouseButton ( )
mouseButton() -> mouseButtonType

Get the mouse button of the last event.


Returns the mouse button from last event.

Property Documentation

OpenMayaUI.MEvent.modifiers
static
 The state of the modifiers.
OpenMayaUI.MEvent.position
static
 The location of the event.