CTsFastSwapPreviewProvider Class Reference

class CTsFastSwapPreviewProvider : public CBase

Preview provider API class. Applications (window groups) must be registered before screenshots can be received. Also, closed apps should be unregistered to save resources. TakePreview() can be called to take a screenshot right away. A client needing notifications has to create an instance so that screenshots can be delivered to it via MTsFastSwapPreviewObserver.

MTsFastSwapPreviewObserver tspreviewprovider.lib

Inherits from

  • CTsFastSwapPreviewProvider

Constructor & Destructor Documentation

CTsFastSwapPreviewProvider()

CTsFastSwapPreviewProvider()[private]

C++ constructor.

~CTsFastSwapPreviewProvider()

IMPORT_C~CTsFastSwapPreviewProvider()

Destructor.

Member Functions Documentation

AckPreview(TInt)

IMPORT_C voidAckPreview(TIntaPreviewId)

Ack preview ready message

Parameters

TInt aPreviewId

ChangeScreen(TInt)

IMPORT_C TIntChangeScreen(TIntaScreenId)

Change screen.

Parameters

TInt aScreenIdScreen id.

ConstructL(MTsFastSwapPreviewObserver &)

voidConstructL(MTsFastSwapPreviewObserver &aObs)[private]

2nd phase constructor.

Parameters

MTsFastSwapPreviewObserver & aObsObserver.

NewL(MTsFastSwapPreviewObserver &)

IMPORT_C CTsFastSwapPreviewProvider *NewL(MTsFastSwapPreviewObserver &aObs)[static]

Two phased constructor. MTsFastSwapPreviewObserver

Parameters

MTsFastSwapPreviewObserver & aObsObserver.

Register(TInt)

IMPORT_C TIntRegister(TIntaWgId)

Registers window group for screenshots.

Parameters

TInt aWgIdWindow group id.

SetPreviewParam(const TSize &, TDisplayMode)

IMPORT_C TIntSetPreviewParam(const TSize &aSize,
TDisplayModeaMode
)

Defines the dimensions and format of the screenshots. TDisplayMode.

Parameters

const TSize & aSizeSize to be used for the preview screenshots.
TDisplayMode aModeColor depth to be used for the preview screenshots.

TakePreview()

IMPORT_C TIntTakePreview()

Takes a screenshot.

Unregister(TInt)

IMPORT_C TIntUnregister(TIntaWgId)

Unregisters window group.

Parameters

TInt aWgIdWindow group id.

Member Data Documentation

CTsFastSwapPreviewProviderClient * iClient

CTsFastSwapPreviewProviderClient *iClient[private]

Implementation class.