MBrCtlDialogsProvider Class Reference

#include <mw/brctldialogsprovider.h>

class MBrCtlDialogsProvider

Public Member Functions
pure virtual void	CancelAll()
pure virtual void	DialogAlertL(const TDesC &, const TDesC &)
pure virtual TBool	DialogConfirmL(const TDesC &, const TDesC &, const TDesC &, const TDesC &)
pure virtual void	DialogDisplayPageImagesL(CArrayFixFlat< TBrCtlImageCarrier > &)
pure virtual TBool	DialogDownloadObjectL(CBrCtlObjectInfo *)
pure virtual TBool	DialogFileSelectLC(const TDesC &, const TDesC &, HBufC *&)
pure virtual void	DialogFindL()
pure virtual void	DialogNoteL(const TDesC &)
pure virtual void	DialogNotifyErrorL(TInt)
pure virtual void	DialogNotifyHttpErrorL(TInt, const TDesC &)
pure virtual TBool	DialogPromptLC(const TDesC &, const TDesC &, const TDesC &, HBufC *&)
pure virtual TBool	DialogSelectOptionL(const TDesC &, TBrCtlSelectOptionType, CArrayFix< TBrCtlSelectOptionData > &)
pure virtual TBool	DialogUserAuthenticationLC(const TDesC &, const TDesC &, const TDesC &, HBufC &, HBufC &, TBool)

Detailed Description

The MBrDialogsProvider class provides functions implemented by the Browser Control to display dialogs, such as error notifications, authentication requests, and selection lists.

Usage:

  #include <brctldialogsprovider.h>


 @see S60 Platform: Browser Control API Developer's Guide Version 2.0
 @lib BrowserEngine.lib
 @file brctldialogsprovider.h

Member Function Documentation

CancelAll ( )

void

CancelAll

(

)

[pure virtual]

Cancels the dialog displayed due to browser exit or destroyed pages.

Since: 2.8

Return Value: void

DialogAlertL ( const TDesC &, const TDesC & )

void	DialogAlertL	(	const TDesC &	aTitle,
			const TDesC &	aMessage
		)	[pure virtual]

Display a note to the user with ok softkey only

Since: 2.8

Attention:

The OK softkey is supported. The message displays until the user presses OK.

Parameters
aTitle	The title, could be empty
aMessage	The message to display

Return Value: void

DialogConfirmL ( const TDesC &, const TDesC &, const TDesC &, const TDesC & )

TBool	DialogConfirmL	(	const TDesC &	aTitle,
			const TDesC &	aMessage,
			const TDesC &	aYesMessage,
			const TDesC &	aNoMessage
		)	[pure virtual]

Display confirmation message to the user. For example, Are you sure you want to delete this?

Since: 2.8

Parameters
aTitle	The title, could be empty
aMessage	The message to display
aYesMessage	The text to display on left softkey
aNoMessage	The text to display on right softkey

Return Value: EFalse if the user cancelled the selection ETrue if the user selected an option.

DialogDisplayPageImagesL ( CArrayFixFlat< TBrCtlImageCarrier > & )

void

DialogDisplayPageImagesL

(

CArrayFixFlat< TBrCtlImageCarrier > &

aPageImages

)

[pure virtual]

Display the images that appear in the current page

Since: 2.8

Parameters
aPageImages	Array describing the images that appear in the current page. The array contains the following elements for each image: Image data URL of the image Title for the image Image type If the image type is WBMP or OTA, it must be specified. Symbian can detect any other image type.

Return Value: void

DialogDownloadObjectL ( CBrCtlObjectInfo * )

TBool

DialogDownloadObjectL

(

CBrCtlObjectInfo *

aBrCtlObjectInfo

)

[pure virtual]

Displays information about the Netscape plug-in object and requests confirmation before downloading the object.

Since: 2.8

Parameters
aBrCtlObjectInfo	Information about the object to be downloaded. The following information is passes as part of this object: Content type Size Flag to indicate whether a viewer application exists for this content Flag to indicate whether a Netscape plug-in exists that supports this content Name of the application or Netscape plug-in with which the content can be viewed on the mobile phone

Return Value: EFalse if the user cancelled the selection ETrue if the user selected an option.

DialogFileSelectLC ( const TDesC &, const TDesC &, HBufC *& )

TBool	DialogFileSelectLC	(	const TDesC &	aStartPath,
			const TDesC &	aRootPath,
			HBufC *&	aSelectedFileName
		)	[pure virtual]

Navigates through your file system and selects a file; analogous to the Browse command in Windows.

Since: 2.8

Parameters
aStartPath	The initial displayed directory
aRootPath	The top most directory that the user can go up to
aSelectedFileName	The selected file name.

Return Value: ETrue if the user selected a file EFalse if the user cancelled the transaction and did not select a file. Returned on cleanup stack. Browser control will free the buffer.

DialogFindL ( )

void

DialogFindL

(

)

[pure virtual]

Displays a dialog for searching on the page.

Since: 3.0

Return Value: void

DialogNoteL ( const TDesC & )

void

DialogNoteL

(

const TDesC &

aMessage

)

[pure virtual]

