Class TApaTask

class TApaTask;

Description

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.

Members

Defined in TApaTask:

• BringToForeground()Brings this task to the foreground.
• EndTask()Requests normal closing of this task.
• Exists()constTests whether this TApaTask object is empty. This object represents the state of...
• KillTask()Kills this task.
• SendKey(TInt,TInt)Sends a key event encapsulating the specified character code and specified modif...
• SendKey(const TKeyEvent &)Sends the specified key event to the task's window group.
• SendMessage(TUid,const TDesC8 &)Sends a message to this task's window group.
• SendSystemEvent(TApaSystemEvent)Sends a system event to this task's window group.
• SendToBackground()Sends this task to the background.
• SetWgId(TInt)Sets this task's window group ID.
• SwitchCreateFile(const TDesC &)Requests the task to close its existing document, and to create and open a new d...
• SwitchOpenFile(const TDesC &)Requests the task to close its existing document, and to open an existing docume...
• TApaTask(RWsSession &)Constructs an empty task object, taking a reference to a window server session.
• ThreadId()constGets the ID of this task's thread
• WgId()constGets the ID of this task's window group.

See also:

• TApaTaskListAccesses tasks running on a device.
• RWindowGroupClient-side handle to a server-side window group.
• RWsSessionWindow server session.

IMPORT_C TApaTask(RWsSession &aWsSession);

Description

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.

Parameters

See also:

• TApaTaskListAccesses tasks running on a device.

IMPORT_C void SetWgId(TInt aWgId);

Description

Sets this task's window group ID.

Parameters

IMPORT_C TInt WgId() const;

Description

Gets the ID of this task's window group.

Return value

IMPORT_C TBool Exists() const;

Description

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.

Return value

See also:

• TApaTaskList::FindDoc(const TDesC &)Searches for the task that is handling the specified document.
• TApaTaskList::FindApp(const TDesC &)Searches for a task that has the specified caption.
• TApaTaskList::FindByPos(TInt)Searches for a task by the ordinal position of its window group.

IMPORT_C TThreadId ThreadId() const;

Description

Gets the ID of this task's thread

Return value

IMPORT_C void BringToForeground();

Description

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

Description

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 EndTask();

Description

Requests normal closing of this task.

IMPORT_C void KillTask();

Description

Kills this task.

IMPORT_C void SendKey(TInt aKeyCode, TInt aModifiers);

Description

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

Parameters

IMPORT_C void SendKey(const TKeyEvent &aKey);

Description

Sends the specified key event to the task's window group.

Key events are handled by the UI framework, specifically by CCoeAppui::HandleWsEventL().

Parameters

See also:

• TKeyEventKey event details.

IMPORT_C void SendSystemEvent(TApaSystemEvent aEvent);

Description

Sends a system event to this task's window group.

Events are handled by the UI framework, specifically by CEikAppUi::HandleSystemEventL().

Parameters

See also:

• TApaSystemEventDefines the event types that a TApaTask object can send to its window group.

IMPORT_C TInt SwitchOpenFile(const TDesC &aFilename);

Description

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.

Parameters

Return value

IMPORT_C TInt SwitchCreateFile(const TDesC &aFilename);

Description

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.

Parameters

Return value

IMPORT_C TInt SendMessage(TUid aUid, const TDesC8 &aParams);

Description

Sends a message to this task's window group.

The message is handled by the UI framework, specifically by CEikAppUI::ProcessMessageL().

Parameters

Return value

See also:

• TEventCodeTypes of standard events.
• TWsEventWindow server event.