#include <mw/eikvcurs.h>
| class TEikVirtualCursor |
| Public Member Enumerations | |
|---|---|
| enum | TState { EOff, EOn, ESuspended } |
| Public Member Functions | |
|---|---|
| TEikVirtualCursor() | |
| IMPORT_C TState | CursorState(CCoeEnv &) |
| void | HandleAppToForeground(CCoeEnv &) |
| IMPORT_C void | SetCursorStateL(TState, CCoeEnv &) |
Provides support for the virtual cursor's state within an application.
There is one instance of this object per CEikonEnv.
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.
| Enumerator | Value | Description |
|---|---|---|
| EOff | 0 |
Sets the virtual cursor off. |
| EOn |
Sets the virtual cursor on. | |
| ESuspended |
Sets the virtual cursor as suspended. |
| 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().
| void | HandleAppToForeground | ( | CCoeEnv & | aEnv | ) |
Switches mouse/pointer cursor on and off according to cursor state.
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 | |
|---|---|
| aState | The virtual cursor's required state. |
| aEnv | The environment in which the virtual cursor exists. |