Symbian^3 Application Developer Library >

SwiUI::CommonUI::CCUIDialogs Class Reference

class SwiUI::CommonUI::CCUIDialogs : public CBase

This class provides a wrapper for some common dialogs for the installer ui plugins.

swinstui.lib
Since
3.0

Inherits from

  • SwiUI::CommonUI::CCUIDialogs
Public Member Functions
~CCUIDialogs ()
IMPORT_C void CloseProgressDialogL ()
IMPORT_C void CloseWaitDialogL ()
IMPORT_C void LaunchHelpL (const TDesC &)
IMPORT_C CCUIDialogs * NewL ()
IMPORT_C void ResetProgressDialogL ()
IMPORT_C void SetProgressDialogFinalValueL ( TInt )
IMPORT_C TBool ShowConfirmationQueryL ( TInt , TInt )
IMPORT_C TBool ShowConfirmationQueryL (const TDesC &, TInt )
IMPORT_C void ShowDelayedWaitDialogL ( TInt , MCUIWaitDialogCallback *, TInt )
IMPORT_C TInt ShowDriveSelectionDialogL ( TInt64 , const RArray < TDriveUnit > &, const RArray < TInt64 > &, TInt &)
IMPORT_C void ShowErrorNoteL ( TInt )
IMPORT_C void ShowErrorNoteL (const TDesC &)
IMPORT_C TBool ShowInstallationCompleteQueryL (const MDesCArray &, const MDesCArray &, const CAknIconArray &, TInt &)
IMPORT_C void ShowProgressDialogL ( TInt , MCUIWaitDialogCallback *, TInt )
IMPORT_C void ShowProgressDialogL (const TDesC &, MCUIWaitDialogCallback *, TInt )
IMPORT_C TBool ShowSecurityWarningDialogL ()
IMPORT_C TBool ShowUninstallConfirmationForSeveralAppsL (const TDesC &, const MDesCArray &, TInt )
IMPORT_C void ShowWaitDialogL ( TInt , MCUIWaitDialogCallback *, TInt )
IMPORT_C void UpdateProgressDialogValueL ( TInt )
Private Member Functions
CCUIDialogs ()
void ConstructL ()
void SetProgressDialogCallback ( MCUIWaitDialogCallback *)
void SetWaitDialogCallback ( MCUIWaitDialogCallback *)
TInt ShowSecurityWarningHelp ( TAny *)
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
CAknInputBlock * iAbsorber
CCoeEnv * iCoeEnv
CCUIProgressDialog * iProgressDialog
TInt iResourceFileOffset
CCUIWaitDialog * iWaitDialog

Constructor & Destructor Documentation

CCUIDialogs()

CCUIDialogs ( ) [private]

Constructor.

~CCUIDialogs()

IMPORT_C ~CCUIDialogs ( ) [virtual]

Destructor.

Member Functions Documentation

CloseProgressDialogL()

IMPORT_C void CloseProgressDialogL ( )
Closes the progress dialog.
Since
3.0

CloseWaitDialogL()

IMPORT_C void CloseWaitDialogL ( )
Closes the wait dialog.
Since
3.0

ConstructL()

void ConstructL ( ) [private]

2nd phase constructor.

LaunchHelpL(const TDesC &)

IMPORT_C void LaunchHelpL ( const TDesC & aContext )
Launches a help with the given context.
Since
3.0

Parameters

const TDesC & aContext - The help text to show.

NewL()

IMPORT_C CCUIDialogs * NewL ( ) [static]

Two-phased constructor.

ResetProgressDialogL()

IMPORT_C void ResetProgressDialogL ( )
Resets the progress bar in the progress dialog.
Since
3.0

SetProgressDialogCallback(MCUIWaitDialogCallback *)

void SetProgressDialogCallback ( MCUIWaitDialogCallback * aCallback ) [private]
Sets the callback for progress dialog events.
Since
3.0

Parameters

MCUIWaitDialogCallback * aCallback - The callback class.

SetProgressDialogFinalValueL(TInt)

IMPORT_C void SetProgressDialogFinalValueL ( TInt aValue )
Set final value for the progress bar in progress dialog.
Since
3.0

