Collapse all Symbian^3 Product Developer Library

CDiagPluginWaitingDialogWrapper Class Reference

class CDiagPluginWaitingDialogWrapper : public CBase

Diagnostics Plugin Waiting Dialog Wrapper.

This class provides a wrapper for executing dialogs. The only functionality it adds is that it provides a way for the caller to find out whether the dialog was dismissed by the user response, or by application deletion.

Since: S60 v5.0

Inherits from

CDiagPluginWaitingDialogWrapper
- CBase

Public Member Functions
	~CDiagPluginWaitingDialogWrapper()
IMPORT_C CDiagPluginWaitingDialogWrapper *	NewL(CAknDialog *)
IMPORT_C TBool	RunLD(TInt &)

Private Member Functions
	CDiagPluginWaitingDialogWrapper(CAknDialog *)

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
TBool *	iIsObjectDeletedPtr
CAknDialog *	iWaitingDialog

Constructor & Destructor Documentation

CDiagPluginWaitingDialogWrapper(CAknDialog *)

CDiagPluginWaitingDialogWrapper

(

CAknDialog *

aWaitingDialog

)

[private]

C++ Constructor

Parameters

CAknDialog * aWaitingDialog

~CDiagPluginWaitingDialogWrapper()

IMPORT_C

~CDiagPluginWaitingDialogWrapper

(

)

[virtual]

Destructor.

Member Functions Documentation

NewL(CAknDialog *)

IMPORT_C CDiagPluginWaitingDialogWrapper *

NewL

(

CAknDialog *

aWaitingDialog

)

[static]

Two-phased constructor.

Parameters

CAknDialog * aWaitingDialog

RunLD(TInt &)

IMPORT_C TBool

RunLD

(

TInt &

aDialogResponse

)

Run a dialog that waits for response.

To dismiss the dialog, simply delete CDiagPluginWaitingDialogWrapper instance.

The difference from normal dialog RunLD is that this function returns ETrue if dialog exited due to user response and EFalse if the object was deleted.

!!!! NOTE THAT PLUG-IN MUST RETURN IMMEDIATELY WITHOUT ACCESSING !!!! !!!! LOCAL VARIABLE OR LOCAL FUNCITONS WHEN THIS FUNCTION RETURNS !!!! !!!! EFalse VALUE BECAUSE "THIS" POINTER MAY BE FREED ALREADY. !!!!

The normal dialog response is returned via aDialogResponse parameter.

avkon.hrh "CBA constants". E.g. EAknSoftkeyYes The only exception is that if cancel is pressed, it will be 0.

Parameters

TInt & aDialogResponse

- Response from the dialog. For detailed values

Member Data Documentation

TBool * iIsObjectDeletedPtr

TBool *

iIsObjectDeletedPtr

[private]

Indicates whether this class is deleted by caller. Ownership: Not owned. Normally, it will point to a stack entry.

CAknDialog * iWaitingDialog

CAknDialog *

iWaitingDialog

[private]

Pointer to the dialog being displayed. Ownership: Shared. Normally, dialog will dismiss itself. However, if plug-in is being deleted, it can be deleted by the plug-in as well.