Collapse all Symbian^3 Application Developer Library

Swi::MInstallerUiHandler Class Reference

class Swi::MInstallerUiHandler

This represents the User Interface handler for the installation of SISX files by Software Install Server.

Public Member Functions
void	DisplayCannotOverwriteFileL (const CAppInfo &, const CAppInfo &, const TDesC &)
TInt	DisplayDriveL (const CAppInfo &, TInt64 , const RArray < TChar > &, const RArray < TInt64 > &)
TBool	DisplayGrantCapabilitiesL (const CAppInfo &, const TCapabilitySet &)
TBool	DisplayInstallL (const CAppInfo &, const CApaMaskedBitmap *, const RPointerArray < CCertificateInfo > &)
TInt	DisplayLanguageL (const CAppInfo &, const RArray < TLanguage > &)
TBool	DisplayMissingDependencyL (const CAppInfo &, const TDesC &, TVersion , TVersion , TVersion )
TBool	DisplayOcspResultL (const CAppInfo &, TRevocationDialogMessage , RPointerArray < TOCSPOutcome > &, RPointerArray < CCertificateInfo > &, TBool )
TBool	DisplayOptionsL (const CAppInfo &, const RPointerArray < TDesC > &, RArray < TBool > &)
TBool	DisplaySecurityWarningL (const CAppInfo &, TSignatureValidationResult , RPointerArray < CPKIXValidationResultBase > &, RPointerArray < CCertificateInfo > &, TBool )
TBool	DisplayUpgradeL (const CAppInfo &, const CAppInfo &)
void	HandleCancellableInstallEventL (const CAppInfo &, TInstallCancellableEvent , MCancelHandler &, TInt , const TDesC &)
TBool	HandleInstallEventL (const CAppInfo &, TInstallEvent , TInt , const TDesC &)

Member Functions Documentation

DisplayCannotOverwriteFileL(const CAppInfo &, const CAppInfo &, const TDesC &)

void	DisplayCannotOverwriteFileL	(	const CAppInfo &	aAppInfo,
			const CAppInfo &	aInstalledAppInfo,
			const TDesC &	aFileName
		)	[pure virtual]

Used to inform the user the installation they are attempting is trying to overwrite a file that does not belong to it. Following this message installation is aborted.

Parameters

const CAppInfo & aAppInfo	Information about the application.
const CAppInfo & aInstalledAppInfo	Information about the application that owns the file in question.
const TDesC & aFileName	The filename of the file in question

DisplayDriveL(const CAppInfo &, TInt64, const RArray< TChar > &, const RArray< TInt64 > &)

TInt	DisplayDriveL	(	const CAppInfo &	aAppInfo,
			TInt64	aSize,
			const RArray < TChar > &	aDriveLetters,
			const RArray < TInt64 > &	aDriveSpaces
		)	[pure virtual]

Requests the drive to install the package on, from the UI.

Parameters

const CAppInfo & aAppInfo	Information about the application.
TInt64 aSize	Total size of the files that will be installed on the configurable drive.
const RArray < TChar > & aDriveLetters	Array of drive letters on which the package can be installed.
const RArray < TInt64 > & aDriveSpaces	Array of space free (in bytes) on each of the drives in the aDriveLetters array.

DisplayGrantCapabilitiesL(const CAppInfo &, const TCapabilitySet &)

TBool	DisplayGrantCapabilitiesL	(	const CAppInfo &	aAppInfo,
			const TCapabilitySet &	aCapabilitySet
		)	[pure virtual]

Displays a dialog requesting that the user grants these capabilities to the SISX package being installed. This dialog must be shown in TrustedUI mode.

Note:

Trusted UI

Parameters

const CAppInfo & aAppInfo	Information about the application.
const TCapabilitySet & aCapabilitySet	The capabilities requested by the SISX package.

DisplayInstallL(const CAppInfo &, const CApaMaskedBitmap *, const RPointerArray< CCertificateInfo > &)

TBool	DisplayInstallL	(	const CAppInfo &	aAppInfo,
			const CApaMaskedBitmap *	aLogo,
			const RPointerArray < CCertificateInfo > &	aCertificates
		)	[pure virtual]

Displays a dialog at the beginning of an installation with details about the SISX package being installed. This dialog must be shown in TrustedUI mode.

An installer UI should call REComSession::FinalClose() as part of clean up.

Note:

Trusted UI

Parameters

const CAppInfo & aAppInfo	Information about the application.
const CApaMaskedBitmap * aLogo	The logo data in the SISX file. If no logo is present it will be NULL.
const RPointerArray < CCertificateInfo > & aCertificates	An array of end entity certificates, one for each chain in the SISX file. If the SISX file is unsigned this array will have zero length.

DisplayLanguageL(const CAppInfo &, const RArray< TLanguage > &)

TInt	DisplayLanguageL	(	const CAppInfo &	aAppInfo,
			const RArray < TLanguage > &	aLanguages
		)	[pure virtual]

Requests preferred language and dialect information from the UI.

Parameters

const CAppInfo & aAppInfo	Information about the application.
const RArray < TLanguage > & aLanguages	Array of languages supported by the SIS file.

DisplayMissingDependencyL(const CAppInfo &, const TDesC &, TVersion, TVersion, TVersion)

