Symbian^3 Application Developer Library >

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

Public Member Functions
~CTsFastSwapPreviewProvider ()
IMPORT_C void AckPreview ( TInt )
IMPORT_C TInt ChangeScreen ( TInt )
IMPORT_C CTsFastSwapPreviewProvider * NewL ( MTsFastSwapPreviewObserver &)
IMPORT_C TInt Register ( TInt )
IMPORT_C TInt SetPreviewParam (const TSize &, TDisplayMode )
IMPORT_C TInt TakePreview ()
IMPORT_C TInt Unregister ( TInt )
Private Member Functions
CTsFastSwapPreviewProvider ()
void ConstructL ( MTsFastSwapPreviewObserver &)
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 Attributes
CTsFastSwapPreviewProviderClient * iClient

Constructor & Destructor Documentation

CTsFastSwapPreviewProvider()

CTsFastSwapPreviewProvider ( ) [private]

C++ constructor.

~CTsFastSwapPreviewProvider()

IMPORT_C ~CTsFastSwapPreviewProvider ( )

Destructor.

Member Functions Documentation

AckPreview(TInt)

IMPORT_C void AckPreview ( TInt aPreviewId )

Ack preview ready message

Parameters

TInt aPreviewId

ChangeScreen(TInt)

IMPORT_C TInt ChangeScreen ( TInt aScreenId )

Change screen.

Parameters

TInt aScreenId Screen id.

ConstructL(MTsFastSwapPreviewObserver &)

void ConstructL ( MTsFastSwapPreviewObserver & aObs ) [private]

2nd phase constructor.

Parameters

MTsFastSwapPreviewObserver & aObs Observer.

NewL(MTsFastSwapPreviewObserver &)

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

Two phased constructor. MTsFastSwapPreviewObserver

Parameters

MTsFastSwapPreviewObserver & aObs Observer.

Register(TInt)

IMPORT_C TInt Register ( TInt aWgId )

Registers window group for screenshots.

Parameters

TInt aWgId Window group id.

SetPreviewParam(const TSize &, TDisplayMode)

IMPORT_C TInt SetPreviewParam ( const TSize & aSize,
TDisplayMode aMode
)

Defines the dimensions and format of the screenshots. TDisplayMode .

Parameters

const TSize & aSize Size to be used for the preview screenshots.
TDisplayMode aMode Color depth to be used for the preview screenshots.

TakePreview()

IMPORT_C TInt TakePreview ( )

Takes a screenshot.

Unregister(TInt)

IMPORT_C TInt Unregister ( TInt aWgId )

Unregisters window group.

Parameters

TInt aWgId Window group id.

Member Data Documentation

CTsFastSwapPreviewProviderClient * iClient

CTsFastSwapPreviewProviderClient * iClient [private]

Implementation class.

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.