TEikVirtualCursor Class Reference

#include <mw/eikvcurs.h>

Link against: eikcore.lib

class TEikVirtualCursor
Public Member Enumerations
enumTState { EOff, EOn, ESuspended }
Public Member Functions
TEikVirtualCursor()
IMPORT_C TStateCursorState(CCoeEnv &)
voidHandleAppToForeground(CCoeEnv &)
IMPORT_C voidSetCursorStateL(TState, CCoeEnv &)

Detailed Description

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

There is one instance of this object per CEikonEnv.

Member Enumeration Documentation

Enum TState

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.

EnumeratorValueDescription
EOff0

Sets the virtual cursor off.

EOn

Sets the virtual cursor on.

ESuspended

Sets the virtual cursor as suspended.

Constructor & Destructor Documentation

TEikVirtualCursor ( )

TEikVirtualCursor()

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

Member Function Documentation

CursorState ( CCoeEnv & )

IMPORT_C TStateCursorState(CCoeEnv &aEnv)

Gets the virtual cursor's state.

ParameterDescription
aEnvThe environment in which the virtual cursor exists.

Returns: The virtual cursor's state.

HandleAppToForeground ( CCoeEnv & )

voidHandleAppToForeground(CCoeEnv &aEnv)

Switches mouse/pointer cursor on and off according to cursor state.

SetCursorStateL ( TState, CCoeEnv & )

IMPORT_C voidSetCursorStateL(TStateaState,
CCoeEnv &aEnv
)

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.

ParameterDescription
aStateThe virtual cursor's required state.
aEnvThe environment in which the virtual cursor exists.