CApaWindowGroupName Class Reference

#include <mw/apgwgnam.h>

Link against: apgrfx.lib

class CApaWindowGroupName : public CBase, public CBase

Inherits from

CApaWindowGroupName
- CBase
- CBase

Public Member Enumerations
enum	anonymous { EMaxLength }

Public Member Functions
	~CApaWindowGroupName()
IMPORT_C TUid	AppUid()
IMPORT_C TPtrC	Caption()
IMPORT_C void	ConstructFromWgIdL(TInt)
IMPORT_C TPtrC	DocName()
IMPORT_C TBool	DocNameIsAFile()
IMPORT_C void	FindByAppUid(TUid, RWsSession &, TInt &)
IMPORT_C void	FindByCaption(const TDesC &, RWsSession &, TInt &)
IMPORT_C void	FindByDocName(const TDesC &, RWsSession &, TInt &)
void	FindNonEmbeddedAppByUid(TUid, RWsSession &, TInt &, RArray< RWsSession::TWindowGroupChainInfo > &)
IMPORT_C TBool	Hidden()
IMPORT_C TBool	IsAppReady()
IMPORT_C TBool	IsBusy()
IMPORT_C TBool	IsSystem()
IMPORT_C CApaWindowGroupName *	New(const RWsSession &, HBufC *)
IMPORT_C CApaWindowGroupName *	NewL(const RWsSession &)
IMPORT_C CApaWindowGroupName *	NewL(const RWsSession &, TInt)
IMPORT_C CApaWindowGroupName *	NewL(const RWsSession &, const TDesC &)
IMPORT_C CApaWindowGroupName *	NewLC(const RWsSession &)
IMPORT_C CApaWindowGroupName *	NewLC(const RWsSession &, TInt)
IMPORT_C CApaWindowGroupName *	NewLC(const RWsSession &, const TDesC &)
IMPORT_C TBool	RespondsToShutdownEvent()
IMPORT_C TBool	RespondsToSwitchFilesEvent()
IMPORT_C void	SetAppReady(TBool)
IMPORT_C void	SetAppUid(TUid)
IMPORT_C void	SetBusy(TBool)
IMPORT_C void	SetCaptionL(const TDesC &)
IMPORT_C void	SetDocNameIsAFile(TBool)
IMPORT_C void	SetDocNameL(const TDesC &)
IMPORT_C void	SetHidden(TBool)
IMPORT_C void	SetRespondsToShutdownEvent(TBool)
IMPORT_C void	SetRespondsToSwitchFilesEvent(TBool)
IMPORT_C void	SetSystem(TBool)
IMPORT_C void	SetWindowGroupName(HBufC *)
IMPORT_C TInt	SetWindowGroupName(RWindowGroup &)
IMPORT_C void	SetWindowGroupNameL(const TDesC &)
IMPORT_C TPtrC	WindowGroupName()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

Gives access to the name of a window group and the information encoded by that name.

A window group is associated with a task, i.e. a running application. The window group's name encodes four pieces of information for that task:

the name of the document that the task is handling,

the task's caption,

the application specific UID, as eight hexadecimal characters,

status information for the task, as two hexadecimal characters.

Member Enumeration Documentation

Enum anonymous

Enumerator	Value	Description
EMaxLength	13+2*KMaxFileName

Constructor & Destructor Documentation

~CApaWindowGroupName ( )

IMPORT_C

~CApaWindowGroupName

(

)

Destructor.

Frees resources owned by the object prior to its destruction.

Member Function Documentation

AppUid ( )

IMPORT_C TUid

AppUid

(

)

const

Gets the UID of the task's application.

Return Value: The application specific UID. If the format of the window group name is not recognized, then this is zero.

Caption ( )

IMPORT_C TPtrC

Caption

(

)

const

Gets the task's caption.

Return Value: A non-modifiable pointer descriptor representing the caption. If the format of the window group name is not recognized, then this is a zero length descriptor.

ConstructFromWgIdL ( TInt )

IMPORT_C void

ConstructFromWgIdL

(

TInt

aWgId

)

Assigns to this object the name taken from the specified window group.

Any previously existing name contained by this window group name object is lost.

If the specified window group does not exist or it has no name, then a default name is assigned.

Parameters
aWgId	The ID of a window group.

DocName ( )

IMPORT_C TPtrC

DocName

(

)

const

Gets the name of the document that the task is handling.

Return Value: A non-modifiable pointer descriptor representing the document name. If the format of the window group name is not recognized, then this is a zero length descriptor.

DocNameIsAFile ( )

IMPORT_C TBool

DocNameIsAFile

(

)

const

Tests whether the document name is a file.

FindByAppUid ( TUid, RWsSession &, TInt & )

IMPORT_C void	FindByAppUid	(	TUid	aAppUid,
			RWsSession &	aWsSession,
			TInt &	aPrevWgId
		)	[static]

Searches for the next window group by application UID.

A running application, also known as a task, is associated with a window group. The function searches for the next task running the specified application, and returns its associated window group ID.

