DECwindows Motif for OpenVMS Guide to Non-C Bindings

QUERY BEST STIPPLE

OpenVMS Format

status_return = X$QUERY_BEST_STIPPLE
(display, drawable_id, width, height, width_return, height_return)

Argument Information

Argument	Usage	Data Type	Access	Mechanism
status_return	cond_value	uns longword	write	value
display	identifier	uns longword	read	reference
drawable_id	identifier	uns longword	read	reference
width	uns longword	uns longword	read	reference
height	uns longword	uns longword	read	reference
width_return	uns longword	uns longword	write	reference
height_return	uns longword	uns longword	write	reference

Returns

status_return
Specifies whether the routine completed successfully. QUERY BEST STIPPLE returns one of the following values.

Value Description

X$_ERRORREPLY Error received from server.

SS$_NORMAL Routine completed successfully.

Value	Description
X$_ERRORREPLY	Error received from server.
SS$_NORMAL	Routine completed successfully.

QUERY BEST TILE

OpenVMS Format

status_return = X$QUERY_BEST_TILE
(display, drawable_id, width, height, width_return, height_return)

Argument Information

Argument	Usage	Data Type	Access	Mechanism
status_return	cond_value	uns longword	write	value
display	identifier	uns longword	read	reference
drawable_id	identifier	uns longword	read	reference
width	uns longword	uns longword	read	reference
height	uns longword	uns longword	read	reference
width_return	uns longword	uns longword	write	reference
height_return	uns longword	uns longword	read	reference

Returns

status_return
Specifies whether the routine completed successfully. QUERY BEST TILE returns one of the following values:

Value Description

X$_ERRORREPLY Error received from server.

SS$_NORMAL Routine completed successfully.

Value	Description
X$_ERRORREPLY	Error received from server.
SS$_NORMAL	Routine completed successfully.

QUERY COLOR

OpenVMS Format

X$QUERY_COLOR
(display, colormap_id, screen_def_return)

Argument Information

Argument	Usage	Data Type	Access	Mechanism
display	identifier	uns longword	read	reference
colormap_id	identifier	uns longword	read	reference
screen_def_return	record	x$color	write	reference

QUERY COLORS

OpenVMS

X$QUERY_COLORS
(display, colormap_id, screen_defs_return, num_colors)

Argument Information

Argument	Usage	Data Type	Access	Mechanism
display	identifier	uns longword	read	reference
colormap_id	identifier	uns longword	read	reference
screen_defs_return	record	x$color	write	reference
num_colors	longword	longword	read	reference

QUERY FONT

OpenVMS Format

status_return = X$QUERY_FONT
(display, font_id, font_struc_return)

Argument Information

Argument	Usage	Data Type	Access	Mechanism
status_return	cond_value	uns longword	write	value
display	identifier	uns longword	read	reference
font_id	identifier	uns longword	read	reference
font_struc_return	record	x$font_struct	write	reference

Returns

status_return
Specifies whether the routine completed successfully. QUERY FONT returns one of the following values:

Value Description

SS$_NORMAL Routine completed successfully.

X$_NOTFOUND No fonts matched pattern.

LIB$_STRTRU Font names returned but truncated.

LIB$_FATALERR LIB$SCOPY_R_DX fatal error.

LIB$_INSVIRMEM Insufficient virtual memory; LIB$GET_VM call failed.

LIB$_INVSTRDES Invalid string descriptor.

Value	Description
SS$_NORMAL	Routine completed successfully.
X$_NOTFOUND	No fonts matched pattern.
LIB$_STRTRU	Font names returned but truncated.
LIB$_FATALERR	LIB$SCOPY_R_DX fatal error.
LIB$_INSVIRMEM	Insufficient virtual memory; LIB$GET_VM call failed.
LIB$_INVSTRDES	Invalid string descriptor.

Arguments

font_struc_return
The address of the font data structure associated with the font. To obtain character structure information from the font data structure, use the GET CHAR STRUCT routine after calling LOAD QUERY FONT.

QUERY KEYMAP

OpenVMS Format

X$QUERY_KEYMAP
(display, keys_return)

Argument Information

Argument	Usage	Data Type	Access	Mechanism
display	identifier	uns longword	read	reference
keys_return	array	byte	write	reference

QUERY POINTER

OpenVMS Format

result_return = X$QUERY_POINTER
(display, window_id, root_id_return, [child_id_return], [root_x_coord_return], [root_y_coord_return], [win_x_coord_return], [win_y_coord_return], [state_mask_return])

Argument Information

