class CBrCtlInterface : public CCoeControl |
The CBrCtlInterface class is the base class of the Browser Control API. All clients of browser control must use this class. The functions defined in the CBrCtlInterface class implement basic Browser Control functionality. You can customize the Browser Control to extend its functionality by implementing additional interface classes in the host application. Examples of such classes are MBrCtlDataLoadSupplier , MBrCtlDialogsProvider , MBrCtlDialogsProvider etc.
Usage:
#include <brctlinterface.h> // Interface that provides dialogs used by the Browser Control. #include <brctldialogsprovider.h> // Interface used to receive scrolling events. #include <brctllayoutobserver.h> //Interface that provides a callback mechanism for receiving the //content of an embedded link or the content of a user-initiated //load request. #include <brctllinkresolver.h> //Interface that handles requests to change the softkeys. #include <brctlsoftkeysobserver.h> //Interface that handles special load needs. #include <brctlspecialloadobserver.h> //Reserved for future use. #include <brctlwindowobserver.h> //Interface that passes download events from the //Download Manager through the Browser Control to the //host application. #include <brctldownloadobserver.h> Enum Definition of the Browser Control API. #include <brctldefs.h> The following types of things you can do with the Browser Control API. Creating a basic Browser Control Creating a Browser Control with observer interfaces Loading content Passing content incrementally Receiving load progress events Handling special load requests Customizing dialogs Specifying the softkeys Resolving links Customizing scroll bars Receiving change-of-state events @see S60 Platform: Browser Control API Developer's Guide Version 2.0 @lib BrowserEngine.lib @since 2.8 @file brctlinterface.h*
Inherited Enumerations | |
---|---|
CCoeControl:TZoomType |
Inherited Attributes | |
---|---|
CCoeControl::iCoeEnv | |
CCoeControl::iContext | |
CCoeControl::iPosition | |
CCoeControl::iSize |
IMPORT_C void | AddCommandObserverL | ( | MBrCtlCommandObserver * | aBrCtlCommandObserver | ) | [pure virtual] |
MBrCtlCommandObserver * aBrCtlCommandObserver |
IMPORT_C void | AddLoadEventObserverL | ( | MBrCtlLoadEventObserver * | aBrCtlLoadEventObserver | ) | [pure virtual] |
MBrCtlLoadEventObserver * aBrCtlLoadEventObserver | A load events observer to add |
IMPORT_C void | AddOptionMenuItemsL | ( | CEikMenuPane & | aMenuPane, |
TInt | aResourceId, | |||
TInt | aAfter = -1 | |||
) | [pure virtual] |
CEikMenuPane & aMenuPane | Handle of the menu that will contain the options |
TInt aResourceId | The resource ID of the menu |
TInt aAfter = -1 | WML options should be added after that index |
IMPORT_C void | AddStateChangeObserverL | ( | MBrCtlStateChangeObserver * | aBrCtlStateChangeObserver | ) | [pure virtual] |
MBrCtlStateChangeObserver * aBrCtlStateChangeObserver | The observer to register |
IMPORT_C TUint | BrowserSettingL | ( | TUint | aSetting | ) | [pure virtual] |
TUint aSetting | The setting to get |
IMPORT_C const TCertInfo * | CertInfo | ( | ) | [pure virtual] |
IMPORT_C TUint | ClearCache | ( | ) | [pure virtual] |
IMPORT_C TInt | ClearItemInCache | ( | TDesC & | aUrl | ) | [pure virtual] |
TDesC & aUrl | The Url |
IMPORT_C TSize | ContentSize | ( | ) | [pure virtual] |
IMPORT_C MWidgetExtension * | CreateWidgetExtensionL | ( | MWidgetCallback & | aWidgetCallback | ) | [pure virtual] |
MWidgetCallback & aWidgetCallback |
IMPORT_C int | FindKeyword | ( | const TDesC & | aKeyword | ) | [pure virtual] |
const TDesC & aKeyword | String to be find. |
IMPORT_C TBrCtlDefs::TBrCtlFindResponse | FindKeywordAgain | ( | TBool | aFowardDirection | ) | [pure virtual] |
Method that is called when the user searches for the next keyword in the doc.
TBool aFowardDirection | TRUE if search is in forword direction. For backword direction, it is FALSE. |
IMPORT_C TBrCtlDefs::TBrCtlElementType | FocusedElementType | ( | ) | [pure virtual] |
IMPORT_C TBrCtlImageCarrier * | FocusedImageLC | ( | ) | [pure virtual] |
IMPORT_C CGulIcon * | GetBitmapData | ( | const TDesC & | aUrl, |
TBrCtlDefs::TBrCtlBitmapInfo | aBitmapInfo | |||
) | [pure virtual] |
const TDesC & aUrl | url to a favicon or a page |
TBrCtlDefs::TBrCtlBitmapInfo aBitmapInfo | info on whether to retun a favicon or a page icon |
IMPORT_C void | HandleCommandL | ( | TInt | aCommand | ) | [pure virtual] |
TInt aCommand | The command that the Browser Control should process |
IMPORT_C void | HandleDownloadCommandL | ( | TUint16 | aTransId, |
TBrCtlDefs::TBrCtlDownloadCmd | aCommand | |||
) | [pure virtual] |
This method calls to download manager in order to send the commands (EDownloadCmdPause,DownloadCmdResume, EDownloadCmdCancel, EDownloadCmdMarkAsProgressive, EDownloadCmdMarkAsNotProgressive )
TUint16 aTransId | The transaction Id associated with this command |
TBrCtlDefs::TBrCtlDownloadCmd aCommand | The command that the Browser Control should process |
IMPORT_C TInt | ImageCountL | ( | ) | [pure virtual] |
IMPORT_C void | InitLoadDataL | ( | const TDesC & | aUrl, |
const TDataType & | aDataType, | |||
TUid | aCharsetUid, | |||
TUint | aContentLength, | |||
MBrCtlDataLoadSupplier * | aBrCtlDataLoadSupplier, | |||
MBrCtlDataLoadConsumer ** | aBrCtlDataLoadConsumer | |||
) | [pure virtual] |
const TDesC & aUrl | A url that refers to the data. If a url scheme is used, it must be "data:" |
const TDataType & aDataType | The data type of the data |
TUid aCharsetUid | The UID of the character converter of the content's charset 0 assumed Latin-1 |
TUint aContentLength | The length of the content. |
MBrCtlDataLoadSupplier * aBrCtlDataLoadSupplier | A callback interface to stop passing data if an error occured in the Browser Control |
MBrCtlDataLoadConsumer ** aBrCtlDataLoadConsumer | A callback interface returned by the browser. Data should be passed to that interface |
IMPORT_C TBool | IsUrlInCache | ( | TDesC & | aUrl | ) | [pure virtual] |
TDesC & aUrl | The Url |
IMPORT_C void | LoadDataL | ( | const TDesC & | aUrl, |
const TDesC8 & | aData, | |||
const TDataType & | aDataType, | |||
TUid | aCharsetUid | |||
) | [pure virtual] |
If you use this function, the Browser Control does not keep track of the history. If the data is not markup, Browser Control uses the Special Load Observer to pass the content back to the Host Application. The Special Load Observer uses the Document Handler to send the content to the proper application.
const TDesC & aUrl | A url that refers to the data. If a url scheme is used, it must be "data:" |
const TDesC8 & aData | The content to display. Browser Control does not take ownership |
const TDataType & aDataType | The data type of the data |
TUid aCharsetUid | The UID of the character converter of the content's charset 0 assumed Latin-1 |
IMPORT_C void | LoadFileL | ( | const TDesC & | aFileName | ) | [pure virtual] |
const TDesC & aFileName | The name of the file |
IMPORT_C void | LoadFileL | ( | RFile & | aFileHandle | ) | [pure virtual] |
RFile & aFileHandle | The handle of the file |
IMPORT_C void | LoadSavedPageL | ( | const TDesC & | aUid, |
TDesC & | aSavedPageBuffer | |||
) | [pure virtual] |
IMPORT_C void | LoadUrlL | ( | const TDesC & | aUrl, |
TInt | aApId = -1, | |||
TBrCtlDefs::TBrCtlCacheMode | aBrCtlCacheMode = TBrCtlDefs::ECacheModeNormal | |||
) | [pure virtual] |
const TDesC & aUrl | The url to load |
TInt aApId = -1 | The Access Point Id to use |
TBrCtlDefs::TBrCtlCacheMode aBrCtlCacheMode = TBrCtlDefs::ECacheModeNormal |
IMPORT_C TSize | MinimumSize | ( | ) | [pure virtual] |
This function is inherited from the Symbian CCoeControl class.
IMPORT_C TBool | NavigationAvailable | ( | TBrCtlDefs::TBrCtlNavigationDirection | aDirection | ) | [pure virtual] |
TBrCtlDefs::TBrCtlNavigationDirection aDirection | ENavigationBack if you wish to query whether there is a previous element in the history stack. ENavigationForward if you wish to query whether there is a subsequent element in the history stack. |
IMPORT_C TKeyResponse | OfferKeyEventL | ( | const TKeyEvent & | aKeyEvent, |
TEventCode | aType | |||
) | [pure virtual] |
This function is inherited from the Symbian CCoeControl class.
const TKeyEvent & aKeyEvent | The key event |
TEventCode aType | The key code |
IMPORT_C HBufC * | PageInfoLC | ( | TBrCtlDefs::TBrCtlPageInfo | aBrCtlPageInfo | ) | [pure virtual] |
The information is returned on the Cleanup stack.
TBrCtlDefs::TBrCtlPageInfo aBrCtlPageInfo | The type of requested info |
IMPORT_C void | PostUrlL | ( | const TDesC & | aUrl, |
const TDesC8 & | aContentType, | |||
const TDesC8 & | aPostData, | |||
const TDesC8 * | aBoundary, | |||
TAny * | aReserved | |||
) | [pure virtual] |
const TDesC & aUrl | URL to which the Browser Control sends the POST request |
const TDesC8 & aContentType | Content type of the data to be posted |
const TDesC8 & aPostData | Data to be posted |
const TDesC8 * aBoundary | Boundary for form-data or multi-part content. |
TAny * aReserved | For future use only |
IMPORT_C void | RemoveCommandObserver | ( | MBrCtlCommandObserver * | aBrCtlCommandObserver | ) | [pure virtual] |
MBrCtlCommandObserver * aBrCtlCommandObserver |
IMPORT_C void | RemoveLoadEventObserver | ( | MBrCtlLoadEventObserver * | aBrCtlLoadEventObserver | ) | [pure virtual] |
MBrCtlLoadEventObserver * aBrCtlLoadEventObserver | A load events observer to remove |
IMPORT_C void | RemoveStateChangeObserver | ( | MBrCtlStateChangeObserver * | aBrCtlStateChangeObserver | ) | [pure virtual] |
MBrCtlStateChangeObserver * aBrCtlStateChangeObserver |
IMPORT_C TUint16 | SaveToFileL | ( | const TDesC & | aFileName | ) | [pure virtual] |
const TDesC & aFileName | The name of the file to use for saving the content |
IMPORT_C void | SetBrowserSettingL | ( | TUint | aSetting, |
TUint | aValue | |||
) | [pure virtual] |
IMPORT_C void | SetFocus | ( | TBool | aFocus, |
TDrawNow | aDrawNow = ENoDrawNow | |||
) | [pure virtual] |
This function is inherited from the Symbian CCoeControl class.
TBool aFocus | If the Browser Control gets or loses focus |
TDrawNow aDrawNow = ENoDrawNow |
IMPORT_C void | SetParamL | ( | TBrCtlDefs::TBrCtlParams | aParam, |
const TDesC & | aValue | |||
) | [pure virtual] |
TBrCtlDefs::TBrCtlParams aParam | The parameter to update |
const TDesC & aValue | The new value of the parameter EParamsSelfDownoadableTypes: Pass a list of content types to the Browser Control. These content types will not be using the download manager. The list must be separated by ';' e.g. "text/html;text/wml" |
IMPORT_C void | SetSelfDownloadContentTypesL | ( | TDesC & | aContentTypes | ) | [pure virtual] |
TDesC & aContentTypes | The content types that should not use Download Manager |
IMPORT_C const RPointerArray < TBrCtlSubscribeTo > & | SubscribeToMenuItemsL | ( | ) | [pure virtual] |
IMPORT_C void | TakeSnapshotL | ( | CFbsBitmap & | snapshot | ) | [pure virtual] |
CFbsBitmap & snapshot |
IMPORT_C HBufC * | VersionInfoLC | ( | TBrCtlDefs::TBrCtlVersionInfo | aVersionInfo | ) | [pure virtual] |
The information is returned on the Cleanup Stack.
TBrCtlDefs::TBrCtlVersionInfo aVersionInfo | The type of requested info |
IMPORT_C RPointerArray < TBrCtlWmlServiceOption > * | WMLOptionMenuItemsL | ( | ) | [pure virtual] |
IMPORT_C RArray < TUint > * | ZoomLevels | ( | ) | const [pure virtual] |
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.