MBrCtlDialogsProvider Class Reference

API published in: S60 2nd Ed FP 3

Link against: browserengine.lib

Capability Information

Required Capabilities

None

Exceptions

NetworkServices capability is required for any operation that results in loading content from the network. For example, calling LoadUrlL() with a url parameter that refers to a network location requires NetworkServices capability if the content is not available from the cache or if the specified cache mode prevents loading the cached version.


#include <brctldialogsprovider.h>

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
 
 @file BrCtlDialogsProvider.h
*

Public Member Functions

virtual void  DialogNotifyErrorL (TInt aErrCode)=0
  Notifies the user of an error encountered during a download.
virtual void  DialogNotifyHttpErrorL (TInt aErrCode, const TDesC &aUri)=0
  Notifies the user of an error from the HTTP server during a download.
virtual TBool  DialogFileSelectLC (const TDesC &aStartPath, const TDesC &aRootPath, HBufC *&aSelectedFileName)=0
  Navigates through your file system and selects a file; analogous to the Browse command in Windows.
virtual TBool  DialogSelectOptionL (const TDesC &aTitle, TBrCtlSelectOptionType aBrCtlSelectOptionType, CArrayFix< TBrCtlSelectOptionData > &aOptions)=0
  List selection dialog.
virtual TBool  DialogUserAuthenticationLC (const TDesC &aUrl, const TDesC &aRealm, const TDesC &aDefaultUserName, HBufC *&aReturnedUserName, HBufC *&aReturnedPasswd, TBool aBasicAuthentication=EFalse)=0
  User Authentication dialog.
virtual void  DialogNoteL (const TDesC &aMessage)=0
  Displays a message to the user.
virtual void  DialogAlertL (const TDesC &aTitle, const TDesC &aMessage)=0
  Display a note to the user with ok softkey only.
virtual TBool  DialogConfirmL (const TDesC &aTitle, const TDesC &aMessage, const TDesC &aYesMessage, const TDesC &aNoMessage)=0
  Display confirmation message to the user.
virtual TBool  DialogPromptLC (const TDesC &aTitle, const TDesC &aMessage, const TDesC &aDefaultInput, HBufC *&aReturnedInput)=0
  Displays an input dialog to the user.
virtual TBool  DialogDownloadObjectL (CBrCtlObjectInfo *aBrCtlObjectInfo)=0
  Displays information about the Netscape plug-in object and requests confirmation before downloading the object.
virtual void  DialogDisplayPageImagesL (CArrayFixFlat< TBrCtlImageCarrier > &aPageImages)=0
  Display the images that appear in the current page.
virtual void  CancelAll ()=0
  Cancels the dialog displayed due to browser exit or destroyed pages.
virtual void  DialogFindL ()=0
  Displays a dialog for searching on the page.

Member Function Documentation

virtual void MBrCtlDialogsProvider::CancelAll  )  [pure virtual]
 

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

Returns:
void
virtual void MBrCtlDialogsProvider::DialogAlertL const TDesC &  aTitle,
const TDesC &  aMessage
[pure virtual]
 

Display a note to the user with ok softkey only.

Parameters:
aTitle  The title, could be empty
aMessage  The message to display
Returns:
void
Attention:
The OK softkey is supported. The message displays until the user presses OK.
virtual TBool MBrCtlDialogsProvider::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?

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
Returns:
EFalse if the user cancelled the selection ETrue if the user selected an option.
virtual void MBrCtlDialogsProvider::DialogDisplayPageImagesL CArrayFixFlat< TBrCtlImageCarrier > &  aPageImages  )  [pure virtual]
 

Display the images that appear in the current page.

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.
Returns:
void
virtual TBool MBrCtlDialogsProvider::DialogDownloadObjectL CBrCtlObjectInfo aBrCtlObjectInfo  )  [pure virtual]
 

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

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
Returns:
EFalse if the user cancelled the selection ETrue if the user selected an option.
virtual TBool MBrCtlDialogsProvider::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.

Parameters:
aStartPath  The initial displayed directory
aRootPath  The top most directory that the user can go up to
aSelectedFileName  The selected file name.
Returns:
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.
virtual void MBrCtlDialogsProvider::DialogFindL  )  [pure virtual]
 

Displays a dialog for searching on the page.

Returns:
void
virtual void MBrCtlDialogsProvider::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.

Parameters:
aMessage  The message to display
Returns:
void
Attention:
Softkeys are not supported. The message disappears after a time out.
virtual void MBrCtlDialogsProvider::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.

Parameters:
aErrCode  The error that occured
Returns:
void
virtual void MBrCtlDialogsProvider::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.

Parameters:
aErrCode  The error that occured
aUri  The uri of the request that failed
Returns:
void
virtual TBool MBrCtlDialogsProvider::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.

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.
Returns:
EFalse if the user cancelled the selection ETrue if the user selected an option.
Attention:
Returned on the cleanup stack.
virtual TBool MBrCtlDialogsProvider::DialogSelectOptionL const TDesC &  aTitle,
TBrCtlSelectOptionType  aBrCtlSelectOptionType,
CArrayFix< TBrCtlSelectOptionData > &  aOptions
[pure virtual]
 

List selection dialog.

Parameters:
Title  of the selection dialog. This is optional.
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
Returns:
EFalse if the user canceled the dialog selection ETrue if the user selected an option.
virtual TBool MBrCtlDialogsProvider::DialogUserAuthenticationLC const TDesC &  aUrl,
const TDesC &  aRealm,
const TDesC &  aDefaultUserName,
HBufC *&  aReturnedUserName,
HBufC *&  aReturnedPasswd,
TBool  aBasicAuthentication = EFalse
[pure virtual]
 

User Authentication dialog.

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
Returns:
EFalse if the user cancelled the selection ETrue if the user selected an option. @ attiontion User name and password are returned on cleanup stack.

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

Copyright © Nokia Corporation 2001-2008
Back to top