Collapse all Symbian^3 Product Developer Library

CTsFswClient Class Reference

class CTsFswClient : public CBase

Client API for the Huriganes Fast Swap Server.

Inherits from

CTsFswClient
- CBase

Public Member Functions
	~CTsFswClient()
IMPORT_C void	CancelSubscribe()
IMPORT_C void	CloseApp(TInt)
IMPORT_C TUid	ForegroundAppUid(TTsFswFgAppType)
IMPORT_C void	GetContentL(RTsFswArray &)
IMPORT_C CTsFswClient *	NewL()
IMPORT_C CTsFswClient *	NewLC()
IMPORT_C void	Subscribe(MTsFswObserver &)
IMPORT_C void	SwitchToApp(TInt)

Private Member Functions
	CTsFswClient()
void	ConstructL()

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

Public Member Enumerations
enum	TTsFswFgAppType { EUseStandaloneUid, EUseEmbeddedUid }

Private Attributes
CTsFswClientImpl *	iImpl

Constructor & Destructor Documentation

CTsFswClient()

CTsFswClient

(

)

[private]

~CTsFswClient()

~CTsFswClient

(

)

Destructor.

Member Functions Documentation

CancelSubscribe()

IMPORT_C void

CancelSubscribe

(

)

Cancels the subscription for change notifications.

capability: LocalServices

CloseApp(TInt)

IMPORT_C void

CloseApp

(

TInt

aWgId

)

Tries to close the application with the given id.

capability: LocalServices

Parameters

TInt aWgId

ConstructL()

void

ConstructL

(

)

[private]

ForegroundAppUid(TTsFswFgAppType)

IMPORT_C TUid

ForegroundAppUid

(

TTsFswFgAppType

aType

)

Returns the uid of the foreground app or KNullUid if something goes wrong.

Will never return hidden apps, only those which can also be seen in the array returned by GetContentL.

However the handling of embedded applications might be different: (as opposed to GetContentL) If aType == EUseEmbeddedUid: This function will always return the embedded application's uid, unlike GetContentL which will always refer to the container app (except for the screenshot of course). This means that the returned uid is simply the uid belonging to the first (non-hidden, etc.) window group from the window group list. If aType == EUseStandaloneUid: Embedded applications are ignored and the returned uid is the app uid belonging to the first parentless window group.

Parameters

TTsFswFgAppType aType

GetContentL(RTsFswArray &)

IMPORT_C void

GetContentL

(

RTsFswArray &

aDst

)

Queries the fast swap content from the server and copies it into the given array. Previous content of the array is removed (by using ResetAndDestroy).

capability: LocalServices

Parameters

RTsFswArray & aDst

array to which data is stored

NewL()

IMPORT_C CTsFswClient *

NewL

(

)

[static]

Creates a new instance.

capability: LocalServices

NewLC()

IMPORT_C CTsFswClient *

NewLC

(

)

[static]

Creates a new instance.

capability: LocalServices

Subscribe(MTsFswObserver &)

IMPORT_C void

(

MTsFswObserver &

aObserver

)

Subscribes for continuous notifications about changes in the fast swap content. The notifications are generated until CancelSubscribe is called or the instance is destroyed.

capability: LocalServices

Parameters

MTsFswObserver & aObserver

SwitchToApp(TInt)

IMPORT_C void

SwitchToApp

(

TInt

aWgId

)

Brings the application with the given id into foreground.

capability: LocalServices

Parameters

TInt aWgId

Member Enumerations Documentation

Enum TTsFswFgAppType

Possible values for aType argument of ForegroundAppUid().

Enumerators

EUseStandaloneUid	Means that even when the foreground app has another app embedded into it the uid of the container application will be returned.
EUseEmbeddedUid	Means that if the foreground app has another app embedded into it then the returned uid will be the uid of the embedded app.

Member Data Documentation

CTsFswClientImpl * iImpl

CTsFswClientImpl *

iImpl

[private]