ESCAPE -6(3P) — SUNPHIGS LIBRARY

NAME

ESCAPE -6 − set a workstation’s cursor type and colour

SYNOPSIS

C Syntax

void
pescape ( func_id, in, out )
Pintfunc_id;escape function identifier
Pescapein∗in;input data for the function
Pescapeout∗out;OUT output data of the function

FORTRAN Syntax

SUBROUTINE pesc ( FCTID, LIDR, IDR, MLODR, LODR, ODR )
INTEGERFCTIDfunction identification
INTEGERLIDRdimension of input data record array
CHARACTER∗80IDR(LIDR) input data record
INTEGERMLODRmaximum length of output data record
INTEGERLODROUT number of array elements used in ODR
CHARACTER∗80ODR(MLODR) OUT output data record

Required PHIGS Operating States

(PHOP, ∗, ∗, ∗)

DESCRIPTION

Purpose

ESCAPE -6 allows the application to changes the type, colour, and drawing op of the cursor used normally or during structure traversal.

C Input Parameters

func_id
The function identifier for this escape is PUESC_SET_CURSOR defined in phigs.h to have the value -6.

in
A pointer to a Pescapein union containing the input data record, uesc6_idatarec. It is defined as:

typedef struct {
Pintwsid;/∗ workstation id ∗/
Phigs_cursor_whichcursor_which;/∗ which cursor to change ∗/
Phigs_cursor_typecursor_type;/∗ cursor type ∗/
Pintcursor_colour;/∗ cursor colour ∗/
Phigs_drawing_opcursor_op;/∗ cursor drawing op ∗/
} Puesc0006_idatarec; /∗ Set cursor type∗/

cursor_which
The cursor_which member is one of the following enumerated values:

0PHIGS_NORMAL_CURSORNon-traversal Cursor
1PHIGS_TRAVERAL_CURSORTraversal Cursor

cursor_type
The cursor_type member is one of the following enumerated values:

0 PHIGS_CURSOR_NONENo Cursor
1 PHIGS_CURSOR_DEFAULTCanvas’ Current Cursor
2 PHIGS_CURSOR_CROSSHAIRCrosshair
3 PHIGS_CURSOR_CROSSTracking Cross
12PHIGS_CURSOR_NOT_SIGNNot Sign

cursor_colour
The cursor_colour member is a colour index.

cursor_op
The cursor_op member controls the cursor raster op. Its enumerated values and the corresponding raster op modes are as follows:

0PHIGS_OP_XORPIX_SRC ^ PIX_DST
1PHIGS_OP_SRCPIX_SRC
2PHIGS_OP_ORPIX_SRC | PIX_DST
3PHIGS_OP_ANDPIX_SRC & PIX_DST
4PHIGS_OP_NOT_ANDPIX_NOT(PIX_SRC) & PIX_DST
5PHIGS_OP_NOTPIX_NOT(PIX_DST)

For a decription of the raster op modes, see the Pixrect Reference Manual.

C Output Parameters

There is no output data record for this escape.

FORTRAN Input Parameters

FCTID
The function identifier for this escape is PUESCSETCURSOR, defined in phigs77.h to have the value -6.

LIDR
The dimension of the input data record array, IDR, (returned by PACK DATA RECORD). ERROR HANDLING will be invoked if the specified dimension is less than zero.

IDR(LIDR)
An ESCAPE input data record packed by PACK DATA RECORD containing the input data for this escape. The arguments to PACK DATA RECORD should be as follows:

ILThe number of integers = 5.

IAContains five integer values.

Element 1 is the workstation id.

Element 2 specifies which cursor to change, one of the following enumerated values:

0PHIGSNORMCURSNon-traversal Cursor
1PHIGSTRAVCURSTraversal Cursor

Element 3 is the cursor type, one of the following enumerated values:

0PHIGSCURSNONENo Cursor
1PHIGSCURSDEFAULTCanvas’ Current Cursor
2PHIGSCURSCRSHAIRCrosshair
3PHIGSCURSCROSSTracking Cross
12PHIGSCURSNOTSIGNNot Sign

Element 4 is the cursor colour index.

Element 5 is the cursor drawing op. Its enumerated values and the corresponding raster op modes are as follows:

0PHIGSOPXORPIX_SRC ^ PIX_DST
1PHIGSOPSRCPIX_SRC
2PHIGSOPORPIX_SRC | PIX_DST
3PHIGSOPANDPIX_SRC & PIX_DST
4PHIGSOPNOTANDPIX_NOT(PIX_SRC) & PIX_DST
5PHIGSOPNOTPIX_NOT(PIX_DST)

For a description of the raster op modes, see the Pixrect Reference Manual.

RLThe number of real values = 0.

SLThe number of strings = 0.

FORTRAN Output Parameters

There is no output data record for this escape.

EXECUTION

The Set Cursor Type escape provides control over the cursor a workstation displays. The workstation displays different cursors under different conditions. When the workstation is traversing posted structure networks, it displays the traversal cursor, using the specified colour and op. When the workstation is not traversing, its cursor is specified by normal cursor, using the specified colour and op. The type and colour of the normal cursor may be overidden by active input devices.

This ESCAPE may be called any time the specified workstation is open.

ERRORS

002Ignoring function, function requires state (PHOP, ∗, ∗, ∗)

350Warning, the specified escape is not available on one or more workstations in this implementation. The escape will be processed by those workstations on which it is available

351Ignoring function, one of the fields within the escape data record is in error

Museum