Command: cursor

Syntax

cursor <name>, <file> { ,<mask_file> }

or

cursor <name> = <ident>

Description

Create or redefine a cursor identifier for use during graphic input.

Parameters

• <name>
  The name of the cursor identifier.

• <file>
  The name of the file containing the cursor image. On Windows systems this can be any type of image file, including a .ani animated cursor file. On Unix systems, this should be a monochrome image file, e.g. an X-11 bitmap file.

• <mask_file>
  The name of the file containing a cursor mask. This can only be used when <file> is a monochome image, and must itself be a monochrome image file, e.g. an X-11 bitmap file format. If omitted, it is assumed that there is no additional mask other than the original image.

• <ident>
  Copy the attributes of an existing cursor identifier into the new cursor identifier. All command switches are ignored.

Switches

• -col=<color>
  The color in which on bits (those set to 1) in the cursor image are displayed. If omitted, a default color (usually black) is used. This switch is valid for momochrome cursors only.

• -bcol=<color>
  The color in which off bits (those set to 0) in the cursor image are displayed. If omitted, a default color (usually white) is used. This switch is valid for momochrome cursors only.

• -hot=<x,y>
  Specifies a hot spot for the cursor, which positions it at draw time. If omitted, the hot spot in the image file is used. x and y are 2 numeric values, or a 2-dimensional array, and are in image co-ordinate space with (0,0) at the top left corner of the image. Do not use point (-1,-1) because this is used internally for special purposes.

Notes

For monochome images, the bits in the cursor image which are displayed are those corresponding to a 1 in the mask. Consequently, if the image and mask are identical, only the on bits in the cursor image are visible.

Cursor identifiers can have global or application scope, but cannot have local scope. When local cursor identifiers are required, string identifiers should be used to reference the cursor to which the local identifier refers.

Examples

cursor rp, $MXSYS/cursors/right_ptr

cursor rpm, $MXSYS/cursors/right_ptr, \ 
    $MXSYS/cursors/right_ptrmsk, -col=red, -bcol=white

cursor newrp = rp

cursor myhand, hand.gif,-hot=<8,8>

See Also