Class MDialogProvider

class MDialogProvider;

Description

Dependencies : none Comments : This class provides an API to be called by low level components, like data collectors, and implemented by the UI.

It is mainly used for dialog creation and information passing.

Members

Defined in MDialogProvider:
AlertL(), CancelConnectingDialog(), CertificateConfirmationL(), CloseCancelDialog(), ConfirmationL(), DisplayCancelDialogL(), DisplayConnectingDialogL(), GotMoreUnknownData(), GotUnknownData(), MDialogProvider_Reserved1(), NoMoreUnknownData(), PasswordL(), PromptL()

virtual HBufC *PromptL(const TDesC &aMessage, const TDesC &aDefaultInput)=0;

Description

Intended Usage : This creates an input dialog for the user to enter a text string into a single text field.

Parameters

const TDesC &aMessage A descriptor with the label/title of the text field. const TDesC &aDefaultInput A descriptor with (if any) default input text.

Return value

HBufC * A pointer to a buffer with the input text.

virtual void PasswordL(TPassword &aPasswd)=0;

Description

Intended Usage : Creates a password dialog for user to enter some hidden text.

Parameters

TPassword &aPasswd An output argument which is set the entered password.

virtual TBool ConfirmationL(const TDesC &aMessage, const TDesC &aOkButtonLabel, const TDesC &aCancelButtonLabel)=0;

Description

Intended Usage : Creates a simple confirmation dialog with Ok and Cancel (or similar) buttons. Allows the user to confirm an action or message. Some text is displayed indicating the nature of the action.

Parameters

const TDesC &aMessage A descriptor with a display message. const TDesC &aOkButtonLabel A descriptor with the label for the Ok button. const TDesC &aCancelButtonLabel A descriptor with the label for the Cancel button.

Return value

TBool A boolean value of ETrue if the Ok button was pressed, or a value of EFalse if the cancel button was pressed.

virtual TBool CertificateConfirmationL(const RCertificate::TInfo &aCertificateInfo)=0;

Description

Intended Usage : Created a certificate confirmation dialog. Requests that the user accept or reject the displayed certificate.

Parameters

const RCertificate::TInfo &aCertificateInfo The certificate details.

Return value

TBool A boolean value of ETrue if the certifiacte was accepted, or a value of EFalse if it was not.

virtual void AlertL(const TDesC &aMessage)=0;

Description

Intended Usage : Creates an alert dialog to inform the user. A message is displayed and there is an Ok (or similar) button to close the dialog.

Parameters

const TDesC &aMessage A descriptor with the alert message.

virtual void DisplayConnectingDialogL()=0;

Pre-Condition

A connecting dialog is not already been created.

Description

Intended Usage : This creates a dialog which indicates that a connection is being done.

Post-Condition

Unspecified

virtual void CancelConnectingDialog()=0;

Description

Intended Usage : Cancels the current connecting dialog.

virtual void DisplayCancelDialogL(const TDesC &aMessage, MWtaiCancelOperationObserver *aCancelOperation)=0;

Pre-Condition

None

Description

Intended Usage : Displays a non-blocking cancel dialog that allows the user to cancel an an operation. When the user cancels the operation, the dialog must close and call the CancelOperation() method provided by the MWtaiPublicCancelOperation object passed in by the object that requires the use of the cancel dialog.

Post-Condition

A non-blocking cancel dialog appears with the paramater text passed into it

Parameters

const TDesC &aMessage Descriptor containing the message to display on the dialog MWtaiCancelOperationObserver *aCancelOperation A pointer to the object that implements the MWtaiPublicCancelOperation class

virtual void CloseCancelDialog()=0;

Pre-Condition

The DisplayCancelDialogL() method must have been called and the dialog is on display

Description

Intended Usage : This method closes the cancel dialog created from the DisplayCancelDialogL above.

Post-Condition

The cancel dialog closes

virtual TBool GotUnknownData(const TDesC &aMimeType, MHTTPDataSupplier *aDataSupplier)=0;

Pre-Condition

Unknown data content will have begun downloading

Description

Intended Usage : This method is called when unknown data is first recieved and should be handled. Data is recieved in chunks and this method is called when the first chunk has arrived.

Post-Condition

The data will continue downloading if ETrue is returned

Parameters

const TDesC &aMimeType A descriptor containing the mime type of the data MHTTPDataSupplier *aDataSupplier A pointer to the data supplier object that contains the data

Return value

TBool A boolean value that returns ETrue if the data will be handled and to continue downloading the data or EFalse to say not to handle the data and cancel the download.

virtual void GotMoreUnknownData(MHTTPDataSupplier *aDataSupplier)=0;

Pre-Condition

The first chunk of data has already arrived and GotUnknownData() method has been called

Description

Intended Usage : This method will be called when more unknown data from an existing fetch has arrived. As the data arrives in chunks, this methos will be called when data arrives after the GotUnknownData() method has been called.

Parameters

MHTTPDataSupplier *aDataSupplier A pointer to the data supplier object that contains the data

virtual void NoMoreUnknownData(MHTTPDataSupplier *aDataSupplier, TInt aErrorCode)=0;

Pre-Condition

An unknown data fetch has been completed and all data handled

Description

Intended Usage : The method is called when an existing unknown data fetch has completed and no more unknown data is to be expected.

Parameters

MHTTPDataSupplier *aDataSupplier A pointer to the data supplier that contains the unknown data TInt aErrorCode An error value, KErrNone if no error, KErrCancel if the download is cancelled

virtual void MDialogProvider_Reserved1()=0;

Description

Intended Usage : Function placeholder for BC proofing.