Symbian^3 Application Developer Library >

CMsvProgressReporterOperation Class Reference

class CMsvProgressReporterOperation : public CMsvOperation

Progress reporter operation.

A 'super-operation' implementing the abstract progress reporter mixin interface. This class encapsulates the operation; which provides the progress; and the dialog that displays it.

Inherits from

Public Member Functions
~CMsvProgressReporterOperation ()
IMPORT_C void MakeProgressVisibleL ( TBool )
IMPORT_C CMtmStore & MtmStore ()
IMPORT_C CMsvProgressReporterOperation * NewL ( CMsvSession &, TRequestStatus &, TInt )
IMPORT_C CMsvProgressReporterOperation * NewL ( CMsvSession &, TRequestStatus &)
IMPORT_C CMsvProgressReporterOperation * NewL ( TBool , CMsvSession &, TRequestStatus &, TInt )
IMPORT_C CMsvProgressReporterOperation * NewL ( TBool , CMsvSession &, TRequestStatus &)
IMPORT_C CMsvProgressReporterOperation * NewL ( TBool , TBool , CMsvSession &, TRequestStatus &, TInt )
IMPORT_C CMsvProgressReporterOperation * NewL ( CMsvSession &, TRequestStatus &, TInt , TUid )
IMPORT_C const TDesC8 & ProgressL ()
IMPORT_C void PublishNewDialogL ( TInt , TUid )
IMPORT_C TRequestStatus & RequestStatus ()
IMPORT_C void SetAnimationL ( TInt )
IMPORT_C void SetCanCancelL ( TBool )
void SetCompleteWithExit ( TBool )
IMPORT_C void SetHelpContext (const TCoeHelpContext &)
IMPORT_C void SetOperationL ( CMsvOperation *)
IMPORT_C void SetProgressDecoder ( MMsvProgressDecoder &)
IMPORT_C void SetProgressVisibilityDelay ( TBool )
IMPORT_C void SetSeeding ( TBool )
IMPORT_C void SetTitleL (const TDesC &)
IMPORT_C void SetTitleL ( TInt )
IMPORT_C void UnsetProgressDecoder ()
Protected Member Functions
void DoCancel ()
void RunL ()
Private Member Functions
CMsvProgressReporterOperation ( CMsvSession &, TRequestStatus &, TInt )
void CompleteObserver ( TInt )
void ConstructL ( TBool , TBool )
void ConstructL ( TInt , TUid , TBool , TBool )
Inherited Functions
CActive::CActive(TInt)
CActive::Cancel()
CActive::Deque()
CActive::IsActive()const
CActive::IsAdded()const
CActive::Priority()const
CActive::RunError(TInt)
CActive::SetActive()
CActive::SetPriority(TInt)
CActive::~CActive()
CBase::CBase()
CBase::Delete(CBase *)
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()
CMsvOperation::CMsvOperation(CMsvSession &,TInt,TRequestStatus &)
CMsvOperation::Extension_(TUint,TAny *&,TAny *)
CMsvOperation::FinalProgress()
CMsvOperation::Id()const
CMsvOperation::Mtm()const
CMsvOperation::Service()const
CMsvOperation::SystemProgress(TMsvSystemProgress &)
CMsvOperation::~CMsvOperation()
Inherited Enumerations
CActive:TPriority
Private Attributes
TBool iCompleteWithExit
CMsvWrappableProgressDialog * iDialog
TBool iDisplayWaitAnimation
TBufC8 < 1 > iDummyProgress
TInt iImageIndex
CMtmStore * iMtmStore
CMsvOperation * iOperation
HBufC * iProgressString
Inherited Attributes
CActive::iStatus
CMsvOperation::iMsvSession
CMsvOperation::iMtm
CMsvOperation::iObserverRequestStatus
CMsvOperation::iService

Constructor & Destructor Documentation

CMsvProgressReporterOperation(CMsvSession &, TRequestStatus &, TInt)

CMsvProgressReporterOperation ( CMsvSession & aMsvSession,
TRequestStatus & aObserverRequestStatus,
TInt aImageIndex
) [private]

