Class TApaTaskList

class TApaTaskList;

Description

Accesses tasks running on a device.

Tasks can be identified by document, application specific UID or by caption name.

Users of this class can also cycle through a set of tasks running a specific application, bringing each one, in turn, into the foreground.

Members

Defined in TApaTaskList:
CycleTasks(), EBackwards, EForwards, FindApp(), FindApp(), FindByPos(), FindDoc(), TApaTaskList(), TCycleDirection

See also:

• TApaTask

IMPORT_C TApaTaskList(RWsSession &aWsSession);

Description

Constructs the task list object, taking a reference to a window server session.

Parameters

RWsSession &aWsSession The window server session.

IMPORT_C TApaTask FindApp(const TDesC &aAppName);

Description

Searches for a task that has the specified caption.

The result of the search depends on the number of tasks that have the specified caption.

If there is only one task, then that task is returned.

If there is more than one task, then the task returned depends on whether the first one found is in the foreground:

if the first task found is in the foreground, then the task returned by this function is the one with the highest window group ordinal value, i.e. the task which is furthest from the foreground.

if the first task found is not in the foreground, then that is the task that is returned.

If no matching task is found, then the object returned is an empty task, and calling TApaTask::Exists() on it returns false.

Parameters

const TDesC &aAppName The caption.

Return value

TApaTask A task having the specified caption, or an empty task.

IMPORT_C TApaTask FindDoc(const TDesC &aDocName);

Description

Searches for the task that is handling the specified document.

Parameters

const TDesC &aDocName The name of the document.

Return value

TApaTask The task that is handling the specified document. If no such task exists, then this is an empty task, i.e. a subsequent call to TApaTask::Exists() returns false.

IMPORT_C TApaTask FindByPos(TInt aPos);

Description

Searches for a task by the ordinal position of its window group.

Parameters

TInt aPos The ordinal position of a task's window group. A zero value refers to the foreground task.

Return value

TApaTask The task at the specified position. If there is no task at the specified position, or the specified position is invalid, then the object returned is an empty task, and calling TApaTask::Exists() on it returns false.

IMPORT_C TApaTask FindApp(TUid aAppUid);

Description

Searches for a task running the specified application.

The result of the search depends on the number of tasks that are running the specified application.

If there is only one task, then that task is returned.

If there is more than one task, then the task returned depends on whether the first one found is in the foreground:

if the first task found is in the foreground, then the task returned by this function is the one with the highest window group ordinal value, i.e. the task which is furthest from the foreground.

if the first task found is not in the foreground, then that is the task that is returned.

If no matching task is found, then the object returned is an empty task, and calling TApaTask::Exists() on it returns false.

Parameters

TUid aAppUid The application specific UID.

Return value

TApaTask A task having the specified caption, or an empty task.

IMPORT_C TInt CycleTasks(TUid aAppUid, TCycleDirection aDirection=EForwards);

Description

Brings the next task in the set of tasks running the specified application to the foreground.

If there is only one task, then no change occurs.

If the foremost task in the set is not the foreground task, then this is made the foreground task.

Thereafter, successive calls to this function bring the next task in the set to the foreground. The direction of the cycling can be specified and has the following effect:

for the forwards direction, the foreground task is sent to the background; the next foremost task is made the foreground task.

for the backwards direction, the task with the highest window group ordinal value, i.e. the task in the set which is furthest from the foreground, is brought to the foreground. The task that was the foremost task in the set is moved back by one position.

If the task brought to the foreground uses the View architecture, then the its top view is activated.

Parameters

TUid aAppUid The application specific UID. TCycleDirection aDirection The direction of cycling.

Return value

TInt KErrNone, if successful; KErrNotFound, if there are no tasks running the specified application.

TCycleDirection

Description

Defines the direction in which tasks are cycled to the foreground. This is used by the CycleTasks() function.

See also:

• TApaTaskList::CycleTasks()

EForwards Cycles the task list forwards, i.e. the foreground task is moved to background, bringing the next foremost task to the foreground. EBackwards Cycles the list backwards, i.e. the task furthest from the foreground is brought to the foreground, pushing what was the foremost task to the next ordinal position.