Location:
APGTASK.H
Link against: apgrfx.lib
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.
Defined in TApaTask
:
BringToForeground()
, EndTask()
, Exists()
, KillTask()
, SendKey()
, SendKey()
, SendMessage()
, SendSystemEvent()
, SendToBackground()
, SetWgId()
, SwitchCreateFile()
, SwitchOpenFile()
, TApaTask()
, ThreadId()
, WgId()
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.
|
IMPORT_C void SetWgId(TInt aWgId);
Sets this task's window group ID.
|
IMPORT_C TInt WgId() const;
Gets the ID of this task's window group.
|
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.
|
IMPORT_C TThreadId ThreadId() const;
Gets the ID of this task's thread
|
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 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.
Capability: | PowerMgmt | is required to close system tasks. |
IMPORT_C void EndTask();
Requests normal closing of this task.
Capability: | SwEvent |
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().
|
Capability: | SwEvent |
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().
|
Capability: | SwEvent |
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().
|
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.
|
|
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.
|
|
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().
|
|