Displays a message to the user. For example, the message may inform the user about an error encountered while processing a request.

Since: 2.8

Attention:

Softkeys are not supported. The message disappears after a time out.

Parameters
aMessage	The message to display

Return Value: void

DialogNotifyErrorL ( TInt )

void

DialogNotifyErrorL

(

TInt

aErrCode

)

[pure virtual]

Notifies the user of an error encountered during a download. Some examples are: insufficient memory, unrecognized URL, and DNS not found.

Since: 2.8

Parameters
aErrCode	The error that occured

Return Value: void

DialogNotifyHttpErrorL ( TInt, const TDesC & )

void	DialogNotifyHttpErrorL	(	TInt	aErrCode,
			const TDesC &	aUri
		)	[pure virtual]

Notifies the user of an error from the HTTP server during a download. Some examples are: file not found, redirect error.

Since: 2.8

Parameters
aErrCode	The error that occured
aUri	The uri of the request that failed

Return Value: void

DialogPromptLC ( const TDesC &, const TDesC &, const TDesC &, HBufC *& )

TBool	DialogPromptLC	(	const TDesC &	aTitle,
			const TDesC &	aMessage,
			const TDesC &	aDefaultInput,
			HBufC *&	aReturnedInput
		)	[pure virtual]

Displays an input dialog to the user. Asks the user to input data.

Since: 2.8

Attention:

Returned on the cleanup stack.

Parameters
aTitle	The title, could be empty
aMessage	The message to display
aDefaultInput	The default input if available
aReturnedInput	The input entered by the user.

Return Value: EFalse if the user cancelled the selection ETrue if the user selected an option.

DialogSelectOptionL ( const TDesC &, TBrCtlSelectOptionType, CArrayFix< TBrCtlSelectOptionData > & )

TBool	DialogSelectOptionL	(	const TDesC &	aTitle,
			TBrCtlSelectOptionType	aBrCtlSelectOptionType,
			CArrayFix< TBrCtlSelectOptionData > &	aOptions
		)	[pure virtual]

List selection dialog

Since: 2.8

Parameters
aBrCtlSelectOptionType	The type of the list box. Values: One of the following: Check boxes (multiple selections allowed) Radio buttons (single selection only). For example, highlight a URL listed in the session History. No buttons (single selection only) No buttons (single selection only), OK softkey available For example, if you are about to download a plug-in, you can choose to display the content in the Web page or in a viewer application.
aOptions	A list of options to display

Parameters

aBrCtlSelectOptionType

The type of the list box. Values: One of the following: Check boxes (multiple selections allowed) Radio buttons (single selection only). For example, highlight a URL listed in the session History. No buttons (single selection only) No buttons (single selection only), OK softkey available For example, if you are about to download a plug-in, you can choose to display the content in the Web page or in a viewer application.

aOptions

A list of options to display

Return Value: EFalse if the user canceled the dialog selection ETrue if the user selected an option.

DialogUserAuthenticationLC ( const TDesC &, const TDesC &, const TDesC &, HBufC &, HBufC &, TBool )

TBool	DialogUserAuthenticationLC	(	const TDesC &	aUrl,
			const TDesC &	aRealm,
			const TDesC &	aDefaultUserName,
			HBufC *&	aReturnedUserName,
			HBufC *&	aReturnedPasswd,
			TBool	aBasicAuthentication = EFalse
		)	[pure virtual]

User Authentication dialog.

Since: 2.8

Parameters
aUrl	The url requiring authentication
aRealm	The realm requiring authentication
aDefaultUserName	The user name that was used before for this realm and path, if any
aReturnedUserName	The user name entered by the user
aReturnedPasswd	The password entered by the user
aBasicAuthentication	ETrue if basic authentication is required. EFalse if another type of authentication is required; for example, Digest. Default: EFalse

Return Value: EFalse if the user cancelled the selection ETrue if the user selected an option. @ attiontion User name and password are returned on cleanup stack.

MBrCtlDialogsProvider Class Reference

Detailed Description

Member Function Documentation

CancelAll ( )

DialogAlertL ( const TDesC &, const TDesC & )

DialogConfirmL ( const TDesC &, const TDesC &, const TDesC &, const TDesC & )

DialogDisplayPageImagesL ( CArrayFixFlat< TBrCtlImageCarrier > & )

DialogDownloadObjectL ( CBrCtlObjectInfo * )

DialogFileSelectLC ( const TDesC &, const TDesC &, HBufC *& )

DialogFindL ( )

DialogNoteL ( const TDesC & )

DialogNotifyErrorL ( TInt )

DialogNotifyHttpErrorL ( TInt, const TDesC & )

DialogPromptLC ( const TDesC &, const TDesC &, const TDesC &, HBufC *& )

DialogSelectOptionL ( const TDesC &, TBrCtlSelectOptionType, CArrayFix< TBrCtlSelectOptionData > & )

DialogUserAuthenticationLC ( const TDesC &, const TDesC &, const TDesC &, HBufC *&, HBufC *&, TBool )

DialogUserAuthenticationLC ( const TDesC &, const TDesC &, const TDesC &, HBufC &, HBufC &, TBool )