Struct TTextCursor

TTextCursor

Support

Supported from 5.0

Description

Text cursor parameter information.

A text cursor is a rectangular area of a single colour which can optionally be set to flash. A text cursor will only be visible when the window group which owns it has the keyboard focus. This structure is used to define the parameters of a text cursor, which can be added to a window group using RWindowGroup::SetTextCursor().

More information about the text cursor is given in the "using" document linked to below.

Defined in TTextCursor:
EFlagNoFlash, EFlags, EType, ETypeFirst, ETypeHollowRectangle, ETypeLast, ETypeRectangle, iAscent, iColor, iFlags, iHeight, iType, iWidth

See also:

• RWindowGroup::SetTextCursor()
• Using TTextCursor

EFlags

Description

Cursor flash flags.

Only one of the enumerated values is public.

EFlagNoFlash Display a non-flashing text cursor when this flag is set.

EType

Description

Cursor type flags.

A number of flags are defined in the public header file, however only the following two should be used.

ETypeRectangle Display a rectangular cursor. ETypeHollowRectangle Displays an un-filled rectangular cursor. ETypeFirst Display the first available cursor type. This can be used for iterating through the available cursor types. ETypeLast Displays the last available cursor type.This can be used for iterating through the available cursor types.

EType iType

Description

Cursor type flag.

This should be set to TTextCursor::ETypeRectangle or TTextCursor::ETypeHollowRectangle.

TInt iHeight

Description

The total height of the text cursor.

TInt iAscent

Description

The ascent of the text cursor from its origin

TInt iWidth

Description

The width of the text cursor.

TUint iFlags

Description

Cursor flash flags. Either EFlagNoFlash to display non-flashing text cursor or zero to display a flashing text cursor.

TRgb iColor

Description

The colour of the text cursor.

If the cursor is flashing, this colour is XOR'd with the screen.