Parameters
aAppUid	The application specific UID.
aWsSession	A window server session.
aPrevWgId	On entry, the previous window group ID. On return, the next window group ID. On first call to this function pass a zero value. When there are no more matching window groups, contains KErrNotFound.

FindByCaption ( const TDesC &, RWsSession &, TInt & )

IMPORT_C void	FindByCaption	(	const TDesC &	aCaption,
			RWsSession &	aWsSession,
			TInt &	aPrevWgId
		)	[static]

Searches for the next window group by caption.

A running application, also known as a task, is associated with a window group. The function searches for the next task having the specified caption, and returns its associated window group ID.

Parameters
aCaption	The caption.
aWsSession	A window server session.
aPrevWgId	On entry, the previous window group ID. On return, the next window group ID. On first call to this function pass a zero value. When there are no more matching window groups, contains KErrNotFound.

FindByDocName ( const TDesC &, RWsSession &, TInt & )

IMPORT_C void	FindByDocName	(	const TDesC &	aDocName,
			RWsSession &	aWsSession,
			TInt &	aPrevWgId
		)	[static]

Searches for the next window group by document name.

A running application, also known as a task, is associated with a window group. The function searches for the next task handling the specified document, and returns its associated window group ID.

Parameters
aDocName	The name of the document.
aWsSession	A window server session.
aPrevWgId	On entry, the previous window group ID. On return, the next window group ID. On first call to this function pass a zero value. When there are no more matching window groups, contains KErrNotFound.

FindNonEmbeddedAppByUid ( TUid, RWsSession &, TInt &, RArray< RWsSession::TWindowGroupChainInfo > & )

void	FindNonEmbeddedAppByUid	(	TUid	aAppUid,
			RWsSession &	aWsSession,
			TInt &	aPrevWgId,
			RArray< RWsSession::TWindowGroupChainInfo > &	aWindowArray
		)	[static]

Searches for the next window group by application UID which is non-embedded application.

A running non-embedded application, also known as a task, is associated with a window group. The function searches for the next task running the specified application, and returns its associated window group ID.

Parameters
aAppUid	The application specific UID.
aWsSession	A window server session.
aPrevWgId	On entry, the previous window group ID. On return, the next window group ID. On first call to this function pass a zero value. When there are no more matching window groups, contains KErrNotFound.

Hidden ( )

IMPORT_C TBool

Hidden

(

)

const

Tests whether the task is marked as hidden.

Return Value: True if the task is hidden; false otherwise.

IsAppReady ( )

IMPORT_C TBool

IsAppReady

(

)

const

Tests whether the task is marked as ready.

Return Value: True if the task is ready; false otherwise.

IsBusy ( )

IMPORT_C TBool

IsBusy

(

)

const

Tests whether the task is marked as busy.

IsSystem ( )

IMPORT_C TBool

IsSystem

(

)

const

Tests whether the task is marked as a system task.

New ( const RWsSession &, HBufC * )

IMPORT_C CApaWindowGroupName *	New	(	const RWsSession &	aWsSession,
			HBufC *	aWgName
		)	[static]

Creates a window group name object and takes ownership of the heap descriptor containing a name.

The name must have valid format. Typically, this is an existing window group name.

Note that the function cannot leave.

Parameters
aWsSession	A window server session.
aWgName	A heap descriptor containing a valid window group name. This pointer must not be null, otherwise the function raises an APGRFX 3 panic.

Return Value: A pointer to the new window group name object.

NewL ( const RWsSession & )

IMPORT_C CApaWindowGroupName *

NewL

(

const RWsSession &

aWsSession

)

[static]

Creates a window group name object and assigns a default name to it.

Parameters
aWsSession	A window server session.

Return Value: A pointer to the new window group name object.

NewL ( const RWsSession &, TInt )

IMPORT_C CApaWindowGroupName *	NewL	(	const RWsSession &	aWsSession,
			TInt	aWgId
		)	[static]

Creates a window group name object and assigns to it the name taken from the specified window group.

Parameters
aWsSession	A window server session.
aWgId	The ID of a window group.

Return Value: A pointer to the new window group name object.

NewL ( const RWsSession &, const TDesC & )

IMPORT_C CApaWindowGroupName *	NewL	(	const RWsSession &	aWsSession,
			const TDesC &	aWgName
		)	[static]

Creates a window group name object and assigns to it the specified name.

The name must have a valid format. Typically, this is an existing window group name.

Parameters
aWsSession	A window server session.
aWgName	A valid window group name.

Return Value: A pointer to the new window group name object.

NewLC ( const RWsSession & )

IMPORT_C CApaWindowGroupName *

NewLC

(

const RWsSession &

aWsSession

)

[static]

Creates a window group name object, assigns a default name to it, and puts a pointer to the new object onto the cleanup stack.

Parameters
aWsSession	A window server session.

Return Value: A pointer to the new window group name object.

NewLC ( const RWsSession &, TInt )

IMPORT_C CApaWindowGroupName *	NewLC	(	const RWsSession &	aWsSession,
			TInt	aWgId
		)	[static]

Creates a window group name object, assigns to it the name taken from the specified window group, and puts a pointer to the new object onto the cleanup stack.