Argument	Usage	Data Type	Access	Mechanism
result_return	Boolean	longword	write	value
display	identifier	uns longword	read	reference
window_id	identifier	uns longword	read	reference
root_id_return	identifier	uns longword	write	reference
child_id_return	identifier	uns longword	write	reference
root_x_coord_return	longword	longword	write	reference
root_y_coord_return	longword	longword	write	reference
win_x_coord_return	longword	longword	write	reference
win_y_coord_return	longword	longword	write	reference
state_mask_return	uns longword	uns longword	write	reference

QUERY TEXT EXTENTS

OpenVMS Format

X$QUERY_TEXT_EXTENTS
(display, font_id, string, [direction_return], [ascent_return], [descent_return], [overall_return])

Argument Information

Argument	Usage	Data Type	Access	Mechanism
display	identifier	uns longword	read	reference
font_id	identifier	uns longword	read	reference
string	char_string	character string	read	descriptor
direction_return	cond_value	uns longword	write	reference
ascent_return	cond_value	uns longword	write	reference
descent_return	cond_value	uns longword	write	reference
overall_return	cond_value	x$char_struct	write	reference

ARGUMENTS

direction_return
The direction the string is painted on the screen. The direction_return argument is the returned value of the direction element of the font data structure. This argument is optional.
ascent_return
The maximum ascent of the font used to draw the string. The ascent_return argument is the returned value of the font ascent element of the font data structure. This argument is optional.
descent_return
The maximum descent of the font used to draw the string. The descent_return argument is the returned value of the font descent element of the font data structure. This argument is optional.
overall_return
The minimum left bearing, maximum right bearing, string width, maximum character ascent, and maximum character descent. Values are returned from a character structure. This argument is optional.

QUERY TEXT EXTENTS 16

OpenVMS Format

X$QUERY_TEXT_EXTENTS_16
(display, font_id, string16, num_chars, [direction_return], [ascent_return], [descent_return], [overall_return])

Argument Information

Argument	Usage	Data Type	Access	Mechanism
display	identifier	uns longword	read	reference
font_id	identifier	uns longword	read	reference
string16	array	word	read	reference
num_chars	word	word	read	reference
direction_return	cond_value	uns longword	write	reference
ascent_return	cond_value	uns longword	write	reference
descent_return	cond_value	uns longword	write	reference
overall_return	cond_value	x$char_struct	read	reference

ARGUMENTS

direction_return
The direction in which the string is painted on the screen. The direction_return argument is the returned value of the direction element of the font data structure. This argument is optional.
ascent_return
Maximum ascent of the font used to draw the string. The ascent_return argument is the returned value of the font ascent element of the font data structure. This argument is optional.
descent_return
Maximum descent of the font used to draw the string. The descent_return argument is the returned value of the font descent element of the font data structure. This argument is optional.
overall_return
The minimum left bearing, maximum right bearing, string width, maximum character ascent, and maximum character descent. Values are returned from a character structure. This argument is optional.

QUERY TREE

OpenVMS Format

status_return = X$QUERY_TREE
(display, window_id, [root_id_return], [parent_id_return], [children_return], [num_children_return], [children_size_return], [children_buff_return])

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
root_id_return	identifier	uns longword	write	reference
parent_id_return	identifier	uns longword	write	reference
children_return	address	uns longword	write	reference
num_children_return	longword	longword	write	reference
children_size_return	longword	longword	write	reference
children_buff_return	identifier	uns longword	write	reference

Returns

status_return
Specifies whether the routine completed successfully. QUERY TREE returns one of the following values:

Value Description

X$_ERRORREPLY Error received from server; window no longer exists.

SS$_NORMAL Routine completed successfully.

Otherwise Failure for reason given.

Value	Description
X$_ERRORREPLY	Error received from server; window no longer exists.
SS$_NORMAL	Routine completed successfully.
Otherwise	Failure for reason given.

Arguments

root_id_return
The identifier of the root window of the specified window. This argument is optional.
parent_id_return
The identifier of the parent window of the specified window. This argument is optional.
children_return
The virtual address of a pointer to an array of child windows, returned by the routine and residing in space reserved by Xlib. Each element in the array is a child window of the specified window. The number of elements in the array is specified by num_children_return. This argument is optional.
num_children_return
The number of children associated with the specified window. This argument is optional.
children_size_return
The size of the buffer containing the child windows, specified in children_buff_return. This argument is optional.
children_buff_return
A pointer to a data buffer residing in space you have reserved, where each entry is one child window identifier. The size of the buffer is specified by children_size_return. This argument is optional.

RAISE WINDOW

OpenVMS Format

X$RAISE_WINDOW
(display, window_id)

Argument Information

Argument	Usage	Data Type	Access	Mechanism
display	identifier	uns longword	read	reference
window_id	identifier	uns longword	read	reference

Contents

Index