C++ constructor

Parameters

CMsvSession & aMsvSession
TRequestStatus & aObserverRequestStatus
TInt aImageIndex

~CMsvProgressReporterOperation()

IMPORT_C ~CMsvProgressReporterOperation ( ) [virtual]

Destructor

Member Functions Documentation

CompleteObserver(TInt)

void CompleteObserver ( TInt aCode ) [private]

internal Completes observer with the aCode

Parameters

TInt aCode

ConstructL(TBool, TBool)

void ConstructL ( TBool aProgressVisibilityDelayOff = EFalse,
TBool aDisplayWaitAnimation = ETrue
) [private]

Symbian OS constructor

Parameters

TBool aProgressVisibilityDelayOff = EFalse
TBool aDisplayWaitAnimation = ETrue

ConstructL(TInt, TUid, TBool, TBool)

void ConstructL ( TInt aDialogIndex,
TUid aCategoryUid,
TBool aProgressVisibilityDelayOff = EFalse,
TBool aDisplayWaitAnimation = ETrue
) [private]

Symbian OS constructor This method is used only when progress dialog is shown also in cover side.

Parameters

TInt aDialogIndex
TUid aCategoryUid
TBool aProgressVisibilityDelayOff = EFalse
TBool aDisplayWaitAnimation = ETrue

DoCancel()

void DoCancel ( ) [protected, virtual]

from CActive

MakeProgressVisibleL(TBool)

IMPORT_C void MakeProgressVisibleL ( TBool aVisible ) [virtual]

Make progress visible

Parameters

TBool aVisible

MtmStore()

IMPORT_C CMtmStore & MtmStore ( ) [virtual]

NewL(CMsvSession &, TRequestStatus &, TInt)

IMPORT_C CMsvProgressReporterOperation * NewL ( CMsvSession & aMsvSession,
TRequestStatus & aObserverRequestStatus,
TInt aImageIndex
) [static]

Creates new CMsvProgressReporterOperation operation

Parameters

CMsvSession & aMsvSession
TRequestStatus & aObserverRequestStatus
TInt aImageIndex

NewL(CMsvSession &, TRequestStatus &)

IMPORT_C CMsvProgressReporterOperation * NewL ( CMsvSession & aMsvSession,
TRequestStatus & aObserverRequestStatus
) [static]

Parameters

CMsvSession & aMsvSession
TRequestStatus & aObserverRequestStatus

NewL(TBool, CMsvSession &, TRequestStatus &, TInt)

IMPORT_C CMsvProgressReporterOperation * NewL ( TBool aProgressVisibilityDelayOff,
CMsvSession & aMsvSession,
TRequestStatus & aObserverRequestStatus,
TInt aImageIndex
) [static]

Creates new CMsvProgressReporterOperation operation

Parameters

TBool aProgressVisibilityDelayOff
CMsvSession & aMsvSession
TRequestStatus & aObserverRequestStatus
TInt aImageIndex

NewL(TBool, CMsvSession &, TRequestStatus &)

IMPORT_C CMsvProgressReporterOperation * NewL ( TBool aProgressVisibilityDelayOff,
CMsvSession & aMsvSession,
TRequestStatus & aObserverRequestStatus
) [static]

Parameters

TBool aProgressVisibilityDelayOff
CMsvSession & aMsvSession
TRequestStatus & aObserverRequestStatus

NewL(TBool, TBool, CMsvSession &, TRequestStatus &, TInt)

IMPORT_C CMsvProgressReporterOperation * NewL ( TBool aProgressVisibilityDelayOff,
TBool aDisplayWaitAnimation,
CMsvSession & aMsvSession,
TRequestStatus & aObserverRequestStatus,
TInt aImageIndex
) [static]

Creates new CMsvProgressReporterOperation operation. With this method it is possible to show note dialog with EWaitLayout(With wait note bar).

Parameters

TBool aProgressVisibilityDelayOff
TBool aDisplayWaitAnimation if ETrue then shows note dialog with wait note bar
CMsvSession & aMsvSession
TRequestStatus & aObserverRequestStatus
TInt aImageIndex