Parameters
aWsSession	A window server session.
aWgId	The ID of a window group.

Return Value: A pointer to the new window group name object.

NewLC ( const RWsSession &, const TDesC & )

IMPORT_C CApaWindowGroupName *	NewLC	(	const RWsSession &	aWsSession,
			const TDesC &	aWgName
		)	[static]

Creates a window group name object, assigns to it the specified name, and puts a pointer to the new object onto the cleanup stack.

The name must have valid format. Typically, this is an existing window group name.

Parameters
aWsSession	A window server session.
aWgName	A valid window group name.

Return Value: A pointer to the new window group name object.

RespondsToShutdownEvent ( )

IMPORT_C TBool

RespondsToShutdownEvent

(

)

const

Tests whether the task can deal with a request to shutdown.

See also: CEikonEnv::RespondsToShutdownEvent()

Return Value: True, if the task can deal with a request to shutdown; false, otherwise.

RespondsToSwitchFilesEvent ( )

IMPORT_C TBool

RespondsToSwitchFilesEvent

(

)

const

Tests whether the task can deal with a request to switch files.

See also: CEikonEnv::RespondsToSwitchFilesEvent()

Return Value: True, if the task can deal with a request to switch files; false otherwise.

SetAppReady ( TBool )

IMPORT_C void

SetAppReady

(

TBool

aIsReady

)

Sets the task as ready.

Parameters
aIsReady	ETrue if the task is to be marked as ready; EFalse if not.

SetAppUid ( TUid )

IMPORT_C void

SetAppUid

(

TUid

aAppUid

)

Sets the specified UID into the window group name in this object.

Parameters
aAppUid	The application specific UID.

SetBusy ( TBool )

IMPORT_C void

SetBusy

(

TBool

aBusy

)

Sets the task's busy status in this object.

Parameters
aBusy	ETrue, marks the task as busy; EFalse, marks the task as not busy.

SetCaptionL ( const TDesC & )

IMPORT_C void

SetCaptionL

(

const TDesC &

aCaption

)

Sets the specified caption into the window group name in this object.

Parameters
aCaption	The caption.

SetDocNameIsAFile ( TBool )

IMPORT_C void

SetDocNameIsAFile

(

TBool

aDocNameIsAFile

)

Sets the document name status in this object.

See also: CEikonEnv::SetDocNameIsAFile()

Parameters
aDocNameIsAFile	ETrue, the document name is a filename; EFalse, the document name is not a filename.

SetDocNameL ( const TDesC & )

IMPORT_C void

SetDocNameL

(

const TDesC &

aDocName

)

Sets the specified document name into the window group name in this object.

Parameters
aDocName	The document name.

SetHidden ( TBool )

IMPORT_C void

SetHidden

(

TBool

aIsHidden

)

Marks the task as hidden.

In general, tasks marked as hidden do not appear in tasklists. Specifically, TApaTask::FindByPos() will ignore any tasks marked as hidden.

Parameters
aIsHidden	ETrue if the task is to be marked as hidden; EFalse if not.

SetRespondsToShutdownEvent ( TBool )

IMPORT_C void

SetRespondsToShutdownEvent

(

TBool

aRespondsToShutdownEvent

)

Sets the task's shutdown handling status in this object.

See also: CEikonEnv::SetRespondsToShutdownEvent()

Parameters
aRespondsToShutdownEvent	ETrue, if the task can deal with a shutdown request; EFalse, if the task cannot deal with a shutdown request.

SetRespondsToSwitchFilesEvent ( TBool )

IMPORT_C void

SetRespondsToSwitchFilesEvent

(

TBool

aRespondsToSwitchFilesEvent

)

Sets the task's switch file handling status in this object.

See also: CEikonEnv::SetRespondsToSwitchFilesEvent()

Parameters
aRespondsToSwitchFilesEvent	ETrue, if the task can deal with a request to switch file; EFalse, if the task cannot deal with with a request to switch files.

SetSystem ( TBool )

IMPORT_C void

SetSystem

(

TBool

aSystem

)

Sets the task's system status in this object.

SetWindowGroupName ( HBufC * )

IMPORT_C void

SetWindowGroupName

(

HBufC *

aWgName

)

Sets the full window group name in this object, taking ownership of the specified heap descriptor.

The function cannot leave.

Parameters
aWgName	A heap descriptor containing the full window group name. The pointer must not be null, otherwise the function raises a APGRFX 3 panic.

SetWindowGroupName ( RWindowGroup & )

IMPORT_C TInt

SetWindowGroupName

(

RWindowGroup &

aGroupWin

)

const

Sets the window group name contained by this object into the specified window group.

Parameters
aGroupWin	The window group.

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

SetWindowGroupNameL ( const TDesC & )

IMPORT_C void

SetWindowGroupNameL

(

const TDesC &

aWgName

)

Sets the full window group name in this object.

Parameters
aWgName	The full window group name.

WindowGroupName ( )

IMPORT_C TPtrC

WindowGroupName

(

)

const

Gets the full window group name.

Return Value: A non-modifiable pointer descriptor representing the full window group name.