Parameters

TInt aValue - Final value of the progress bar.

SetWaitDialogCallback(MCUIWaitDialogCallback *)

void SetWaitDialogCallback ( MCUIWaitDialogCallback * aCallback ) [private]
Sets the callback for wait dialog events.
Since
3.0

Parameters

MCUIWaitDialogCallback * aCallback - The callback class.

ShowConfirmationQueryL(TInt, TInt)

IMPORT_C TBool ShowConfirmationQueryL ( TInt aResourceId,
TInt aSoftkeyResourceId = R_AVKON_SOFTKEYS_OK_CANCEL__OK
) const
Show a confirmation dialog.
Since
3.0

Parameters

TInt aResourceId - Resource id of the string to be displayed.
TInt aSoftkeyResourceId = R_AVKON_SOFTKEYS_OK_CANCEL__OK - Resource id of the softkeys.

ShowConfirmationQueryL(const TDesC &, TInt)

IMPORT_C TBool ShowConfirmationQueryL ( const TDesC & aDisplayString,
TInt aSoftkeyResourceId = R_AVKON_SOFTKEYS_OK_CANCEL__OK
) const
Show a confirmation dialog.
Since
3.0

Parameters

const TDesC & aDisplayString - The string to be displayed.
TInt aSoftkeyResourceId = R_AVKON_SOFTKEYS_OK_CANCEL__OK - Resource id of the softkeys.

ShowDelayedWaitDialogL(TInt, MCUIWaitDialogCallback *, TInt)

IMPORT_C void ShowDelayedWaitDialogL ( TInt aResourceId,
MCUIWaitDialogCallback * aCallback,
TInt aSoftkeyResourceId = R_AVKON_SOFTKEYS_CANCEL
)
Show a delayed wait dialog. If any wait dialog is active, only the dialog text will be changed. No events will be triggered.
Since
3.0

Parameters

TInt aResourceId - Resource id of the string to be displayed.
MCUIWaitDialogCallback * aCallback - Class to be informed about dialog dismissal.
TInt aSoftkeyResourceId = R_AVKON_SOFTKEYS_CANCEL - Resource id of the softkeys.

ShowDriveSelectionDialogL(TInt64, const RArray< TDriveUnit > &, const RArray< TInt64 > &, TInt &)

IMPORT_C TInt ShowDriveSelectionDialogL ( TInt64 aSize,
const RArray < TDriveUnit > & aDriveUnits,
const RArray < TInt64 > & aDriveSpaces,
TInt & aSelectionResult
)
Show a drive / memory selection dialog.
Since
3.0

Parameters

TInt64 aSize - Size of the application to be installed.
const RArray < TDriveUnit > & aDriveUnits - Array of available drives as drive units.
const RArray < TInt64 > & aDriveSpaces - Array of free space on each of the drives in the aDriveLetters array.
TInt & aSelectionResult - Selected index of the aDriveUnits array.

ShowErrorNoteL(TInt)

IMPORT_C void ShowErrorNoteL ( TInt aResourceId ) const
Show an error note.
Since
3.0

Parameters

TInt aResourceId - Resource id of the error text.

ShowErrorNoteL(const TDesC &)

IMPORT_C void ShowErrorNoteL ( const TDesC & aErrorText ) const
Show an error note.
Since
3.0

Parameters

const TDesC & aErrorText - Error text.

ShowInstallationCompleteQueryL(const MDesCArray &, const MDesCArray &, const CAknIconArray &, TInt &)

IMPORT_C TBool ShowInstallationCompleteQueryL ( const MDesCArray & aApplicationArray,
const MDesCArray & aInstalledFolderArray,
const CAknIconArray & aIconArray,
TInt & aIndexOfAppToBeStarted
) const
Show an installation complete query.
Since
3.2

Parameters

const MDesCArray & aApplicationArray - An array for application names
const MDesCArray & aInstalledFolderArray - An array for installed folders. (default folder is used if array is empty, folder names for zero length items are not shown)
const CAknIconArray & aIconArray - An array for application icons
TInt & aIndexOfAppToBeStarted - Returns index (starting from zero) of application chosen to be started after installation

