 |
DECwindows Motif for OpenVMS Guide to Non-C
Bindings
GET WM PROTOCOLS
OpenVMS Format
status_return = X$GET_WM_PROTOCOLS
(display, window_id, [protocols_return], [count_return], [prot_size],
[prot_buff_return])
Argument Information
| Argument |
Usage |
Data Type |
Access |
Mechanism |
|
status_return
|
cond_value
|
uns longword
|
write
|
reference
|
|
display
|
identifier
|
uns longword
|
read
|
reference
|
|
window_id
|
identifier
|
uns longword
|
read
|
reference
|
|
protocols_return
|
address
|
uns longword
|
write
|
reference
|
|
count_return
|
longword
|
longword
|
write
|
reference
|
|
prot_size
|
longword
|
longword
|
read
|
reference
|
|
prot_buff_return
|
address
|
uns longword
|
write
|
reference
|
Arguments
protocols_return
A pointer to a data buffer returned by the routine and residing in
space reserved by Xlib. Each entry is one protocol element. This
argument is optional.
prot_size
The length of the data buffer specified in
prot_buff_return. This argument is optional.
prot_buff_return
A pointer to a data buffer residing in space you have reserved, where
each entry is one protocol element. This argument is optional.
GET ZOOM HINTS
OpenVMS Format
status_return = X$GET_ZOOM_HINTS
(display, window_id, zhints_return)
Argument Information
| Argument |
Usage |
Data Type |
Access |
Mechanism |
|
status_return
|
longword
|
uns longword
|
write
|
value
|
|
display
|
identifier
|
uns longword
|
read
|
reference
|
|
window_id
|
identifier
|
uns longword
|
read
|
reference
|
|
zhints_return
|
record
|
x$size_hints
|
write
|
reference
|
Returns
status_return
Specifies whether the routine completed successfully.
| Value |
Description |
|
Non-zero
|
Routine completed successfully.
|
|
0
|
Routine did not complete successfully.
|
GRAB BUTTON
OpenVMS Format
X$GRAB_BUTTON
(display, button, modifiers, window_id, owner_events, event_mask,
pointer_mode, keyboard_mode, confine_id, cursor_id)
Argument Information
| Argument |
Usage |
Data Type |
Access |
Mechanism |
|
display
|
identifier
|
uns longword
|
read
|
reference
|
|
button
|
longword
|
longword
|
read
|
reference
|
|
modifiers
|
mask_longword
|
uns longword
|
read
|
reference
|
|
window_id
|
identifier
|
uns longword
|
read
|
reference
|
|
owner_events
|
Boolean
|
uns longword
|
read
|
reference
|
|
event_mask
|
mask_longword
|
uns longword
|
read
|
reference
|
|
pointer_mode
|
longword
|
longword
|
read
|
reference
|
|
keyboard_mode
|
longword
|
longword
|
read
|
reference
|
|
confine_id
|
identifier
|
uns longword
|
read
|
reference
|
|
cursor_id
|
identifier
|
uns longword
|
read
|
reference
|
Arguments
button
The button on the pointing device to grab when the specified modifier
keys are down. The possible predefined values are as follows:
X$C_BUTTON1
X$C_BUTTON2
X$C_BUTTON3
X$C_BUTTON4
X$C_BUTTON5
X$C_ANY_BUTTON
Other buttons pressed are not grabbed. Specify the predefined value
X$C_ANY_BUTTON to grab all possible buttons.
modifiers
The set of key masks. This mask is the inclusive OR of the following
key mask bits:
| Bit |
Predefined Value |
|
1
|
X$M_SHIFT
|
|
2
|
X$M_CAPS_LOCK
|
|
3
|
X$M_CONTROL
|
|
4
|
X$M_MOD1
|
|
5
|
X$M_MOD2
|
|
6
|
X$M_MOD3
|
|
7
|
X$M_MOD4
|
|
8
|
X$M_MOD5
|
The predefined value X$C_ANY_MODIFIER can be specified to allow any set
of modifiers to be grabbed.
event_mask
A bit mask that specifies which pointer events are reported to the
client.
Table 2-4 lists the predefined values for the
event_mask.
Table 2-4 Event Mask Description
| Bit |
Predefined Value |
Description |
|
2
|
X$M_BUTTON_PRESS
|
Pointer button down events wanted
|
|
3
|
X$M_BUTTON_RELEASE
|
Pointer button up events wanted
|
|
4
|
X$M_ENTER_WINDOW
|
Pointer window entry events wanted
|
|
5
|
X$M_LEAVE_WINDOW
|
Pointer window leave events wanted
|
|
6
|
X$M_POINTER_MOTION
|
Pointer motion events wanted
|
|
7
|
X$M_POINTER_MOTION_HINT
|
Pointer motion hints wanted
|
|
8
|
X$M_BUTTON1_MOTION
|
Pointer motion while button 1 down
|
|
9
|
X$M_BUTTON2_MOTION
|
Pointer motion while button 2 down
|
|
10
|
X$M_BUTTON3_MOTION
|
Pointer motion while button 3 down
|
|
11
|
X$M_BUTTON4_MOTION
|
Pointer while button 4 down
|
|
12
|
X$M_BUTTON5_MOTION
|
Pointer motion while button 5 down
|
|
13
|
X$M_BUTTON_MOTION
|
Pointer motion while any button down
|
|
14
|
X$M_KEYMAP_STATE
|
Any keyboard state change wanted
|
pointer_mode
A constant that controls further processing of pointer events. Clients
can pass one of the following constants:
X$C_GRAB_MODE_SYNC
X$C_GRAB_MODE_ASYNC
Other values specified in this argument are not valid.
keyboard_mode
The mode that the keyboard events will use. The predefined values for
keyboard_mode are as follows:
X$C_GRAB_MODE_SYNC
X$C_GRAB_MODE_ASYNC
GRAB KEY
OpenVMS Format
X$GRAB_KEY
(display, keycode, modifiers, window_id, owner_events, pointer_mode,
keyboard_mode)
Argument Information
| Argument |
Usage |
Data Type |
Access |
Mechanism |
|
display
|
identifier
|
uns longword
|
read
|
reference
|
|
keycode
|
longword
|
longword
|
read
|
reference
|
|
modifiers
|
longword
|
uns longword
|
read
|
reference
|
|
window_id
|
identifier
|
uns longword
|
read
|
reference
|
|
owner_events
|
Boolean
|
longword
|
read
|
reference
|
|
pointer_mode
|
longword
|
longword
|
read
|
reference
|
|
keyboard_mode
|
longword
|
longword
|
read
|
reference
|
Arguments
modifiers
A bit mask that specifies the set of key masks. This mask is the
inclusive OR of the following key mask bits:
| Bit |
Predefined Value |
|
1
|
X$M_SHIFT
|
|
2
|
X$M_CAPS_LOCK
|
|
3
|
X$M_CONTROL
|
|
4
|
X$M_MOD1
|
|
5
|
X$M_MOD2
|
|
6
|
X$M_MOD3
|
|
7
|
X$M_MOD4
|
|
8
|
X$M_MOD5
|
The predefined value X$C_ANY_MODIFIER can be specified to allow any set
of modifiers to be grabbed, including the combination of no modifiers.
pointer_mode
The processing of pointer events. The predefined values for
pointer_mode are as follows:
X$C_GRAB_MODE_SYNC
X$C_GRAB_MODE_ASYNC
Other values specified in this argument are not valid.
keyboard_mode
The processing of keyboard events. The predefined values for
keyboard_mode are as follows:
X$C_GRAB_MODE_SYNC
X$C_GRAB_MODE_ASYNC
GRAB KEYBOARD
OpenVMS Format
status_return = X$GRAB_KEYBOARD
(display, window_id, owner_events, pointer_mode, keyboard_mode, time)
Argument Information
| Argument |
Usage |
Data Type |
Access |
Mechanism |
|
status_return
|
longword
|
uns longword
|
write
|
value
|
|
display
|
identifier
|
uns longword
|
read
|
reference
|
|
window_id
|
identifier
|
uns longword
|
read
|
reference
|
|
owner_events
|
Boolean
|
longword
|
read
|
reference
|
|
pointer_mode
|
longword
|
longword
|
read
|
reference
|
|
keyboard_mode
|
longword
|
longword
|
read
|
reference
|
|
time
|
longword
|
uns longword
|
read
|
reference
|
Returns
status_return
Specifies whether the routine completed successfully. GRAB KEYBOARD
returns one of the following status values:
| Value |
Description |
|
X$C_GRAB_SUCCESS
|
Routine completed successfully.
|
|
X$C_ALREADY_GRABBED
|
Keyboard is actively grabbed by another client.
|
|
X$C_GRAB_FROZEN
|
Keyboard is frozen by an active grab of another client.
|
|
X$C_GRAB_INVALID_TIME
|
Time specified in
time is earlier than the last pointer grab time, or
later than the current server time.
|
|
X$C_GRAB_NOT_VIEWABLE
|
Windows specified in
window_id are not currently viewable.
|
Arguments
pointer_mode
The constant that specifies the processing of pointer events. The
predefined values for pointer_mode are as follows:
X$C_GRAB_MODE_SYNC
X$C_GRAB_MODE_ASYNC
keyboard_mode
The processing of keyboard events. The predefined values for
keyboard_mode are as follows:
X$C_GRAB_MODE_SYNC
X$C_GRAB_MODE_ASYNC
GRAB POINTER
OpenVMS Format
status_return = X$GRAB_POINTER
(display, window_id, owner_events, event_mask, pointer_mode,
keyboard_mode, confine_id, cursor_id, time)
Argument Information
| Argument |
Usage |
Data Type |
Access |
Mechanism |
|
status_return
|
cond_value
|
uns longword
|
write
|
value
|
|
display
|
identifier
|
uns longword
|
read
|
reference
|
|
window_id
|
identifier
|
uns longword
|
read
|
reference
|
|
owner_events
|
Boolean
|
longword
|
read
|
reference
|
|
event_mask
|
mask_longword
|
uns longword
|
read
|
reference
|
|
pointer_mode
|
longword
|
longword
|
read
|
reference
|
|
keyboard_mode
|
longword
|
longword
|
read
|
reference
|
|
confine_id
|
identifier
|
uns longword
|
read
|
reference
|
|
cursor_id
|
identifier
|
uns longword
|
read
|
reference
|
|
time
|
longword
|
uns longword
|
read
|
reference
|
Returns
status_return
Specifies whether the routine completed successfully. GRAB POINTER
returns the following status:
| Value |
Description |
|
X$C_GRAB_SUCCESS
|
Routine completed successfully.
|
|
X$C_ALREADY_GRABBED
|
Pointer is actively grabbed by another client.
|
|
X$C_GRAB_FROZEN
|
Pointer is frozen by an active grab of another client.
|
|
X$C_GRAB_INVALID_TIME
|
Time specified in
time is earlier than the last pointer grab time, or
later than the current server time. Otherwise, the last pointer grab
time is set to the specified time. CurrentTime is replaced by the
current server time.
|
|
X$C_GRAB_NOT_VIEWABLE
|
Windows specified in
window_id or
confine_id are not currently viewable, or
confine_id window lies completely outside the
boundaries of the root window.
|
Arguments
event_mask
A bit mask that specifies the events. Table 2-5 lists the predefined
values for the event mask.
Table 2-5 Event Mask Description
| Bit |
Predefined Value |
Description |
|
2
|
X$M_BUTTON_PRESS
|
Pointer button down events wanted
|
|
3
|
X$M_BUTTON_RELEASE
|
Pointer button up events wanted
|
|
4
|
X$M_ENTER_WINDOW
|
Pointer window entry events wanted
|
|
5
|
X$M_LEAVE_WINDOW
|
Pointer window leave events wanted
|
|
6
|
X$M_POINTER_MOTION
|
Pointer motion events wanted
|
|
7
|
X$M_POINTER_MOTION_HINT
|
Pointer motion hints wanted
|
|
8
|
X$M_BUTTON1_MOTION
|
Pointer motion while button 1 down
|
|
9
|
X$M_BUTTON2_MOTION
|
Pointer motion while button 2 down
|
|
10
|
X$M_BUTTON3_MOTION
|
Pointer motion while button 3 down
|
|
11
|
X$M_BUTTON4_MOTION
|
Pointer motion while button 4 down
|
|
12
|
X$M_BUTTON5_MOTION
|
Pointer motion while button 5 down
|
|
13
|
X$M_BUTTON_MOTION
|
Pointer motion while any button down
|
|
14
|
X$M_KEYMAP_STATE
|
Any keyboard state change wanted
|
pointer_mode
The mode that the pointer events will use. The predefined values for
pointer_mode are as follows:
X$C_GRAB_MODE_SYNC
X$C_GRAB_MODE_ASYNC
Other values specified in this argument are not valid.
keyboard_mode
The processing of keyboard events. The predefined values for
keyboard_mode are as follows:
X$C_GRAB_MODE_SYNC
X$C_GRAB_MODE_ASYNC
Other values specified in this argument are not valid.
|
