GPR_$SET_CURSOR_POSITION GPR Calls GPR_$SET_CURSOR_POSITION
NAME
gpr_$set_cursor_position - establishes a cursor position on the screen.
FORMAT
gpr_$set_cursor_position (position, status)
DESCRIPTION
This routine establishes a cursor position on the screen.
Cursor position: If a program calls this routine when in borrow mode, the
x- and y-coordinates represent an absolute position on the screen. If a
program calls this routine when the cursor is inside a frame of a Display
Manager pad, the x- and y-coordinates are offsets from the top left
corner of the frame.
Input Parameters
position
Screen coordinate position for display of the cursor, in
gpr_$position_t format. This data type is 4 bytes long. The first
element is the cursor position's x-coordinate; the second element is
the y-coordinate. Coordinate values must be within the limits of
the display. When running in frame mode, the x- and y-coordinates
must fall within the range 0 to 32767 inclusive. In direct mode,
the x- and y-coordinates must fall within the size of the window.
In borrow mode, the x- and y-coordinates must fall within the size
of display memory (as documented in the Programming with Domain
Graphics Primitives manual).
Output Parameters
status
Completion status, in status_$t format. This data type is 4 bytes
long. See the GPR Data Types section for more information.
SEE ALSO
gpr_$inq_cursor.
NOTES
If the coordinate position would cause any part of the cursor to be out-
side the screen or frame, the cursor moves only as far as the edge of the
screen. The cursor is neither clipped nor made to disappear.
In a Display Manager frame, this routine moves the cursor only if the
cursor is in the window viewing this frame when the call is issued. If
not, a "next window" command which moves to that window will move the
cursor to its new position.