Class TEikVirtualCursor

class TEikVirtualCursor;

Description

Provides support for the virtual cursor's state within an application.

There is one instance of this object per CEikonEnv.

Members

Defined in TEikVirtualCursor:

• CursorState(CCoeEnv &)Gets the virtual cursor's state.
• EOffSets the virtual cursor off.
• EOnSets the virtual cursor on.
• ESuspendedSets the virtual cursor as suspended.
• SetCursorStateL(TState,CCoeEnv &)Sets the virtual cursor's state.
• TStateSpecifies the virtual cursor's state.

IMPORT_C void SetCursorStateL(TState aState, CCoeEnv &aEnv);

Description

Sets the virtual cursor's state.

The suspended state is for use by clients that wish to temporarily disable the cursor but not to switch it off completely.

Parameters

TEikVirtualCursor::TState aState The virtual cursor's required state. CCoeEnv &aEnv The environment in which the virtual cursor exists.

IMPORT_C TState CursorState(CCoeEnv &aEnv);

Description

Gets the virtual cursor's state.

Parameters

CCoeEnv &aEnv The environment in which the virtual cursor exists.

Return value

TEikVirtualCursor::TState The virtual cursor's state.

TState

Description

Specifies the virtual cursor's state.

The state may be on, off or suspended. The suspended state is for use by applications that wish to temporarily disable the cursor, but do not want to switch it off completely. For example, an editor control which when focused needs to capture arrow keys would disable the virtual cursor when it gains focus, and enable it when unfocused.

EOff Sets the virtual cursor off. EOn Sets the virtual cursor on. ESuspended Sets the virtual cursor as suspended.