CApaWindowGroupName Class Reference

class CApaWindowGroupName : public CBase

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.

Inherits from

Public Member Functions
~CApaWindowGroupName()
IMPORT_C TUidAppUid()
IMPORT_C TPtrCCaption()
IMPORT_C voidConstructFromWgIdL(TInt)
IMPORT_C TPtrCDocName()
IMPORT_C TBoolDocNameIsAFile()
IMPORT_C voidFindByAppUid(TUid, RWsSession &, TInt &)
IMPORT_C voidFindByCaption(const TDesC &, RWsSession &, TInt &)
IMPORT_C voidFindByDocName(const TDesC &, RWsSession &, TInt &)
IMPORT_C TBoolHidden()
IMPORT_C TBoolIsAppReady()
IMPORT_C TBoolIsBusy()
IMPORT_C TBoolIsSystem()
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 TBoolRespondsToShutdownEvent()
IMPORT_C TBoolRespondsToSwitchFilesEvent()
IMPORT_C voidSetAppReady(TBool)
IMPORT_C voidSetAppUid(TUid)
IMPORT_C voidSetBusy(TBool)
IMPORT_C voidSetCaptionL(const TDesC &)
IMPORT_C voidSetDocNameIsAFile(TBool)
IMPORT_C voidSetDocNameL(const TDesC &)
IMPORT_C voidSetHidden(TBool)
IMPORT_C voidSetRespondsToShutdownEvent(TBool)
IMPORT_C voidSetRespondsToSwitchFilesEvent(TBool)
IMPORT_C voidSetSystem(TBool)
IMPORT_C voidSetWindowGroupName(HBufC *)
IMPORT_C TIntSetWindowGroupName(RWindowGroup &)
IMPORT_C voidSetWindowGroupNameL(const TDesC &)
IMPORT_C TPtrCWindowGroupName()
Private Member Functions
CApaWindowGroupName(const RWsSession &)
voidDefaultConstructL()
TInt FindDelimiter(TApaDelimiter)
voidGetStatusFromName()
voidReAllocIfNecessaryL(TInt)
voidWriteStatusToName()
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()
Private Member Enumerations
enumTApaDelimiter { EEndStatus = 1, EEndUid, EEndCaption, ELast = EEndCaption }
enumTApaStatus {
ESystem = 0x01, EBusy = 0x02, EDocNameNotAFile = 0x04, EDoesNotRespondToShutdownEvent = 0x08, EDoesNotRespondToSwitchFilesEvent = 0x10, EIsHidden = 0x20, EAppReady = 0x40
}
Private Attributes
HBufC *iBuf
TUint iStatus
const RWsSession &iWsSession

Constructor & Destructor Documentation

CApaWindowGroupName(const RWsSession &)

CApaWindowGroupName(const RWsSession &aWsSession)[private]

Parameters

const RWsSession & aWsSession

~CApaWindowGroupName()

IMPORT_C~CApaWindowGroupName()

Member Functions Documentation

AppUid()

IMPORT_C TUidAppUid()const

Caption()

IMPORT_C TPtrCCaption()const

ConstructFromWgIdL(TInt)

IMPORT_C voidConstructFromWgIdL(TIntaWgId)

Parameters

TInt aWgId

DefaultConstructL()

voidDefaultConstructL()[private]

DocName()

IMPORT_C TPtrCDocName()const

DocNameIsAFile()

IMPORT_C TBoolDocNameIsAFile()const

FindByAppUid(TUid, RWsSession &, TInt &)

IMPORT_C voidFindByAppUid(TUidaAppUid,
RWsSession &aWsSession,
TInt &aPrevWgId
)[static]

Parameters

TUid aAppUid
RWsSession & aWsSession
TInt & aPrevWgId

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

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

Parameters

const TDesC & aCaption
RWsSession & aWsSession
TInt & aPrevWgId

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

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

Parameters

const TDesC & aDocName
RWsSession & aWsSession
TInt & aPrevWgId

FindDelimiter(TApaDelimiter)

TInt FindDelimiter(TApaDelimiteraDelim)const [private]

Parameters

TApaDelimiter aDelim

GetStatusFromName()

voidGetStatusFromName()[private]

Hidden()

IMPORT_C TBoolHidden()const

IsAppReady()