NewL(CMsvSession &, TRequestStatus &, TInt, TUid)

IMPORT_C CMsvProgressReporterOperation * NewL ( CMsvSession & aMsvSession,
TRequestStatus & aObserverRequestStatus,
TInt aDialogIndex,
TUid aCategoryUid
) [static]

Creates new CMsvProgressReporterOperation operation. This method is used only when progress dialog is shown also in cover side.

Parameters

CMsvSession & aMsvSession
TRequestStatus & aObserverRequestStatus
TInt aDialogIndex unique index to identify a dialog within the category.
TUid aCategoryUid category uid

ProgressL()

IMPORT_C const TDesC8 & ProgressL ( ) [virtual]

PublishNewDialogL(TInt, TUid)

IMPORT_C void PublishNewDialogL ( TInt aDialogIndex,
TUid aCategoryUid
)

Publish new dialog on secondary display. This method first dismisses the original dialog both from primary and secondary displays. After that a new dialog is created and it is published on secondary display with given parameters.

Parameters

TInt aDialogIndex unique index to identify a dialog within the category.
TUid aCategoryUid category uid

RequestStatus()

IMPORT_C TRequestStatus & RequestStatus ( )

RunL()

void RunL ( ) [protected, virtual]

from CActive

SetAnimationL(TInt)

IMPORT_C void SetAnimationL ( TInt aResourceId ) [virtual]

Sets animation

Parameters

TInt aResourceId

SetCanCancelL(TBool)

IMPORT_C void SetCanCancelL ( TBool aCanCancel ) [virtual]

Sets if operation can be cancelled by user or not

Parameters

TBool aCanCancel

SetCompleteWithExit(TBool)

void SetCompleteWithExit ( TBool aCompleteWithExit )

SetCompleteWithExit This function sets complete code

Parameters

TBool aCompleteWithExit

SetHelpContext(const TCoeHelpContext &)

IMPORT_C void SetHelpContext ( const TCoeHelpContext & aContext ) [virtual]

Sets help context

Parameters

const TCoeHelpContext & aContext

SetOperationL(CMsvOperation *)

IMPORT_C void SetOperationL ( CMsvOperation * aOp )

Sets operations Takes ownership of the operation so this class will delete the operation.

Parameters

CMsvOperation * aOp

SetProgressDecoder(MMsvProgressDecoder &)

IMPORT_C void SetProgressDecoder ( MMsvProgressDecoder & aDecoder ) [virtual]

Sets progress decoder.

Parameters

MMsvProgressDecoder & aDecoder

SetProgressVisibilityDelay(TBool)

IMPORT_C void SetProgressVisibilityDelay ( TBool aDelay )

Parameters

TBool aDelay

SetSeeding(TBool)

IMPORT_C void SetSeeding ( TBool aSeed )

Sets seeding

Parameters

TBool aSeed

SetTitleL(const TDesC &)

IMPORT_C void SetTitleL ( const TDesC & aTitle ) [virtual]

Sets text to the dialog

Parameters

const TDesC & aTitle

SetTitleL(TInt)

IMPORT_C void SetTitleL ( TInt aTitleResourceId ) [virtual]

Sets text to the dialog

Parameters

TInt aTitleResourceId

UnsetProgressDecoder()

IMPORT_C void UnsetProgressDecoder ( ) [virtual]

Removes progress decoder.

Member Data Documentation

TBool iCompleteWithExit

TBool iCompleteWithExit [private]

CMsvWrappableProgressDialog * iDialog

CMsvWrappableProgressDialog * iDialog [private]

TBool iDisplayWaitAnimation

TBool iDisplayWaitAnimation [private]

TBufC8< 1 > iDummyProgress

TBufC8 < 1 > iDummyProgress [private]

TInt iImageIndex

TInt iImageIndex [private]

CMtmStore * iMtmStore

CMtmStore * iMtmStore [private]

CMsvOperation * iOperation

CMsvOperation * iOperation [private]

HBufC * iProgressString

HBufC * iProgressString [private]

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.