TBool	DisplayMissingDependencyL	(	const CAppInfo &	aAppInfo,
			const TDesC &	aDependencyName,
			TVersion	aWantedVersionFrom,
			TVersion	aWantedVersionTo,
			TVersion	aInstalledVersion
		)	[pure virtual]

Used to inform the user of a missing dependency needed to install the current package. It is up to the UI implementors and/or the user whether or not this warning can be overridden.

Parameters

const CAppInfo & aAppInfo	Info about the current application.
const TDesC & aDependencyName	Name of the missing dependency.
TVersion aWantedVersionFrom	Ending suitable version number of the mising dependency. Can be all zeros, meaning it is unknown.
TVersion aWantedVersionTo
TVersion aInstalledVersion	The installed (unsuitable) version of the missing dependency. Can be all zeros, meaning the missing dependency is not installed.

DisplayOcspResultL(const CAppInfo &, TRevocationDialogMessage, RPointerArray< TOCSPOutcome > &, RPointerArray< CCertificateInfo > &, TBool)

TBool	DisplayOcspResultL	(	const CAppInfo &	aAppInfo,
			TRevocationDialogMessage	aMessage,
			RPointerArray < TOCSPOutcome > &	aOutcomes,
			RPointerArray < CCertificateInfo > &	aCertificates,
			TBool	aWarningOnly
		)	[pure virtual]

Displays a dialog indicating that there was an error carrying out online certificate status checking.

Parameters

const CAppInfo & aAppInfo	Application info from the package file
TRevocationDialogMessage aMessage	The error which occurred during online certificate status checking
RPointerArray < TOCSPOutcome > & aOutcomes	The outcomes of the OCSP checks
RPointerArray < CCertificateInfo > & aCertificates	Certificate information of the end (signing) certificates that correspond to the outcomes
TBool aWarningOnly	ETrue if the installation is allowed to continue after a warning, EFalse otherwise.

DisplayOptionsL(const CAppInfo &, const RPointerArray< TDesC > &, RArray< TBool > &)

TBool	DisplayOptionsL	(	const CAppInfo &	aAppInfo,
			const RPointerArray < TDesC > &	aOptions,
			RArray < TBool > &	aSelections
		)	[pure virtual]

Displays a dialog box asking which options the user wishes to install.

Parameters

const CAppInfo & aAppInfo	Information about the application.
const RPointerArray < TDesC > & aOptions	An array of option names.
RArray < TBool > & aSelections	An array of booleans, corresponding to the aOptions array.

DisplaySecurityWarningL(const CAppInfo &, TSignatureValidationResult, RPointerArray< CPKIXValidationResultBase > &, RPointerArray< CCertificateInfo > &, TBool)

TBool	DisplaySecurityWarningL	(	const CAppInfo &	aAppInfo,
			TSignatureValidationResult	aSigValidationResult,
			RPointerArray < CPKIXValidationResultBase > &	aPkixResults,
			RPointerArray < CCertificateInfo > &	aCertificates,
			TBool	aInstallAnyway
		)	[pure virtual]

Displays a dialog indicating that the package is unsigned, or that signature validation has failed.

Parameters

const CAppInfo & aAppInfo	Information about the application.
TSignatureValidationResult aSigValidationResult	The result of signature validation.
RPointerArray < CPKIXValidationResultBase > & aPkixResults	Results of a validation of the PKIX certificate chains
RPointerArray < CCertificateInfo > & aCertificates	Certificate information for the failed end (signing) certificates
TBool aInstallAnyway	ETrue if installation is allowed to continue.

DisplayUpgradeL(const CAppInfo &, const CAppInfo &)

TBool	DisplayUpgradeL	(	const CAppInfo &	aAppInfo,
			const CAppInfo &	aExistingAppInfo
		)	[pure virtual]

Displays a dialog asking whether we want to upgrade an application present on the device.

Parameters

const CAppInfo & aAppInfo	Information about the application being installed.
const CAppInfo & aExistingAppInfo	Information about the existing application.

HandleCancellableInstallEventL(const CAppInfo &, TInstallCancellableEvent, MCancelHandler &, TInt, const TDesC &)

void	HandleCancellableInstallEventL	(	const CAppInfo &	aAppInfo,
			TInstallCancellableEvent	aEvent,
			MCancelHandler &	aCancelHandler,
			TInt	aValue = 0,
			const TDesC &	aDes = KNullDesC
		)	[pure virtual]

Informs the UI of cancellable events occurring during installation.

Parameters

const CAppInfo & aAppInfo	Information about the application.
TInstallCancellableEvent aEvent	The event which has occurred.
MCancelHandler & aCancelHandler	This mix-in is used to inform Software Install that the user has pressed the cancel button on the dialog.
TInt aValue = 0	The value associated with the event if applicable.
const TDesC & aDes = KNullDesC	A descriptor associated with the event if applicable.

HandleInstallEventL(const CAppInfo &, TInstallEvent, TInt, const TDesC &)

TBool	HandleInstallEventL	(	const CAppInfo &	aAppInfo,
			TInstallEvent	aEvent,
			TInt	aValue = 0,
			const TDesC &	aDes = KNullDesC
		)	[pure virtual]

Informs the UI of events occurring during installation.

Parameters

const CAppInfo & aAppInfo	Information about the application.
TInstallEvent aEvent	The event which has occurred.
TInt aValue = 0	The value associated with the event if applicable.
const TDesC & aDes = KNullDesC	A descriptor associated with the event if applicable.