cursor->initialise

Documentation
- Reference manual
- Packages
  - XPCE
    - Classes
      - class cursor
        
        Send methods
        
        cursor->initialise

cursor ->initialise: name=name*, image=[image], hot_spot=[point]

This method takes two forms. If only a name is specified, this should be a name of a cursor that is predefined in @cursor_names. This provides access to the SDL predefined cursors. See the demo program Cursors for the available predefined cursors. A typical usage is:

send(DebugIcon, cursor, not_allowed).

In its second form it allows the user the define a cursor. Such a cursor consists of:

cursor<-name Name for reference (see cursor<-lookup).

cursor<-image Image object describing the image.

cursor<-hot_spot Position of the pointer in the image.

cursor<-foreground Colour for the _1_-s in cursor<-image

cursor<-background Colour for the _0_-s in cursor<-image

cursor<-image must be specified. cursor<-hot_spot defaults to‘image cursor<-hot_spot’, or otherwise to point(0,0). Both colours default to the fore- and background colours of the display on which the cursor is opened and often need not be specified.

If the cursor has a cursor<-name, it is locked using object->protect. Otherwise the livetime of the cursor object follows the normal rules.

cursor`<-`name	Name for reference (see cursor`<-`lookup).
cursor`<-`image	Image object describing the image.
cursor`<-`hot_spot	Position of the pointer in the image.
cursor`<-`foreground	Colour for the _1_-s in cursor`<-`image
cursor`<-`background	Colour for the _0_-s in cursor`<-`image