Previous | Contents | Index |
mask_return = X$PARSE_GEOMETRYArgument Information(parse_string, [x_coord_return], [y_coord_return], [width_return], [height_return])
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
mask_return | mask_longword | uns longword | write | value |
parse_string | char_string | character string | read | descriptor |
x_coord_return | longword | longword | write | reference |
y_coord_return | longword | longword | write | reference |
width_return | longword | uns longword | write | reference |
height_return | longword | uns longword | write | reference |
mask_return
A bit mask that specifies which of four values (width, height, x-offset, and y-offset) were actually found in the string, and whether the x and y values are negative. Each bit indicates whether the corresponding value was found in the parsed string. For each value found, the corresponding argument is updated; for each value not found, the argument is left unchanged.Table 2-6 lists the predefined values and their descriptions for the mask.
Table 2-6 Parse Mask Bits Bit OpenVMS Description 1 X$M_NO_VALUE Reserved 2 X$M_X_VALUE The x-coordinate of the origin of a window 3 X$M_Y_VALUE The y-coordinate of the origin of a window 4 X$M_WIDTH_VALUE The width of the window in pixels 5 X$M_HEIGHT_VALUE The height of the window in pixels 6 X$M_ALL_VALUES Indicates if all values are present 7 X$M_X_NEGATIVE_VALUE Indicates if the x-coordinate is negative 8 X$M_Y_NEGATIVE_VALUE Indicates if the y-coordinate is negative
parse_string
The name of the string that you want to parse. The parse_string argument is the address of a character string descriptor that points to the string.x_coord_return
The x-coordinate to which to return the x-offset from the specified string. This coordinate is relative to the origin of the drawable. This argument is optional.y_coord_return
The y-coordinate to which to return the y-offset from the specified string. This coordinate is relative to the origin of the drawable. This argument is optional.width_return
The width, in pixels, from the specified string. This argument is optional.height_return
The height, in pixels, from the specified string. This argument is optional.
X$PEEK_EVENTArgument Information(display, event_return)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
display | identifier | uns longword | read | reference |
event_return | record | x$event | write | reference |
X$PEEK_IF_EVENTArgument Information(display, event_return, predicate, arg)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
display | identifier | uns longword | read | reference |
event_return | record | x$event | write | reference |
predicate | procedure | proc entry mask | read | reference |
arg | longword | uns longword | read | value |
count_return = X$PENDINGArgument Information(display)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
count_return | longword | longword | write | value |
display | identifier | uns longword | read | reference |
location_return = X$PERM_ALLOCArgument Information(size)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
location_return | longword | longword | write | value |
size | longword | longword | read | reference |
planes_return = X$PLANES_OF_SCREENArgument Information(screen_id)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
planes_return | longword | longword | write | value |
screen_id | identifier | uns longword | read | reference |
answer_return = X$POINT_IN_REGIONArgument Information(region_id, x_coord, y_coord)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
answer_return | longword | longword | write | value |
region_id | identifier | uns longword | read | reference |
x_coord | longword | longword | read | reference |
y_coord | longword | longword | read | reference |
region_id_return = X$POLYGON_REGIONArgument Information(points, num_points, fill_rule)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
region_id_return | identifier | uns longword | write | value |
points | array | uns longword | read | reference |
num_points | longword | longword | read | reference |
fill_rule | longword | uns longword | read | reference |
region_id_return
POLYGON REGION returns the region identifier when the region is created.
fill_rule
The fill rule that you want to set for the specified graphics context. The fill rule defines which pixels are inside (drawn) for paths given in FILL POLYGON requests.The possible predefined values for fill_rule are as follows:
X$C_EVEN_ODD_RULE
X$C_WINDING_RULE
revision_return = X$PROTOCOL_REVISIONArgument Information(display)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
revision_return | longword | longword | write | value |
display | identifier | uns longword | read | reference |
version_return = X$PROTOCOL_VERSIONArgument Information(display)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
version_return | longword | longword | write | value |
display | identifier | uns longword | read | reference |
X$PUT_BACK_EVENTArgument Information(display, event)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
display | identifier | uns longword | read | reference |
event | record | x$event | read | reference |
X$PUT_IMAGEArgument Information(display, drawable_id, gc_id, ximage, src_x_coord, src_y_coord, dst_x_coord, dst_y_coord, width, height)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
display | identifier | uns longword | read | reference |
drawable_id | identifier | uns longword | read | reference |
gc_id | identifier | uns longword | read | reference |
ximage | record | x$image | read | reference |
src_x_coord | longword | longword | read | reference |
src_y_coord | longword | longword | read | reference |
dst_x_coord | longword | longword | read | reference |
dst_y_coord | longword | longword | read | reference |
width | longword | longword | read | reference |
height | longword | longword | read | reference |
X$PUT_PIXELArgument Information(ximage, x_coord, y_coord, pixel)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
ximage | record | x$image | read | reference |
x_coord | longword | longword | read | reference |
y_coord | longword | longword | read | reference |
pixel | longword | uns longword | read | reference |
length_return = X$Q_LENGTHArgument Information(display)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
length_return | longword | longword | write | value |
display | identifier | uns longword | read | reference |
X$QUERY_BEST_CURSORArgument Information(display, drawable_id, width, height, width_return, height_return)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
display | identifier | uns longword | read | reference |
drawable_id | identifier | uns longword | read | reference |
width | longword | uns longword | read | reference |
height | longword | uns longword | read | reference |
width_return | cond_value | uns longword | write | reference |
height_return | cond_value | uns longword | write | reference |
status_return
Specifies whether the routine completed successfully.
Value Description SS$_NORMAL Routine completed successfully.
status_return = X$QUERY_BEST_SIZEArgument Information(display, class, drawable_id, width, height, width_return, height_return)
Argument | Usage | Data Type | Access | Mechanism |
---|---|---|---|---|
status_return | cond_value | uns longword | write | value |
display | identifier | uns longword | read | reference |
class | longword | 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 |
status_return
Specifies whether the routine completed successfully. QUERY BEST SIZE returns one of the following values:
Value Description X$_ERRORREPLY Error received from server. SS$_NORMAL Routine completed successfully.
class
The item for which to determine the best size. The predefined values for class are as follows:X$C_TILE_SHAPE
X$C_STIPPLE_SHAPE
X$C_CURSOR_SHAPEOther values specified in this argument are not valid.
Previous | Next | Contents | Index |