#include <mw/brctlinterface.h>
class CBrCtlInterface : public CCoeControl |
Inherited Attributes | |
---|---|
CCoeControl::iCoeEnv | |
CCoeControl::iContext | |
CCoeControl::iPosition | |
CCoeControl::iSize |
Inherited Enumerations | |
---|---|
CCoeControl:TZoomType |
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*
IMPORT_C void | AddCommandObserverL | ( | MBrCtlCommandObserver * | aBrCtlCommandObserver | ) | [pure virtual] |
Returns: void
IMPORT_C void | AddLoadEventObserverL | ( | MBrCtlLoadEventObserver * | aBrCtlLoadEventObserver | ) | [pure virtual] |
Parameter | Description |
---|---|
aBrCtlLoadEventObserver | A load events observer to add |
Returns: void Call this function immediately after creating the Browser Control. For multiple registrations, the host application may call this function more than once. Observers must unregister before deleting the Browser Control.
IMPORT_C void | AddOptionMenuItemsL | ( | CEikMenuPane & | aMenuPane, |
TInt | aResourceId, | |||
TInt | aAfter = -1 | |||
) | [pure virtual] |
Parameter | Description |
---|---|
aMenuPane | Handle of the menu that will contain the options |
aResourceId | The resource ID of the menu |
aAfter | WML options should be added after that index |
Returns: void
IMPORT_C void | AddStateChangeObserverL | ( | MBrCtlStateChangeObserver * | aBrCtlStateChangeObserver | ) | [pure virtual] |
Parameter | Description |
---|---|
aBrCtlStateChangeObserver | The observer to register |
Returns: void The Observer must unregister before deleting the Browser Control.
IMPORT_C const TCertInfo * | CertInfo | ( | ) | [pure virtual] |
Returns: Certificate info of the server of the current page
IMPORT_C TUint | ClearCache | ( | ) | [pure virtual] |
Returns: The number of bytes that were freed from cache.
IMPORT_C TSize | ContentSize | ( | ) | [pure virtual] |
Returns: The display size that would be needed to see all the content
IMPORT_C MWidgetExtension * | CreateWidgetExtensionL | ( | MWidgetCallback & | aWidgetCallback | ) | [pure virtual] |
Returns: void
IMPORT_C int | FindKeyword | ( | const TDesC & | aKeyword | ) | [pure virtual] |
Parameter | Description |
---|---|
aKeyword | String to be find. |
Returns: TBrCtlFindResponse
IMPORT_C TBrCtlDefs::TBrCtlFindResponse | FindKeywordAgain | ( | TBool | aFowardDirection | ) | [pure virtual] |
Method that is called when the user searches for the next keyword in the doc.
Parameter | Description |
---|---|
aFowardDirection | TRUE if search is in forword direction. For backword direction, it is FALSE. |
Returns: TBrCtlFindResponse
IMPORT_C TBrCtlDefs::TBrCtlElementType | FocusedElementType | ( | ) | [pure virtual] |
Returns: The type of the focused element The host application may need to perform special processing, such as updating the softkeys, when a specific element has the focus.
IMPORT_C TBrCtlImageCarrier * | FocusedImageLC | ( | ) | [pure virtual] |
IMPORT_C CGulIcon * | GetBitmapData | ( | const TDesC & | aUrl, |
TBrCtlDefs::TBrCtlBitmapInfo | aBitmapInfo | |||
) | [pure virtual] |
Parameter | Description |
---|---|
aUrl | url to a favicon or a page |
aBitmapInfo | info on whether to retun a favicon or a page icon |
Returns: favion icon or page icon
IMPORT_C void | HandleCommandL | ( | TInt | aCommand | ) | [pure virtual] |
See also: TBrCtlCommands, For a complete list of commands,
Parameter | Description |
---|---|
aCommand | The command that the Browser Control should process |
Returns: void
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 )
Parameter | Description |
---|---|
aTransId | The transaction Id associated with this command |
aCommand | The command that the Browser Control should process |
Returns: void
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] |
Parameter | Description |
---|---|
aUrl | A url that refers to the data. If a url scheme is used, it must be "data:" |
aDataType | The data type of the data |
aCharsetUid | The UID of the character converter of the content's charset 0 assumed Latin-1 |
aContentLength | The length of the content. |
aBrCtlDataLoadSupplier | A callback interface to stop passing data if an error occured in the Browser Control |
aBrCtlDataLoadConsumer | A callback interface returned by the browser. Data should be passed to that interface |
Returns: void If you use this function, the Browser Control does not keep track of the history.If the content type of 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.
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.
Parameter | Description |
---|---|
aUrl | A url that refers to the data. If a url scheme is used, it must be "data:" |
aData | The content to display. Browser Control does not take ownership |
aDataType | The data type of the data |
aCharsetUid | The UID of the character converter of the content's charset 0 assumed Latin-1 |
Returns: void
IMPORT_C void | LoadFileL | ( | const TDesC & | aFileName | ) | [pure virtual] |
Parameter | Description |
---|---|
aFileName | The name of the file |
Returns: void
IMPORT_C void | LoadFileL | ( | RFile & | aFileHandle | ) | [pure virtual] |
Parameter | Description |
---|---|
aFileHandle | The handle of the file |
Returns: void
IMPORT_C void | LoadUrlL | ( | const TDesC & | aUrl, |
TInt | aApId = -1, | |||
TBrCtlDefs::TBrCtlCacheMode | aBrCtlCacheMode = TBrCtlDefs::ECacheModeNormal | |||
) | [pure virtual] |
See also: For a description of each of these values, see TBrCtlCacheMode
Parameter | Description |
---|---|
aUrl | The url to load |
aApId | The Access Point Id to use |
Returns: void
IMPORT_C TSize | MinimumSize | ( | ) | [pure virtual] |
Reimplemented from CCoeControl::MinimumSize()
This function is inherited from the Symbian CCoeControl class.
Returns: The minimum size that the Browser Control can use.
IMPORT_C TBool | NavigationAvailable | ( | TBrCtlDefs::TBrCtlNavigationDirection | aDirection | ) | [pure virtual] |
Parameter | Description |
---|---|
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. |
Returns: ETrue if can go aDirection, EFalse otherwise
IMPORT_C TKeyResponse | OfferKeyEventL | ( | const TKeyEvent & | aKeyEvent, |
TEventCode | aType | |||
) | [pure virtual] |
Reimplemented from CCoeControl::OfferKeyEventL(const TKeyEvent &,TEventCode)
This function is inherited from the Symbian CCoeControl class.
Parameter | Description |
---|---|
aKeyEvent | The key event |
aType | The key code |
Returns: If the Browser Control consumed the key event or not
IMPORT_C HBufC * | PageInfoLC | ( | TBrCtlDefs::TBrCtlPageInfo | aBrCtlPageInfo | ) | [pure virtual] |
The information is returned on the Cleanup stack.
Parameter | Description |
---|---|
aBrCtlPageInfo | The type of requested info |
Returns: A descriptor containing the requested page info
IMPORT_C void | PostUrlL | ( | const TDesC & | aUrl, |
const TDesC8 & | aContentType, | |||
const TDesC8 & | aPostData, | |||
const TDesC8 * | aBoundary, | |||
TAny * | aReserved | |||
) | [pure virtual] |
Parameter | Description |
---|---|
aUrl | URL to which the Browser Control sends the POST request |
aContentType | Content type of the data to be posted |
aPostData | Data to be posted |
aBoundary | Boundary for form-data or multi-part content. |
aReserved | For future use only |
Returns: void
IMPORT_C void | RemoveCommandObserver | ( | MBrCtlCommandObserver * | aBrCtlCommandObserver | ) | [pure virtual] |
Returns: void
IMPORT_C void | RemoveLoadEventObserver | ( | MBrCtlLoadEventObserver * | aBrCtlLoadEventObserver | ) | [pure virtual] |
Parameter | Description |
---|---|
aBrCtlLoadEventObserver | A load events observer to remove |
Returns: void Call this function for each Load Observer that was previously registered.
IMPORT_C void | RemoveStateChangeObserver | ( | MBrCtlStateChangeObserver * | aBrCtlStateChangeObserver | ) | [pure virtual] |
Returns: void
Reimplemented from CCoeControl::SetFocus(TBool,TDrawNow)
This function is inherited from the Symbian CCoeControl class.
Parameter | Description |
---|---|
aFocus | If the Browser Control gets or loses focus |
Returns: void
IMPORT_C void | SetParamL | ( | TBrCtlDefs::TBrCtlParams | aParam, |
const TDesC & | aValue | |||
) | [pure virtual] |
Parameter | Description |
---|---|
aParam | The parameter to update |
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" |
Returns: void
IMPORT_C void | SetSelfDownloadContentTypesL | ( | TDesC & | aContentTypes | ) | [pure virtual] |
Parameter | Description |
---|---|
aContentTypes | The content types that should not use Download Manager |
Returns: void
IMPORT_C const RPointerArray< TBrCtlSubscribeTo > & | SubscribeToMenuItemsL | ( | ) | [pure virtual] |
Returns: Information about the linked feeds in the current page. The caller adopts the result.
IMPORT_C void | TakeSnapshotL | ( | CFbsBitmap & | snapshot | ) | [pure virtual] |
Returns: void.
IMPORT_C HBufC * | VersionInfoLC | ( | TBrCtlDefs::TBrCtlVersionInfo | aVersionInfo | ) | [pure virtual] |
The information is returned on the Cleanup Stack.
Parameter | Description |
---|---|
aVersionInfo | The type of requested info |
Returns: A descriptor containing the requested page info
IMPORT_C RPointerArray< TBrCtlWmlServiceOption > * | WMLOptionMenuItemsL | ( | ) | [pure virtual] |