Struct TTextCursor

struct TTextCursor;

Description

Text cursor parameter information.

A text cursor is a rectangular area which can be set to flash. It is normally only 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 selected for use through the window group using RWindowGroup::SetTextCursor(RWindowBase &,const TPoint &,const TTextCursor &).

Custom (non-rectangular) text cursors are supported from v7.0s. They are added to the window server using RWsSession::SetCustomTextCursor(TInt,const TArray< TSpriteMember > &,TUint,TCustomTextCursorAlignment), after which they can be selected for use through the window group, in the same way as standard rectangular cursors. They have a unique identifier, stored in the iType member, which must be greater than ETypeLastBasic. Custom text cursors are clipped to their iHeight and iWidth values. Their iColour member is not used.

Members

Defined in TTextCursor:

• EFlagClipHorizontalThe bitmap of each sprite member is clipped left of its x-origin and right of it...
• EFlagClipVerticalThe bitmap of each sprite member is clipped vertically.
• EFlagNoFlashThe text cursor should not flash.
• EFlagsCursor flash and clipping flags.
• ENamedCursorsCursor type values.
• ETypeAdded for compatibility with previous releases.
• ETypeFirstThe first predefined cursor type.
• ETypeHollowRectangleStandard hollow rectangular cursor.
• ETypeLastThe last predefined cursor type.
• ETypeLastBasicReserved for future use.
• ETypeRectangleStandard filled rectangular cursor.
• iAscentThe ascent of the text cursor (the distance between the origin and the top).
• iColorThe colour of the text cursor.
• iFlagsCursor flash and clipping flags.
• iHeightThe height of the text cursor.
• iTypeThe cursor type.
• iWidthThe width of the text cursor.

ENamedCursors

Description

Cursor type values.

The values between ETypeFirst and ETypeLastBasic are reserved for predefined cursors. Custom text cursors must have a value greater than ETypeLastBasic.

The values not listed below are for internal use only.

EFlags

Description

Cursor flash and clipping flags.

The flags not listed below are for internal use only.

typedef TInt TTextCursor::EType;

Description

Added for compatibility with previous releases.

TInt iType;

Description

The cursor type.

For possible values, see the ENamedCursors enum.

TInt iHeight;

Description

The height of the text cursor.

This value is also used for clipping custom text cursors, if the EFlagClipVertical flag is set.

TInt iAscent;

Description

The ascent of the text cursor (the distance between the origin and the top).

TInt iWidth;

Description

The width of the text cursor.

Custom text cursors are clipped to this value, if the EFlagClipHorizontal flag is set.

TUint iFlags;

Description

Cursor flash and clipping flags.

For possible values, see the EFlags enum.

TRgb iColor;

Description

The colour of the text cursor.

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

This value is not used for custom text cursors.