ShowProgressDialogL(TInt, MCUIWaitDialogCallback *, TInt)

IMPORT_C void ShowProgressDialogL ( TInt aResourceId,
MCUIWaitDialogCallback * aCallback,
TInt aSoftkeyResourceId = R_AVKON_SOFTKEYS_CANCEL
)
Show a progress dialog. If any progress is active, only the dialog text will be changed. No events will be triggered.
Since
3.0

Parameters

TInt aResourceId - Resource id of the string to be displayed.
MCUIWaitDialogCallback * aCallback - Class to be informed about dialog dismissal.
TInt aSoftkeyResourceId = R_AVKON_SOFTKEYS_CANCEL - Resource id of the softkeys.

ShowProgressDialogL(const TDesC &, MCUIWaitDialogCallback *, TInt)

IMPORT_C void ShowProgressDialogL ( const TDesC & aText,
MCUIWaitDialogCallback * aCallback,
TInt aSoftkeyResourceId = R_AVKON_SOFTKEYS_CANCEL
)
Show a progress dialog. If any progress is active, only the dialog text will be changed. No events will be triggered.
Since
3.0

Parameters

const TDesC & aText - String to be displayed in the dialog.
MCUIWaitDialogCallback * aCallback - Class to be informed about dialog dismissal.
TInt aSoftkeyResourceId = R_AVKON_SOFTKEYS_CANCEL - Resource id of the softkeys.

ShowSecurityWarningDialogL()

IMPORT_C TBool ShowSecurityWarningDialogL ( )
Show a security warning dialog.
Since
3.0

ShowSecurityWarningHelp(TAny *)

TInt ShowSecurityWarningHelp ( TAny * aPtr ) [private, static]
Used as a callback function in message query. Launches help for security warning.
Since
3.0

Parameters

TAny * aPtr

ShowUninstallConfirmationForSeveralAppsL(const TDesC &, const MDesCArray &, TInt)

IMPORT_C TBool ShowUninstallConfirmationForSeveralAppsL ( const TDesC & aApplicationGroup,
const MDesCArray & aApplicationArray,
TInt aSoftkeyResourceId = R_AVKON_SOFTKEYS_YES_NO__YES
) const
Show an uninstall confirmation query when several applications (Java MIDLets) are uninstalled.
Since
3.2

Parameters

const TDesC & aApplicationGroup - Name application group (Java MIDlet suite)
const MDesCArray & aApplicationArray - An array for application names
TInt aSoftkeyResourceId = R_AVKON_SOFTKEYS_YES_NO__YES - Resource id of the softkeys.

ShowWaitDialogL(TInt, MCUIWaitDialogCallback *, TInt)

IMPORT_C void ShowWaitDialogL ( TInt aResourceId,
MCUIWaitDialogCallback * aCallback,
TInt aSoftkeyResourceId = R_AVKON_SOFTKEYS_CANCEL
)
Show a wait dialog. If any wait dialog is active, only the dialog text will be changed. No events will be triggered.
Since
3.0

Parameters

TInt aResourceId - Resource id of the string to be displayed.
MCUIWaitDialogCallback * aCallback - Class to be informed about dialog dismissal.
TInt aSoftkeyResourceId = R_AVKON_SOFTKEYS_CANCEL - Resource id of the softkeys.

UpdateProgressDialogValueL(TInt)

IMPORT_C void UpdateProgressDialogValueL ( TInt aValue )
Increments the progress bar in progress dialog.
Since
3.0

Parameters

TInt aValue - Value to be added to the total progress.

Member Data Documentation

CAknInputBlock * iAbsorber

CAknInputBlock * iAbsorber [private]

CCoeEnv * iCoeEnv

CCoeEnv * iCoeEnv [private]

CCUIProgressDialog * iProgressDialog

CCUIProgressDialog * iProgressDialog [private]

TInt iResourceFileOffset

TInt iResourceFileOffset [private]

CCUIWaitDialog * iWaitDialog

CCUIWaitDialog * iWaitDialog [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.