IMPORT_C TBoolIsAppReady()const

IsBusy()

IMPORT_C TBoolIsBusy()const

IsSystem()

IMPORT_C TBoolIsSystem()const

New(const RWsSession &, HBufC *)

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

Parameters

const RWsSession & aWsSession
HBufC * aWgName

NewL(const RWsSession &)

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

Parameters

const RWsSession & aWsSession

NewL(const RWsSession &, TInt)

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

Parameters

const RWsSession & aWsSession
TInt aWgId

NewL(const RWsSession &, const TDesC &)

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

Parameters

const RWsSession & aWsSession
const TDesC & aWgName

NewLC(const RWsSession &)

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

Parameters

const RWsSession & aWsSession

NewLC(const RWsSession &, TInt)

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

Parameters

const RWsSession & aWsSession
TInt aWgId

NewLC(const RWsSession &, const TDesC &)

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

Parameters

const RWsSession & aWsSession
const TDesC & aWgName

ReAllocIfNecessaryL(TInt)

voidReAllocIfNecessaryL(TIntaExtraLengthReqd)[private]

Parameters

TInt aExtraLengthReqd

RespondsToShutdownEvent()

IMPORT_C TBoolRespondsToShutdownEvent()const

RespondsToSwitchFilesEvent()

IMPORT_C TBoolRespondsToSwitchFilesEvent()const

SetAppReady(TBool)

IMPORT_C voidSetAppReady(TBoolaIsReady)

Parameters

TBool aIsReady

SetAppUid(TUid)

IMPORT_C voidSetAppUid(TUidaAppUid)

Parameters

TUid aAppUid

SetBusy(TBool)

IMPORT_C voidSetBusy(TBoolaBusy)

Parameters

TBool aBusy

SetCaptionL(const TDesC &)

IMPORT_C voidSetCaptionL(const TDesC &aCaption)

Parameters

const TDesC & aCaption

SetDocNameIsAFile(TBool)

IMPORT_C voidSetDocNameIsAFile(TBoolaDocNameIsAFile)

Parameters

TBool aDocNameIsAFile

SetDocNameL(const TDesC &)

IMPORT_C voidSetDocNameL(const TDesC &aDocName)

Parameters

const TDesC & aDocName

SetHidden(TBool)

IMPORT_C voidSetHidden(TBoolaIsHidden)

Parameters

TBool aIsHidden

SetRespondsToShutdownEvent(TBool)

IMPORT_C voidSetRespondsToShutdownEvent(TBoolaRespondsToShutdownEvent)

Parameters

TBool aRespondsToShutdownEvent

SetRespondsToSwitchFilesEvent(TBool)

IMPORT_C voidSetRespondsToSwitchFilesEvent(TBoolaRespondsToSwitchFilesEvent)

Parameters

TBool aRespondsToSwitchFilesEvent

SetSystem(TBool)

IMPORT_C voidSetSystem(TBoolaSystem)

Parameters

TBool aSystem

SetWindowGroupName(HBufC *)

IMPORT_C voidSetWindowGroupName(HBufC *aWgName)

Parameters

HBufC * aWgName

SetWindowGroupName(RWindowGroup &)

IMPORT_C TIntSetWindowGroupName(RWindowGroup &aGroupWin)const

Parameters

RWindowGroup & aGroupWin

SetWindowGroupNameL(const TDesC &)

IMPORT_C voidSetWindowGroupNameL(const TDesC &aWgName)

Parameters

const TDesC & aWgName

WindowGroupName()

IMPORT_C TPtrCWindowGroupName()const

WriteStatusToName()

voidWriteStatusToName()[private]

Member Enumerations Documentation

Enum TApaDelimiter

Enumerators

EEndStatus = 1
EEndUid
EEndCaption
ELast = EEndCaption

Enum TApaStatus

Enumerators

ESystem = 0x01
EBusy = 0x02
EDocNameNotAFile = 0x04
EDoesNotRespondToShutdownEvent = 0x08
EDoesNotRespondToSwitchFilesEvent = 0x10
EIsHidden = 0x20
EAppReady = 0x40

Member Data Documentation

HBufC * iBuf

HBufC *iBuf[private]

TUint iStatus

TUint iStatus[private]

const RWsSession & iWsSession

const RWsSession &iWsSession[private]
© Nokia 2010.