![[Index]](../../../../a_stock/images/btn_index.gif)
![[Previous]](../../../../a_stock/images/btn_prev_top.gif)
![[Next]](../../../../a_stock/images/btn_next_top.gif)
|
|
|
|
|
|
||
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.
CBase -
Base class for all classes to be instantiated on the heap.
CApaWindowGroupName - Gives access to the name of a window group and the information encoded by that n...
Defined in CApaWindowGroupName:
AppUid()constGets the UID of the task's application.Caption()constGets the task's caption.ConstructFromWgIdL(TInt)Assigns to this object the name taken from the specified window group.DocName()constGets the name of the document that the task is handling.DocNameIsAFile()constTests whether the document name is a file.EMaxLengthFindByAppUid(TUid,RWsSession &,TInt &)Searches for the next window group by application UID.FindByCaption(const TDesC &,RWsSession &,TInt &)Searches for the next window group by caption.FindByDocName(const TDesC &,RWsSession &,TInt &)Searches for the next window group by document name.Hidden()constTests whether the task is marked as hidden.IsAppReady()constTests whether the task is marked as ready.IsBusy()constTests whether the task is marked as busy.IsSystem()constTests whether the task is marked as a system task.New(const RWsSession &,HBufC *)Creates a window group name object and takes ownership of the heap descriptor co...NewL(const RWsSession &)Creates a window group name object and assigns a default name to it.NewL(const RWsSession &,TInt)Creates a window group name object and assigns to it the name taken from the spe...NewL(const RWsSession &,const TDesC &)Creates a window group name object and assigns to it the specified name.NewLC(const RWsSession &)Creates a window group name object, assigns a default name to it, and puts a poi...NewLC(const RWsSession &,TInt)Creates a window group name object, assigns to it the name taken from the specif...NewLC(const RWsSession &,const TDesC &)Creates a window group name object, assigns to it the specified name, and puts a...RespondsToShutdownEvent()constTests whether the task can deal with a request to shutdown.RespondsToSwitchFilesEvent()constTests whether the task can deal with a request to switch files.SetAppReady(TBool)Sets the task as ready.SetAppUid(TUid)Sets the specified UID into the window group name in this object.SetBusy(TBool)Sets the task's busy status in this object.SetCaptionL(const TDesC &)Sets the specified caption into the window group name in this object.SetDocNameIsAFile(TBool)Sets the document name status in this object.SetDocNameL(const TDesC &)Sets the specified document name into the window group name in this object.SetHidden(TBool)Marks the task as hidden.SetRespondsToShutdownEvent(TBool)Sets the task's shutdown handling status in this object.SetRespondsToSwitchFilesEvent(TBool)Sets the task's switch file handling status in this object.SetSystem(TBool)Sets the task's system status in this object.SetWindowGroupName(HBufC *)Sets the full window group name in this object, taking ownership of the specifie...SetWindowGroupName(RWindowGroup &)constSets the window group name contained by this object into the specified window gr...SetWindowGroupNameL(const TDesC &)Sets the full window group name in this object.WindowGroupName()constGets the full window group name.anonymous~CApaWindowGroupName()Destructor.Inherited from CBase:
Delete(CBase *)Deletes the specified object.Extension_(TUint,TAny *&,TAny *)Extension function operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...operator new(TUint,TAny *)Initialises the object to binary zeroes.operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...IMPORT_C ~CApaWindowGroupName();
Destructor.
Frees resources owned by the object prior to its destruction.
IMPORT_C static CApaWindowGroupName* NewL(const RWsSession &aWsSession);
Creates a window group name object and assigns a default name to it.
|
|
IMPORT_C static CApaWindowGroupName* NewLC(const RWsSession &aWsSession);
Creates a window group name object, assigns a default name to it, and puts a pointer to the new object onto the cleanup stack.
|
|
IMPORT_C static CApaWindowGroupName* NewL(const RWsSession &aWsSession, TInt aWgId);
Creates a window group name object and assigns to it the name taken from the specified window group.
|
|
IMPORT_C static CApaWindowGroupName* NewLC(const RWsSession &aWsSession, TInt aWgId);
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.
|
|
IMPORT_C static CApaWindowGroupName* NewL(const RWsSession &aWsSession, const TDesC &aWgName);
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.
|
|
IMPORT_C static CApaWindowGroupName* NewLC(const RWsSession &aWsSession, const TDesC &aWgName);
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.
|
|
|
|
IMPORT_C static CApaWindowGroupName* New(const RWsSession &aWsSession, HBufC *aWgName);
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.
|
|
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.
|
IMPORT_C void SetWindowGroupNameL(const TDesC &aWgName);
Sets the full window group name in this object.
|
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.
|
IMPORT_C static void FindByAppUid(TUid aAppUid, RWsSession &aWsSession, TInt &aPrevWgId);
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.
|
IMPORT_C static void FindByCaption(const TDesC &aCaption, RWsSession &aWsSession, TInt &aPrevWgId);
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.
|
IMPORT_C static void FindByDocName(const TDesC &aDocName, RWsSession &aWsSession, TInt &aPrevWgId);
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.
|
IMPORT_C void SetBusy(TBool aBusy);
Sets the task's busy status in this object.
|
IMPORT_C TBool IsBusy() const;
Tests whether the task is marked as busy.
|
IMPORT_C void SetSystem(TBool aSystem);
Sets the task's system status in this object.
|
IMPORT_C TBool IsSystem() const;
Tests whether the task is marked as a system task.
|
IMPORT_C void SetDocNameIsAFile(TBool aDocNameIsAFile);
Sets the document name status in this object.
|
IMPORT_C TBool DocNameIsAFile() const;
Tests whether the document name is a file.
|
IMPORT_C void SetRespondsToShutdownEvent(TBool aRespondsToShutdownEvent);
Sets the task's shutdown handling status in this object.
|
IMPORT_C TBool RespondsToShutdownEvent() const;
Tests whether the task can deal with a request to shutdown.
|
IMPORT_C void SetRespondsToSwitchFilesEvent(TBool aRespondsToSwitchFilesEvent);
Sets the task's switch file handling status in this object.
|
IMPORT_C TBool RespondsToSwitchFilesEvent() const;
Tests whether the task can deal with a request to switch files.
|
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.
|
IMPORT_C TBool Hidden() const;
Tests whether the task is marked as hidden.
|
IMPORT_C void SetAppReady(TBool aIsReady);
Sets the task as ready.
|
IMPORT_C TBool IsAppReady() const;
Tests whether the task is marked as ready.
|
IMPORT_C void SetAppUid(TUid aAppUid);
Sets the specified UID into the window group name in this object.
|
IMPORT_C TUid AppUid() const;
Gets the UID of the task's application.
|
IMPORT_C void SetCaptionL(const TDesC &aCaption);
Sets the specified caption into the window group name in this object.
|
IMPORT_C TPtrC Caption() const;
Gets the task's caption.
|
IMPORT_C void SetDocNameL(const TDesC &aDocName);
Sets the specified document name into the window group name in this object.
|
IMPORT_C TPtrC DocName() const;
Gets the name of the document that the task is handling.
|
IMPORT_C TInt SetWindowGroupName(RWindowGroup &aGroupWin) const;
Sets the window group name contained by this object into the specified window group.
|
|
IMPORT_C TPtrC WindowGroupName() const;
Gets the full window group name.
|
|
|
|
Copyright © 2005-2008 Symbian Software Ltd. |
|
![[Top]](../../../../a_stock/images/arrow_up_2.gif){kind=icon}
![[Previous]](../../../../a_stock/images/btn_prev.gif)
![[Top]](../../../../a_stock/images/btn_top.gif)
![[Next]](../../../../a_stock/images/btn_next.gif)