TEikVirtualCursor Class Reference

class TEikVirtualCursor

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

There is one instance of this object per CEikonEnv.

Public Member Functions
TEikVirtualCursor()
IMPORT_C TStateCursorState(CCoeEnv &)
voidHandleAppToForeground(CCoeEnv &)
IMPORT_C voidSetCursorStateL(TState, CCoeEnv &)
Private Member Functions
TEikVirtualCursor(const TEikVirtualCursor &)
voidSwitchOffEmulationAndBitmap(CCoeEnv &)
voidSwitchOnEmulationAndBitmap(CCoeEnv &)
Public Member Enumerations
enumTState { EOff = 0, EOn, ESuspended }
Private Attributes
TState iState

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

TEikVirtualCursor(const TEikVirtualCursor &)

TEikVirtualCursor(const TEikVirtualCursor &)[private, inline]

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

Parameters

const TEikVirtualCursor &

Member Functions Documentation

CursorState(CCoeEnv &)

IMPORT_C TStateCursorState(CCoeEnv &aEnv)

Gets the virtual cursor's state.

Parameters

CCoeEnv & aEnvThe environment in which the virtual cursor exists.

HandleAppToForeground(CCoeEnv &)

voidHandleAppToForeground(CCoeEnv &aEnv)

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

Parameters

CCoeEnv & aEnv

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.

Parameters

TState aStateThe virtual cursor's required state.
CCoeEnv & aEnvThe environment in which the virtual cursor exists.

SwitchOffEmulationAndBitmap(CCoeEnv &)

voidSwitchOffEmulationAndBitmap(CCoeEnv &aEnv)[private]

Parameters

CCoeEnv & aEnv

SwitchOnEmulationAndBitmap(CCoeEnv &)

voidSwitchOnEmulationAndBitmap(CCoeEnv &aEnv)[private]

Parameters

CCoeEnv & aEnv

Member Enumerations 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.

Enumerators

EOff = 0

Sets the virtual cursor off.

EOn

Sets the virtual cursor on.

ESuspended

Sets the virtual cursor as suspended.

Member Data Documentation

TState iState

TState iState[private]