Class TEikVirtualCursor

TEikVirtualCursor

Support

Supported from 6.0

Description

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

There is one instance of this object per CEikonEnv.

Defined in TEikVirtualCursor:
CursorState(), EOff, EOn, ESuspended, SetCursorStateL(), TEikVirtualCursor(), TState

TEikVirtualCursor();

Description

Constructor.

Sets the cursor's state to ESuspended so that the call to switch off the virtual cursor will succeed when the application starts. Required due to the efficient implementation of SetCursorState().

void SetCursorStateL(TState aState, CCoeEnv& aEnv);

Description

Sets the virtual cursor's state.

Parameters

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

TState CursorState(CCoeEnv& aEnv);

Description

Gets the virtual cursor's state.

Parameters

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

Return value

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 gained 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.