CAknWaitNoteWrapper Class Reference

API published in: S60 1st Ed

Link against: avkon.lib eikctl.lib eikcdlg.lib

Capability Information

Required Capabilities

None


#include <aknwaitnotewrapper.h>

Inherits MProgressDialogCallback.


Detailed Description

CAknWaitNoteWrapper class.

Public Member Functions

IMPORT_C  ~CAknWaitNoteWrapper ()
IMPORT_C TBool  ExecuteL (TInt aResId, MAknBackgroundProcess &aBackgroundProcess, TBool aVisibilityDelayOff=EFalse, const CAknNoteDialog::TTone &aTone=CAknNoteDialog::ENoTone)
  Executes the wait note and calls the cycle callback.
IMPORT_C TBool  ExecuteL (TInt aResId, MAknBackgroundProcess &aBackgroundProcess, const TDesC &aPrompt, TBool aVisibilityDelayOff=EFalse, const CAknNoteDialog::TTone &aTone=CAknNoteDialog::ENoTone)
  Executes the wait note and calls the cycle callback.
CAknWaitDialog WaitDialog () const
  Return pointer to dialog.

Static Public Member Functions

static IMPORT_C CAknWaitNoteWrapper NewL ()

Constructor & Destructor Documentation

IMPORT_C CAknWaitNoteWrapper::~CAknWaitNoteWrapper  ) 
 

Member Function Documentation

IMPORT_C TBool CAknWaitNoteWrapper::ExecuteL TInt  aResId,
MAknBackgroundProcess aBackgroundProcess,
const TDesC &  aPrompt,
TBool  aVisibilityDelayOff = EFalse,
const CAknNoteDialog::TTone aTone = CAknNoteDialog::ENoTone
 

Executes the wait note and calls the cycle callback.

Dynamically set note prompt.

Parameters:
aResId  Resource id for the dialog.
aBackgroundProcess  Callback interface.
aPrompt  Note Prompt
aVisibilityDelayOff  If set ETrue the dialog will be visible immediality. Use only when the length of the process is ALWAYS over 1.5 seconds.
aTone  Will be played when the dialog is shown.
Returns:
true if success, false if wait note was canceled.
IMPORT_C TBool CAknWaitNoteWrapper::ExecuteL TInt  aResId,
MAknBackgroundProcess aBackgroundProcess,
TBool  aVisibilityDelayOff = EFalse,
const CAknNoteDialog::TTone aTone = CAknNoteDialog::ENoTone
 

Executes the wait note and calls the cycle callback.

Parameters:
aResId  Resource id for the dialog.
aBackgroundProcess  Callback interface.
aVisibilityDelayOff  If set ETrue the dialog will be visible immediality. Use only when the length of the process is ALWAYS over 1.5 seconds.
aTone  Will be played when the dialog is shown.
Returns:
true if success, false if wait note was canceled.
static IMPORT_C CAknWaitNoteWrapper* CAknWaitNoteWrapper::NewL  )  [static]
 
CAknWaitDialog * CAknWaitNoteWrapper::WaitDialog  )  const [inline]
 

Return pointer to dialog.


The documentation for this class was generated from the following file:

Copyright © Nokia Corporation 2001-2008
Back to top