Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: APGTASK.H
Link against: apgrfx.lib

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(), EndTask(), Exists(), KillTask(), SendKey(), SendKey(), SendMessage(), SendSystemEvent(), SendToBackground(), SetWgId(), SwitchCreateFile(), SwitchOpenFile(), TApaTask(), ThreadId(), WgId()

See also:


Construction and destruction


TApaTask()

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

RWsSession &aWsSession

The window server session.

See also:

[Top]


Member functions


SetWgId()

IMPORT_C void SetWgId(TInt aWgId);

Description

Sets this task's window group ID.

Parameters

TInt aWgId

The ID to be assigned.


WgId()

IMPORT_C TInt WgId() const;

Description

Gets the ID of this task's window group.

Return value

TInt

The window group ID. For an empty task object, this is zero.


Exists()

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

TBool

True, if the task is not empty; false, otherwise.

See also:


ThreadId()

IMPORT_C TThreadId ThreadId() const;

Description

Gets the ID of this task's thread

Return value

TThreadId

The thread ID.


BringToForeground()

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.


SendToBackground()

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.


EndTask()

Capability: PowerMgmt is required to close system tasks.

IMPORT_C void EndTask();

Description

Requests normal closing of this task.


KillTask()

Capability: PowerMgmt

IMPORT_C void KillTask();

Description

Kills this task.


SendKey()

Capability: SwEvent

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

TInt aKeyCode

The character code.

TInt aModifiers

State of the modifier keys.


SendKey()

Capability: SwEvent

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

const TKeyEvent &aKey

The key event.

See also:


SendSystemEvent()

Capability: SwEvent

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

TApaSystemEvent aEvent

The event type.

See also:


SwitchOpenFile()

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

const TDesC &aFilename

The name of the document to be opened.

Return value

TInt

KErrNone, if the request was successfully sent to the task; otherwise one of the other system-wide error codes.


SwitchCreateFile()

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

const TDesC &aFilename

The name of the new document.

Return value

TInt

KErrNone, if the request was successfully sent to the task; otherwise one of the other system-wide error codes.


SendMessage()

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

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.

Return value

TInt

KErrNone, if successful; otherwise, one of the other system-wide error codes.

See also: