| class TApaTask |
Application task.
A task is a running application. At any one time, for any given application, there may be zero, one, or more tasks running on a device.
A task is identified by its association with the running application's window group.
An instance of the TApaTaskList class is used to find and access specific tasks.
| Public Member Functions | |
|---|---|
| TApaTask(RWsSession &) | |
| IMPORT_C void | BringToForeground() |
| IMPORT_C void | EndTask() |
| IMPORT_C TBool | Exists() |
| IMPORT_C void | KillTask() |
| IMPORT_C void | SendKey(TInt, TInt) |
| IMPORT_C void | SendKey(const TKeyEvent &) |
| IMPORT_C TInt | SendMessage(TUid, const TDesC8 &) |
| IMPORT_C void | SendSystemEvent(TApaSystemEvent) |
| IMPORT_C void | SendToBackground() |
| IMPORT_C void | SetWgId(TInt) |
| IMPORT_C TInt | SwitchCreateFile(const TDesC &) |
| IMPORT_C TInt | SwitchOpenFile(const TDesC &) |
| IMPORT_C TThreadId | ThreadId() |
| IMPORT_C TInt | WgId() |
| Private Member Functions | |
|---|---|
| TInt | CheckSwitchFile() |
| void | SendSystemEvent(TApaSystemEvent, TEventCode) |
| Private Attributes | |
|---|---|
| TInt | iTApaTask_Reserved1 |
| TInt | iWgId |
| RWsSession & | iWsSession |
| IMPORT_C | TApaTask | ( | RWsSession & | aWsSession | ) |
Constructs an empty task object, taking a reference to a window server session.
An object of this type is constructed by an instance of the TApaTaskList class.
The object represents a task when it is assigned a task's window group ID.
| RWsSession & aWsSession | The window server session. |
| IMPORT_C void | BringToForeground | ( | ) |
Brings this task to the foreground.
If the task uses the View architecture, then the task's top view is activated.
| IMPORT_C void | EndTask | ( | ) |
Requests normal closing of this task.
| IMPORT_C TBool | Exists | ( | ) | const |
Tests whether this TApaTask object is empty. This object represents the state of the task at the time at which it was constructed and is not subsequently updated. Therefore, this does not indicate that the task itself exists and should not be used to test whether or not a particular task is running or not.
TApaTaskList::FindDoc() TApaTaskList::FindApp() TApaTaskList::FindByPos()
| IMPORT_C void | SendKey | ( | TInt | aKeyCode, |
| TInt | aModifiers | |||
| ) | ||||
Sends a key event encapsulating the specified character code and specified modifier keys state to the task's window group.
Key events are handled by the UI framework, specifically by CCoeAppui::HandleWsEventL().
| IMPORT_C void | SendKey | ( | const TKeyEvent & | aKey | ) |
Sends the specified key event to the task's window group.
Key events are handled by the UI framework, specifically by CCoeAppui::HandleWsEventL().
| const TKeyEvent & aKey | The key event. |
| IMPORT_C TInt | SendMessage | ( | TUid | aUid, |
| const TDesC8 & | aParams | |||
| ) | ||||
Sends a message to this task's window group.
The message is handled by the UI framework, specifically by CEikAppUI::ProcessMessageL().
CEikAppUi::ProcessMessageL() TEventCode TWsEvent RWindowGroup::FetchMessage()
| TUid aUid | The UID identifying the message. By default, the UI framework recognizes only two messages, KUidApaMessageSwitchOpenFileValue and KUidApaMessageSwitchCreateFileValue. |
| const TDesC8 & aParams | The message. The format and meaning of the message depends on the specific type as identified by the UID. |
| IMPORT_C void | SendSystemEvent | ( | TApaSystemEvent | aEvent | ) |
Sends a system event to this task's window group.
Events are handled by the UI framework, specifically by CEikAppUi::HandleSystemEventL().
| TApaSystemEvent aEvent | The event type. |
| void | SendSystemEvent | ( | TApaSystemEvent | aEvent, |
| TEventCode | aType | |||
| ) | [private] | |||
| TApaSystemEvent aEvent | |
| TEventCode aType |
| IMPORT_C void | SendToBackground | ( | ) |
Sends this task to the background.
The task whose window group is at the next ordinal position is brought up to the foreground. In addition, the new foreground task's top view is activated, if it uses the View architecture.
| IMPORT_C void | SetWgId | ( | TInt | aWgId | ) |
Sets this task's window group ID.
| TInt aWgId | The ID to be assigned. |
| IMPORT_C TInt | SwitchCreateFile | ( | const TDesC & | aFilename | ) |
Requests the task to close its existing document, and to create and open a new document.
An application (task) may handle the request by overriding CEikAppUi::CreateFileL() if required.
| const TDesC & aFilename | The name of the new document. |
| IMPORT_C TInt | SwitchOpenFile | ( | const TDesC & | aFilename | ) |
Requests the task to close its existing document, and to open an existing document.
An application (task) may handle the request by overriding CEikAppUi::OpenFileL() if required.
| const TDesC & aFilename | The name of the document to be opened. |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.