TApaTask Class Reference

#include <mw/apgtask.h>

Link against: apgrfx.lib

class TApaTask

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

Detailed 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.

Constructor & Destructor Documentation

TApaTask ( RWsSession & )

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.

Parameters
aWsSession	The window server session.

Member Function Documentation

BringToForeground ( )

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.

EndTask ( )

IMPORT_C void

EndTask

(

)

Requests normal closing of this task.

Capability
PowerMgmt	is required to close system tasks.

Exists ( )

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.

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

KillTask ( )

IMPORT_C void

KillTask

(

)

Kills this task.

Capability
PowerMgmt

SendKey ( TInt, TInt )

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

Parameters
aKeyCode	The character code.
aModifiers	State of the modifier keys.

SendKey ( const TKeyEvent & )

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

See also: CCoeAppUi::HandleWsEventL() TKeyEvent

Parameters
aKey	The key event.

Capability
SwEvent

SendMessage ( TUid, const TDesC8 & )

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

See also: CEikAppUi::ProcessMessageL() TEventCode TWsEvent RWindowGroup::FetchMessage()

Parameters
aUid	The UID identifying the message. By default, the UI framework recognizes only two messages, KUidApaMessageSwitchOpenFileValue and KUidApaMessageSwitchCreateFileValue.
aParams	The message. The format and meaning of the message depends on the specific type as identified by the UID.

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

SendSystemEvent ( TApaSystemEvent )

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

See also: CEikAppUi CCoeAppUi::HandleSystemEventL() TApaSystemEvent

Parameters
aEvent	The event type.

Capability
SwEvent

SendToBackground ( )

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.

SetWgId ( TInt )

IMPORT_C void

SetWgId

(

TInt

aWgId

)

Sets this task's window group ID.

Parameters
aWgId	The ID to be assigned.

SwitchCreateFile ( const TDesC & )

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.

Parameters
aFilename	The name of the new document.

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

SwitchOpenFile ( const TDesC & )

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.

Parameters
aFilename	The name of the document to be opened.

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

ThreadId ( )

IMPORT_C TThreadId

ThreadId

(

)

const

Gets the ID of this task's thread

Return Value: The thread ID.

WgId ( )

IMPORT_C TInt

WgId

(

)

const

Gets the ID of this task's window group.

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