brctlinterface.h File 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 <e32std.h>
#include <e32base.h>
#include <coecntrl.h>
#include <eikmenup.h>
#include <ssl.h>
#include <BrCtlDialogsProvider.h>
#include <BrCtlLayoutObserver.h>
#include <BrCtlLinkResolver.h>
#include <BrCtlSoftkeysObserver.h>
#include <BrCtlSpecialLoadObserver.h>
#include <BrCtlWindowObserver.h>
#include <BrCtlDownloadObserver.h>
#include <BrCtlDefs.h>

Go to the source code of this file.


Data Structures
class	CBrCtlInterface
	The CBrCtlInterface class is the base class of the Browser Control API. More...
class	MBrCtlDataLoadSupplier
	The MBrCtlDataLoadSupplier class is a callback interface that provides the Browser Control with the ability to display content incrementally. More...
class	MBrCtlDataLoadConsumer
	The MBrCtlDataLoadConsumer class is a callback interface that provides the Browser Control with the ability to receive content incrementally. More...
class	MBrCtlLoadEventObserver
	The MBrCtlLoadEventObserver interface receives load progress events. More...
class	TBrCtlWmlServiceOption
	The TBrCtlWmlServiceOption class wraps information about the WML DO elements. More...
class	TBrCtlSubscribeTo
	The TBrCtlSubscribeTo class provides information of Subscribe to items. More...
class	MBrCtlStateChangeObserver
	The MBrCtlStateChangeObserver class receives state-changed events. More...
class	MBrCtlCommandObserver
	This class provides a mechanism for the browser engine to pass commands to the client. More...
class	MWidgetCallback
	This class provides a mechanism for the browser engine to interact with the widget host application. More...
class	MWidgetExtension
	This class provides an extension mechanism for the widget host app to interact with the browser engine This class includes the Widget specific extension needed in the browser engine. More...
Functions
IMPORT_C CBrCtlInterface *	CreateBrowserControlL (CCoeControl aParent, TRect aRect, TUint aBrCtlCapabilities, TUint aCommandIdBase=TBrCtlDefs::ECommandIdBase, MBrCtlSoftkeysObserver aBrCtlSoftkeysObserver=NULL, MBrCtlLinkResolver aBrCtlLinkResolver=NULL, MBrCtlSpecialLoadObserver aBrCtlSpecialLoadObserver=NULL, MBrCtlLayoutObserver aBrCtlLayoutObserver=NULL, MBrCtlDialogsProvider aBrCtlDialogsProvider=NULL, MBrCtlWindowObserver aBrCtlWindowObserver=NULL, MBrCtlDownloadObserver aBrCtlDownloadObserver=NULL)
	Creates the browser control.

Function Documentation

IMPORT_C CBrCtlInterface* CreateBrowserControlL	(	CCoeControl *	aParent,
		TRect	aRect,
		TUint	aBrCtlCapabilities,
		TUint	aCommandIdBase = `TBrCtlDefs::ECommandIdBase`,
		MBrCtlSoftkeysObserver *	aBrCtlSoftkeysObserver = `NULL`,
		MBrCtlLinkResolver *	aBrCtlLinkResolver = `NULL`,
		MBrCtlSpecialLoadObserver *	aBrCtlSpecialLoadObserver = `NULL`,
		MBrCtlLayoutObserver *	aBrCtlLayoutObserver = `NULL`,
		MBrCtlDialogsProvider *	aBrCtlDialogsProvider = `NULL`,
		MBrCtlWindowObserver *	aBrCtlWindowObserver = `NULL`,
		MBrCtlDownloadObserver *	aBrCtlDownloadObserver = `NULL`
	)

Creates the browser control.

Parameters:

	aParent	Parent window of the browser control
	aRect	Bounding rectangle for the browser control
	aBrCtlCapabilities	Desired capabilities of the browser control. For example, displaying scroll bars, allowing network access for HTTP requests.

See also:: For a complete list of capability options, see TBrCtlCapabilities

Parameters:

aCommandIdBase

Base values for Command IDs for Browser Control. These are added to ensure that each Command ID is unique; Browser Control command IDs must be different from the host application command IDs.

See also:: For more information, see TBrCtlCommandId

Parameters:

aBrCtlSoftkeysObserver

Softkeys observer. Default: the host application does not update the softkeys.

See also:: For more information, see MBrCtlSoftkeysObserver class

Parameters:

aBrCtlLinkResolver

Link Resolver. Must be provided if ECapabilityClient ResolveEmbeddedURL or ECapabilityClientNotifyURL is set.

See also:: For more information, see MBrCtlLinkResolver class.

Parameters:

aBrCtlSpecialLoadObserver

Special Load Observer.

See also:: MBrCtlSpecialLoadObserver class for more details of special load observer.

Parameters:

aBrCtlLayoutObserver

Layout Observer. Default: Non-markup pages are not handled by the browser. Non-HTTP(S) schemes are not handled by the browser. Connection is created by the Proxy Filter.

See also:: For more information, see MBrCtlLayoutObserver class

Parameters:

aBrCtlDialogsProvider

Dialogs Provider.

See also:: For more information, see MBrCtlDialogsProvider class

Parameters:

aBrCtlWindowObserver

Window Observer.

See also:: For more information, see MBrCtlWindowObserver class

Parameters:

aBrCtlDownloadObserver

Downlaod observer

See also:: For more information, MBrCtlDownloadObserver class

Returns:: a pointer to CBrCtlInterface class or NULL if this function fails.

brctlinterface.h File Reference

Capability Information

Data Structures

Functions

Function Documentation