Previous IDL Reference Guide: iTools Object Classes Next

IDLitWindow::GetEventMask

Syntax | Return Value | Arguments | Keywords | Version History

The IDLitWindow::GetEventMask function method returns a bitwise mask representing the events that are enabled for this window.

Syntax

Result = Obj->[IDLitWindow::]GetEventMask([, BUTTON_EVENTS=variable] [, KEYBOARD_EVENTS=variable] [, MOTION_EVENTS=variable] [, TIMER_EVENTS=variable] [, TRACKING_EVENTS=variable] [, WHEEL_EVENTS=variable] )

Return Value

Returns the bitwise mask as an unsigned long integer. The bits in the mask are as follows:

Table 7-14: Bits of the Event Mask

Table 7-14: Bits of the Event Mask
Bit
Value
Event
0
1
Button Events
1
2
Motion Events
2
4
Keyboard Events
3
8
Tracking Events
4
16
Timer Events
5
32
Wheel Events

Arguments

None

Keywords

BUTTON_EVENTS

Set this keyword equal to a named variable that will contain a 1 if mouse button events are currently enabled for this window, or a 0 otherwise.

KEYBOARD_EVENTS

Set this keyword equal to a named variable that will contain a 1 if keyboard events are currently enabled for this window, or a 0 otherwise.

MOTION_EVENTS

Set this keyword equal to a named variable that will contain a 1 if mouse motion events are currently enabled for this window, or a 0 otherwise.

TIMER_EVENTS

Set this keyword equal to a named variable that will contain a 1 if timer events are currently enabled for this window, or a 0 otherwise.

TRACKING_EVENTS

Set this keyword equal to a named variable that will contain a 1 if tracking events are currently enabled for this window, or a 0 otherwise.

WHEEL_EVENTS

Set this keyword equal to a named variable that will contain a 1 if wheel events are currently enabled for this window, or a 0 otherwise.

Version History

6.0
Introduced
6.2
Added TIMER_EVENTS keyword
6.4
Added WHEEL_EVENTS keyword

  IDL Online Help (March 06, 2007)