Functions and Directives Functions and Directives

Function SetCursor() Foundation

Determines the shape of the cursor on the screen.

Syntax
SetCursor( [<nCursorShape>] ) --> nCurrentShape
Parameters
<nCursorShape>
<nCursorShape> is an integer numeric expression specifying the shape of the cursor. Symbolic constants describing the various cursor shapes are defined in the header file Setcurs.ch. The following table lists the constants:
Cursor forms
Value Setcurs.ch Cursor shape"
0 SC_NONE Not visible
1 SC_NORMAL Underscore
2 SC_INSERT Half block bottom
3 SC_SPECIAL1 Full block
4 SC_SPECIAL2 Half block top
Return

SetCursor() returns the current cursor shape as a numeric value.

Description

The function SetCursor() specifies the shape of the screen cursor. The shape is dependent on the applied screen driver.

By passing zero to SetCursor() the cursor is hidden. This is equivalent to the command SET CURSOR OFF. If a value from the table is passed to the function, it works like the command SET CURSOR ON and the cursor is displayed in the selected shape.

When <nCursorShape> is not specified, the function simply returns the current setting.

Examples
SetCursor() 
// In the example, the displayed cursor is dependent on 
// ReadInsert() and is either an underscore or a full block. 

 #include "Setcurs.ch" 

 PROCEDURE Main 

    USE Address NEW 

    @ 5,15  SAY  " Last name:"  GET  LASTNAME 
    @ 6,15  SAY  "First name:"  GET  FIRSTNAME 

    SetCursor( IIf( ReadInsert(), SC_SPECIAL2, SC_NORMAL) ) 

    READ 
    USE 
RETURN
Feedback

If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.