MBrCtlDialogsProvider Class Reference
| class MBrCtlDialogsProvider |
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
*
| Public Member Functions |
|---|
| void | CancelAll() |
| void | DialogAlertL(const TDesC &, const TDesC &) |
|
TBool
| DialogConfirmL(const TDesC &, const TDesC &, const TDesC &, const TDesC &) |
| void | DialogDisplayPageImagesL(CArrayFixFlat< TBrCtlImageCarrier > &) |
|
TBool
| DialogDownloadObjectL(CBrCtlObjectInfo *) |
|
TBool
| DialogFileSelectLC(const TDesC &, const TDesC &, HBufC *&) |
| void | DialogFindL() |
| void | DialogNoteL(const TDesC &) |
| void | DialogNotifyErrorL(TInt) |
| void | DialogNotifyHttpErrorL(TInt, const TDesC &) |
|
TBool
| DialogPromptLC(const TDesC &, const TDesC &, const TDesC &, HBufC *&) |
|
TBool
| DialogSelectOptionL(const TDesC &, TBrCtlSelectOptionType, CArrayFix< TBrCtlSelectOptionData > &) |
|
TBool
| DialogUserAuthenticationLC(const TDesC &, const TDesC &, const TDesC &, HBufC *&, HBufC *&, TBool) |
Member Functions Documentation
CancelAll()
| void | CancelAll | ( | ) | [pure virtual] |
Cancels the dialog displayed due to browser exit or destroyed pages.
- Since
- 2.8
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
| const TDesC & aTitle | The title, could be empty |
| const TDesC & aMessage | The message to display |
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
| const TDesC & aTitle | The title, could be empty |
| const TDesC & aMessage | The message to display |
| const TDesC & aYesMessage | The text to display on left softkey |
| const TDesC & aNoMessage | The text to display on right softkey |
DialogDisplayPageImagesL(CArrayFixFlat< TBrCtlImageCarrier > &)
Display the images that appear in the current page
- Since
- 2.8
Parameters
| CArrayFixFlat< TBrCtlImageCarrier > & 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. |
DialogDownloadObjectL(CBrCtlObjectInfo *)
Displays information about the Netscape plug-in object and requests confirmation before downloading the object.
- Since
- 2.8
Parameters
| CBrCtlObjectInfo * 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 |
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
| const TDesC & aStartPath | The initial displayed directory |
| const TDesC & aRootPath | The top most directory that the user can go up to |
| HBufC *& aSelectedFileName | The selected file name. |
DialogFindL()
| void | DialogFindL | ( | ) | [pure virtual] |
Displays a dialog for searching on the page.
- Since
- 3.0
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
| const TDesC & aMessage | The message to display |
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
| TInt aErrCode | The error that occured |
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
| TInt aErrCode | The error that occured |
| const TDesC & aUri | The uri of the request that failed |
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
| const TDesC & aTitle | The title, could be empty |
| const TDesC & aMessage | The message to display |
| const TDesC & aDefaultInput | The default input if available |
| HBufC *& aReturnedInput | The input entered by the user. |
DialogSelectOptionL(const TDesC &, TBrCtlSelectOptionType, CArrayFix< TBrCtlSelectOptionData > &)
List selection dialog
- Since
- 2.8
Parameters
| const TDesC & aTitle | |
| TBrCtlSelectOptionType 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. |
| CArrayFix< TBrCtlSelectOptionData > & aOptions | A list of options to display |
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
| const TDesC & aUrl | The url requiring authentication |
| const TDesC & aRealm | The realm requiring authentication |
| const TDesC & aDefaultUserName | The user name that was used before for this realm and path, if any |
| HBufC *& aReturnedUserName | The user name entered by the user |
| HBufC *& aReturnedPasswd | The password entered by the user |
| TBool aBasicAuthentication = EFalse | ETrue if basic authentication is required. EFalse if another type of authentication is required; for example, Digest. Default: EFalse |
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.