TTextCursor Struct Reference

#include <textcursor.h>

struct TTextCursor

Detailed 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().

Custom (non-rectangular) text cursors are supported from v7.0s. They are added to the window server using RWsSession::SetCustomTextCursor(), 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.

Member Type Definition Documentation

Typedef EType

typedef TInt EType

Added for compatibility with previous releases.

Member Attribute Documentation

iAscent

TInt iAscent

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

iColor

TRgb iColor

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.

iFlags

TUint iFlags

Cursor flash and clipping flags.

For possible values, see the EFlags enum.

iHeight

TInt iHeight

The height of the text cursor.

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

iType

TInt iType

The cursor type.

For possible values, see the ENamedCursors enum.

iWidth

TInt iWidth

The width of the text cursor.

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

Member Enumeration Documentation

Enum EFlags

Cursor flash and clipping flags.

The flags not listed below are for internal use only.

EnumeratorValueDescription
EFlagNoFlash0x00000001

The text cursor should not flash.

EFlagClipHorizontal0x00000002

The bitmap of each sprite member is clipped left of its x-origin and right of its x-origin plus iWidth.

Used for custom text cursors only.

EFlagClipVertical0x00000004

The bitmap of each sprite member is clipped vertically.

How it is clipped depends on the text cursor's vertical alignment, see the TCustomTextCursorAlignment enum in class RWsSession.

Used for custom text cursors only.

Enum ENamedCursors

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.

EnumeratorValueDescription
ETypeNone
ETypeRectangle

Standard filled rectangular cursor.

ETypeHollowRectangle

Standard hollow rectangular cursor.

ETypeFirstETypeRectangle

The first predefined cursor type.

Equivalent to ETypeRectangle. This can be used for iterating through the predefined cursor types.

WARNING: Enum for internal use ONLY. Compatibility is not guaranteed in future releases.

ETypeLastETypeHollowRectangle

The last predefined cursor type.

Equivalent to ETypeHollowRectangle. This can be used for iterating through the predefined cursor types.

WARNING: Enum for internal use ONLY. Compatibility is not guaranteed in future releases.

ETypeLastBasic1000

Reserved for future use.

All custom text cursors must have a type value greater than this.