CBrCtlInterface Class Reference

#include <mw/brctlinterface.h>

class CBrCtlInterface : public CCoeControl

Inherits from

Public Member Functions
virtual ~CBrCtlInterface()
pure virtual IMPORT_C voidAddCommandObserverL(MBrCtlCommandObserver *)
pure virtual IMPORT_C voidAddLoadEventObserverL(MBrCtlLoadEventObserver *)
pure virtual IMPORT_C voidAddOptionMenuItemsL(CEikMenuPane &, TInt, TInt)
pure virtual IMPORT_C voidAddStateChangeObserverL(MBrCtlStateChangeObserver *)
pure virtual IMPORT_C TUintBrowserSettingL(TUint)
pure virtual IMPORT_C const TCertInfo *CertInfo()
pure virtual IMPORT_C TUintClearCache()
pure virtual IMPORT_C TIntClearItemInCache(TDesC &)
pure virtual IMPORT_C TSizeContentSize()
pure virtual IMPORT_C MWidgetExtension *CreateWidgetExtensionL(MWidgetCallback &)
pure virtual IMPORT_C intFindKeyword(const TDesC &)
pure virtual IMPORT_C TBrCtlDefs::TBrCtlFindResponseFindKeywordAgain(TBool)
pure virtual IMPORT_C TBrCtlDefs::TBrCtlElementTypeFocusedElementType()
pure virtual IMPORT_C TBrCtlImageCarrier *FocusedImageLC()
pure virtual IMPORT_C CGulIcon *GetBitmapData(const TDesC &, TBrCtlDefs::TBrCtlBitmapInfo)
pure virtual IMPORT_C voidHandleCommandL(TInt)
pure virtual IMPORT_C voidHandleDownloadCommandL(TUint16, TBrCtlDefs::TBrCtlDownloadCmd)
pure virtual IMPORT_C TIntImageCountL()
pure virtual IMPORT_C voidInitLoadDataL(const TDesC &, const TDataType &, TUid, TUint, MBrCtlDataLoadSupplier *, MBrCtlDataLoadConsumer **)
pure virtual IMPORT_C TBoolIsSynchRequestPending()
pure virtual IMPORT_C TBoolIsUrlInCache(TDesC &)
pure virtual IMPORT_C voidLoadDataL(const TDesC &, const TDesC8 &, const TDataType &, TUid)
pure virtual IMPORT_C voidLoadFileL(const TDesC &)
pure virtual IMPORT_C voidLoadFileL(RFile &)
pure virtual IMPORT_C voidLoadSavedPageL(const TDesC &, TDesC &)
pure virtual IMPORT_C voidLoadUrlL(const TDesC &, TInt, TBrCtlDefs::TBrCtlCacheMode)
pure virtual IMPORT_C TSizeMinimumSize()
pure virtual IMPORT_C TBoolNavigationAvailable(TBrCtlDefs::TBrCtlNavigationDirection)
pure virtual IMPORT_C TKeyResponseOfferKeyEventL(const TKeyEvent &, TEventCode)
pure virtual IMPORT_C TBoolOkToExit()
pure virtual IMPORT_C HBufC *PageInfoLC(TBrCtlDefs::TBrCtlPageInfo)
pure virtual IMPORT_C voidPostUrlL(const TDesC &, const TDesC8 &, const TDesC8 &, const TDesC8 *, TAny *)
pure virtual IMPORT_C voidRemoveCommandObserver(MBrCtlCommandObserver *)
pure virtual IMPORT_C voidRemoveLoadEventObserver(MBrCtlLoadEventObserver *)
pure virtual IMPORT_C voidRemoveStateChangeObserver(MBrCtlStateChangeObserver *)
pure virtual IMPORT_C TUint16SaveToFileL(const TDesC &)
pure virtual IMPORT_C voidSetBrowserSettingL(TUint, TUint)
pure virtual IMPORT_C voidSetFocus(TBool, TDrawNow)
pure virtual IMPORT_C voidSetParamL(TBrCtlDefs::TBrCtlParams, const TDesC &)
pure virtual IMPORT_C voidSetSelfDownloadContentTypesL(TDesC &)
pure virtual IMPORT_C const RPointerArray< TBrCtlSubscribeTo > &SubscribeToMenuItemsL()
pure virtual IMPORT_C voidTakeSnapshotL(CFbsBitmap &)
pure virtual IMPORT_C HBufC *VersionInfoLC(TBrCtlDefs::TBrCtlVersionInfo)
pure virtual IMPORT_C RPointerArray< TBrCtlWmlServiceOption > *WMLOptionMenuItemsL()
pure virtual IMPORT_C RArray< TUint > *ZoomLevels()
Inherited Attributes
CCoeControl::iCoeEnv
CCoeControl::iContext
CCoeControl::iPosition
CCoeControl::iSize
Inherited Enumerations
CCoeControl:TEventDataConfig
CCoeControl:TPrepareType
CCoeControl:TZoomType
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
CCoeControl::AccumulatedZoom()const
CCoeControl::ActivateGc()const
CCoeControl::ActivateL()
CCoeControl::BackedUpWindow()const
CCoeControl::Background()const
CCoeControl::CCoeControl()
CCoeControl::CCoeControl(CCoeEnv *)
CCoeControl::CCoeControl(const CCoeControl &)
CCoeControl::CapturesPointer()const
CCoeControl::ClaimPointerGrab(TBool)
CCoeControl::ClaimPointerGrab(TInt,TBool)
CCoeControl::CloseWindow()
CCoeControl::ComponentArrayExists()const
CCoeControl::ComponentControl(TInt)const
CCoeControl::Components()
CCoeControl::Components()const
CCoeControl::ConfigureEventData(TInt)
CCoeControl::ConstructFromResourceL(TResourceReader &)
CCoeControl::ControlContext()const
CCoeControl::ControlEnv()const
CCoeControl::CopyControlContextFrom(const CCoeControl *)
CCoeControl::CountComponentControls()const
CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &)
CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &,TDisplayMode)
CCoeControl::CreateWindowL()
CCoeControl::CreateWindowL(RWindowGroup *)
CCoeControl::CreateWindowL(RWindowTreeNode &)
CCoeControl::CreateWindowL(const CCoeControl *)
CCoeControl::CustomGc()const
CCoeControl::DeactivateGc()const
CCoeControl::DrawBackground(const TRect &)const
CCoeControl::DrawDeferred()const
CCoeControl::DrawForeground(const TRect &)const
CCoeControl::DrawNow()const
CCoeControl::DrawNow(const TRect &)const
CCoeControl::DrawableWindow()const
CCoeControl::EnableDragEvents()
CCoeControl::EnableReportControlStateChange(TBool)
CCoeControl::EnableWindowTransparency()
CCoeControl::EventDataConfiguration()const
CCoeControl::FindBackground()const
CCoeControl::FindFontProvider()const
CCoeControl::FocusChanged(TDrawNow)
CCoeControl::GetColor(TInt,TRgb &)const
CCoeControl::GetColorUseListL(CArrayFix< TCoeColorUse > &)const
CCoeControl::GetGc()const
CCoeControl::GetHelpContext(TCoeHelpContext &)const
CCoeControl::GrabbingComponent()const
CCoeControl::GrabbingComponent(TInt)const
CCoeControl::HandleComponentControlsResourceChange(TInt)
CCoeControl::HandleControlArrayEventL(CCoeControlArray::TEvent,const CCoeControlArray *,CCoeControl *,TInt)
CCoeControl::HandlePointerBufferReadyL()
CCoeControl::HandlePointerEventL(const TPointerEvent &)
CCoeControl::HandleRedrawEvent(const TRect &)const
CCoeControl::HandleResourceChange(TInt)
CCoeControl::HasBorder()const
CCoeControl::HitTest()const
CCoeControl::IgnoreEventsUntilNextPointerUp()
CCoeControl::Index(const CCoeControl *)const
CCoeControl::InitComponentArrayL()
CCoeControl::InputCapabilities()const
CCoeControl::IsActivated()const
CCoeControl::IsBackedUp()const
CCoeControl::IsBeingDestroyed()const
CCoeControl::IsBlank()const
CCoeControl::IsDimmed()const
CCoeControl::IsFocused()const
CCoeControl::IsNonFocusing()const
CCoeControl::IsReadyToDraw()const
CCoeControl::IsSemiTransparent()const
CCoeControl::IsVisible()const
CCoeControl::LayoutManager()const
CCoeControl::MakeVisible(TBool)
CCoeControl::MaximumWidth()const
CCoeControl::MopSupplyObject(TTypeUid)
CCoeControl::NotifyFontChange(const CCoeFontProvider *)
CCoeControl::Observer()const
CCoeControl::OverrideColorL(TInt,TRgb)
CCoeControl::OwnsWindow()const
CCoeControl::Parent()
CCoeControl::Parent()const
CCoeControl::Position()const
CCoeControl::PositionChanged()
CCoeControl::PositionRelativeToScreen()const
CCoeControl::PrepareForFocusGainL()
CCoeControl::PrepareForFocusLossL()
CCoeControl::ProcessPointerBufferReadyL()
CCoeControl::ProcessPointerEventL(const TPointerEvent &)
CCoeControl::Rect()const
CCoeControl::RecursivelyMergeInputCapabilities(TCoeInputCapabilities &)const
CCoeControl::RecursivelyMergedInputCapabilities()const
CCoeControl::RefetchPixelMappingL()
CCoeControl::RemoveFromParent()
CCoeControl::ReportEventL(MCoeControlObserver::TCoeEvent)
CCoeControl::RequestRelayout(const CCoeControl *)
CCoeControl::ResetGc()const
CCoeControl::ScreenFont(const TCoeFont &)const
CCoeControl::SetAdjacent(TInt)
CCoeControl::SetAllowStrayPointers()
CCoeControl::SetBackground(const MCoeControlBackground *)
CCoeControl::SetBlank()
CCoeControl::SetCanDrawOutsideRect()
CCoeControl::SetComponentsToInheritVisibility(TBool)
CCoeControl::SetContainerWindowL(RBackedUpWindow &)
CCoeControl::SetContainerWindowL(RWindow &)
CCoeControl::SetContainerWindowL(const CCoeControl &)
CCoeControl::SetControlContext(MCoeControlContext *)
CCoeControl::SetCornerAndSize(TGulAlignment,const TSize &)
CCoeControl::SetCustomGc(CWindowGc *)
CCoeControl::SetDimmed(TBool)
CCoeControl::SetExtent(const TPoint &,const TSize &)
CCoeControl::SetExtentToWholeScreen()
CCoeControl::SetFocusing(TBool)
CCoeControl::SetFontProviderL(const CCoeFontProvider &)
CCoeControl::SetGc(CWindowGc *)const
CCoeControl::SetGloballyCapturing(TBool)
CCoeControl::SetHitTest(const MCoeControlHitTest *)
CCoeControl::SetLayoutManagerL(MCoeLayoutManager *)
CCoeControl::SetMaximumWidth(TInt)
CCoeControl::SetMopParent(MObjectProvider *)
CCoeControl::SetNeighbor(CCoeControl *)
CCoeControl::SetNonFocusing()
CCoeControl::SetObserver(MCoeControlObserver *)
CCoeControl::SetParent(CCoeControl *)
CCoeControl::SetPointerCapture(TBool)
CCoeControl::SetPosition(const TPoint &)
CCoeControl::SetRect(const TRect &)
CCoeControl::SetSize(const TSize &)
CCoeControl::SetSizeWithoutNotification(const TSize &)
CCoeControl::SetTextBaselineSpacing(TInt)
CCoeControl::SetUniqueHandle(TInt)
CCoeControl::SetZoomFactorL(TInt,TZoomType)
CCoeControl::Size()const
CCoeControl::SizeChanged()
CCoeControl::SystemGc()const
CCoeControl::TextBaselineOffset(const TSize &)const
CCoeControl::TextDrawer(TInt)const
CCoeControl::UniqueHandle()const
CCoeControl::Window()const
CCoeControl::WriteInternalStateL(RWriteStream &)const
CCoeControl::WriteInternalStateNowL(RWriteStream &)const
CCoeControl::ZoomWithType()const
CCoeControl::operator=(const CCoeControl &)
CCoeControl::~CCoeControl()
MObjectProvider::FindParent(MObjectProvider *)
MObjectProvider::MObjectProvider()
MObjectProvider::MopGetObject(T *&)
MObjectProvider::MopGetObjectNoChaining(T *&)

Detailed Description

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
*

Constructor & Destructor Documentation

~CBrCtlInterface ( )

~CBrCtlInterface()[inline, virtual]

Destructor.

Member Function Documentation

AddCommandObserverL ( MBrCtlCommandObserver * )

IMPORT_C voidAddCommandObserverL(MBrCtlCommandObserver *aBrCtlCommandObserver)[pure virtual]
Register a client command interface for the browser engine
Since
3.1
Return Value
void

AddLoadEventObserverL ( MBrCtlLoadEventObserver * )

IMPORT_C voidAddLoadEventObserverL(MBrCtlLoadEventObserver *aBrCtlLoadEventObserver)[pure virtual]
Request the Browser Control to register for load events
Since
2.8
Parameters
aBrCtlLoadEventObserverA load events observer to add
Return Value
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.

AddOptionMenuItemsL ( CEikMenuPane &, TInt, TInt )

IMPORT_C voidAddOptionMenuItemsL(CEikMenuPane &aMenuPane,
TIntaResourceId,
TIntaAfter = -1
)[pure virtual]
Request the Browser Control to add its own options to the option menu
Since
2.8
Parameters
aMenuPaneHandle of the menu that will contain the options
aResourceIdThe resource ID of the menu
aAfterWML options should be added after that index
Return Value
void

AddStateChangeObserverL ( MBrCtlStateChangeObserver * )

IMPORT_C voidAddStateChangeObserverL(MBrCtlStateChangeObserver *aBrCtlStateChangeObserver)[pure virtual]
Register an observer for state changes
Since
2.8
Parameters
aBrCtlStateChangeObserverThe observer to register
Return Value
void The Observer must unregister before deleting the Browser Control.

BrowserSettingL ( TUint )

IMPORT_C TUintBrowserSettingL(TUintaSetting)[pure virtual]
Get a setting from the Browser Control
Since
2.8
Parameters
aSettingThe setting to get
Return Value
The value of the setting
Leave Codes
KErrArgumentif the value of aSetting is out of range.

CertInfo ( )

IMPORT_C const TCertInfo *CertInfo()[pure virtual]
Request the Browser Control to pass the server's certificate info for the current page
Since
2.8
Return Value
Certificate info of the server of the current page

ClearCache ( )

IMPORT_C TUintClearCache()[pure virtual]
Request the Browser Control to clear the cache
Since
2.8
Return Value
The number of bytes that were freed from cache.

ClearItemInCache ( TDesC & )

IMPORT_C TIntClearItemInCache(TDesC &aUrl)[pure virtual]
Ask the Browser Control to clear a URL from the cache
Since
2.8
Parameters
aUrlThe Url
Return Value
KErrNone if the URL is cleared from the cache Error message is the URL has not been cleared.

ContentSize ( )

IMPORT_C TSizeContentSize()[pure virtual]
Return the display size that would be needed to see all the content
Since
2.8
Return Value
The display size that would be needed to see all the content

CreateWidgetExtensionL ( MWidgetCallback & )

IMPORT_C MWidgetExtension *CreateWidgetExtensionL(MWidgetCallback &aWidgetCallback)[pure virtual]
Unregister a client command interface for the browser engine
Since
3.1
Return Value
void

FindKeyword ( const TDesC & )

IMPORT_C intFindKeyword(const TDesC &aKeyword)[pure virtual]
Perform the incremental find operation
Since
3.0
Parameters
aKeywordString to be find.
Return Value
TBrCtlFindResponse

FindKeywordAgain ( TBool )

IMPORT_C TBrCtlDefs::TBrCtlFindResponseFindKeywordAgain(TBoolaFowardDirection)[pure virtual]
Continue the incremental find operation
Since
3.0
Attention:

Method that is called when the user searches for the next keyword in the doc.

Parameters
aFowardDirectionTRUE if search is in forword direction. For backword direction, it is FALSE.
Return Value
TBrCtlFindResponse

FocusedElementType ( )

IMPORT_C TBrCtlDefs::TBrCtlElementTypeFocusedElementType()[pure virtual]
Returns the focused element
Since
2.8
Return Value
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.

FocusedImageLC ( )

IMPORT_C TBrCtlImageCarrier *FocusedImageLC()[pure virtual]
Get information about the focused image. The function leaves if the focus is not on an image
Since
3.2

GetBitmapData ( const TDesC &, TBrCtlDefs::TBrCtlBitmapInfo )

IMPORT_C CGulIcon *GetBitmapData(const TDesC &aUrl,
TBrCtlDefs::TBrCtlBitmapInfoaBitmapInfo
)[pure virtual]
Request icon for the given url
Since
3.1
Parameters
aUrlurl to a favicon or a page
aBitmapInfoinfo on whether to retun a favicon or a page icon
Return Value
favion icon or page icon

HandleCommandL ( TInt )

IMPORT_C voidHandleCommandL(TIntaCommand)[pure virtual]
Passes a command to the Browser Control..
Since
2.8

See also: TBrCtlCommands, For a complete list of commands,

Parameters
aCommandThe command that the Browser Control should process
Return Value
void

HandleDownloadCommandL ( TUint16, TBrCtlDefs::TBrCtlDownloadCmd )

IMPORT_C voidHandleDownloadCommandL(TUint16aTransId,
TBrCtlDefs::TBrCtlDownloadCmdaCommand
)[pure virtual]

This method calls to download manager in order to send the commands (EDownloadCmdPause,DownloadCmdResume, EDownloadCmdCancel, EDownloadCmdMarkAsProgressive, EDownloadCmdMarkAsNotProgressive )

Parameters
aTransIdThe transaction Id associated with this command
aCommandThe command that the Browser Control should process
Return Value
void

ImageCountL ( )

IMPORT_C TIntImageCountL()[pure virtual]
Return the number of images in the current page
Since
2.8

InitLoadDataL ( const TDesC &, const TDataType &, TUid, TUint, MBrCtlDataLoadSupplier *, MBrCtlDataLoadConsumer ** )

IMPORT_C voidInitLoadDataL(const TDesC &aUrl,
const TDataType &aDataType,
TUidaCharsetUid,
TUintaContentLength,
MBrCtlDataLoadSupplier *aBrCtlDataLoadSupplier,
MBrCtlDataLoadConsumer **aBrCtlDataLoadConsumer
)[pure virtual]
Request the Browser Control to display content incrementaly
Since
2.8
Parameters
aUrlA url that refers to the data. If a url scheme is used, it must be "data:"
aDataTypeThe data type of the data
aCharsetUidThe UID of the character converter of the content's charset 0 assumed Latin-1
aContentLengthThe length of the content.
aBrCtlDataLoadSupplierA callback interface to stop passing data if an error occured in the Browser Control
aBrCtlDataLoadConsumerA callback interface returned by the browser. Data should be passed to that interface
Return Value
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.

IsSynchRequestPending ( )

IMPORT_C TBoolIsSynchRequestPending()[pure virtual]

IsUrlInCache ( TDesC & )

IMPORT_C TBoolIsUrlInCache(TDesC &aUrl)[pure virtual]
Ask the Browser Control if a URL is in cache
Since
2.8
Parameters
aUrlThe Url
Return Value
ETrue, if a specific Url is in cache EFalse if the URL is not in the cache

LoadDataL ( const TDesC &, const TDesC8 &, const TDataType &, TUid )

IMPORT_C voidLoadDataL(const TDesC &aUrl,
const TDesC8 &aData,
const TDataType &aDataType,
TUidaCharsetUid
)[pure virtual]
Request the Browser Control to display the content of a buffer
Since
2.8
Attention:

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.

Parameters
aUrlA url that refers to the data. If a url scheme is used, it must be "data:"
aDataThe content to display. Browser Control does not take ownership
aDataTypeThe data type of the data
aCharsetUidThe UID of the character converter of the content's charset 0 assumed Latin-1
Return Value
void

LoadFileL ( const TDesC & )

IMPORT_C voidLoadFileL(const TDesC &aFileName)[pure virtual]
Request the Browser Control to load and display a file from the file system
Since
2.8
Parameters
aFileNameThe name of the file
Return Value
void

LoadFileL ( RFile & )

IMPORT_C voidLoadFileL(RFile &aFileHandle)[pure virtual]
Request the Browser Control to load and display a file from the file system
Since
2.8
Parameters
aFileHandleThe handle of the file
Return Value
void

LoadSavedPageL ( const TDesC &, TDesC & )

IMPORT_C voidLoadSavedPageL(const TDesC &aUid,
TDesC &aSavedPageBuffer
)[pure virtual]
Request the Browser Control to load a saved page.
Since
3.0
Parameters
aUida unique identifier for the saved page
aSavedPageBufferbuffer which contains the content of the saved page
Return Value
void

LoadUrlL ( const TDesC &, TInt, TBrCtlDefs::TBrCtlCacheMode )

IMPORT_C voidLoadUrlL(const TDesC &aUrl,
TIntaApId = -1,
TBrCtlDefs::TBrCtlCacheModeaBrCtlCacheMode = TBrCtlDefs::ECacheModeNormal
)[pure virtual]
Request the Browser Control to load a url
Since
2.8

See also: For a description of each of these values, see TBrCtlCacheMode

Parameters
aUrlThe url to load
aApIdThe Access Point Id to use
Return Value
void

MinimumSize ( )

IMPORT_C TSizeMinimumSize()[pure virtual]

Reimplemented from CCoeControl::MinimumSize()

From CCoeControl Return the minimum size the Browser Control can use
Since
2.8
Attention:

This function is inherited from the Symbian CCoeControl class.

Return Value
The minimum size that the Browser Control can use.

NavigationAvailable ( TBrCtlDefs::TBrCtlNavigationDirection )

IMPORT_C TBoolNavigationAvailable(TBrCtlDefs::TBrCtlNavigationDirectionaDirection)[pure virtual]
From CBrCtlInterface Query the Browser Control if there is a previous or next (depending on aDirection) element in history stack
Since
2.8
Parameters
aDirectionENavigationBack 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.
Return Value
ETrue if can go aDirection, EFalse otherwise

OfferKeyEventL ( const TKeyEvent &, TEventCode )

IMPORT_C TKeyResponseOfferKeyEventL(const TKeyEvent &aKeyEvent,
TEventCodeaType
)[pure virtual]
From CCoeControl Pass key events to the Browser Control
Since
2.8
Attention:

This function is inherited from the Symbian CCoeControl class.

Parameters
aKeyEventThe key event
aTypeThe key code
Return Value
If the Browser Control consumed the key event or not

OkToExit ( )

IMPORT_C TBoolOkToExit()[pure virtual]

PageInfoLC ( TBrCtlDefs::TBrCtlPageInfo )

IMPORT_C HBufC *PageInfoLC(TBrCtlDefs::TBrCtlPageInfoaBrCtlPageInfo)[pure virtual]
Request the Browser Control to return info about the page. The info is returned on the Cleanup Stack.
Since
2.8
Attention:

The information is returned on the Cleanup stack.

Parameters
aBrCtlPageInfoThe type of requested info
Return Value
A descriptor containing the requested page info

PostUrlL ( const TDesC &, const TDesC8 &, const TDesC8 &, const TDesC8 *, TAny * )

IMPORT_C voidPostUrlL(const TDesC &aUrl,
const TDesC8 &aContentType,
const TDesC8 &aPostData,
const TDesC8 *aBoundary,
TAny *aReserved
)[pure virtual]
Requests the Browser Control to POST to a URL
Since
5.0
Parameters
aUrlURL to which the Browser Control sends the POST request
aContentTypeContent type of the data to be posted
aPostDataData to be posted
aBoundaryBoundary for form-data or multi-part content.
aReservedFor future use only
Return Value
void

RemoveCommandObserver ( MBrCtlCommandObserver * )

IMPORT_C voidRemoveCommandObserver(MBrCtlCommandObserver *aBrCtlCommandObserver)[pure virtual]
Unregister a client command interface for the browser engine
Since
3.1
Return Value
void

RemoveLoadEventObserver ( MBrCtlLoadEventObserver * )

IMPORT_C voidRemoveLoadEventObserver(MBrCtlLoadEventObserver *aBrCtlLoadEventObserver)[pure virtual]
Request the Browser Control to unregister for load events
Since
2.8
Parameters
aBrCtlLoadEventObserverA load events observer to remove
Return Value
void Call this function for each Load Observer that was previously registered.

RemoveStateChangeObserver ( MBrCtlStateChangeObserver * )

IMPORT_C voidRemoveStateChangeObserver(MBrCtlStateChangeObserver *aBrCtlStateChangeObserver)[pure virtual]
Unregister an observer for state changes
Since
2.8
Return Value
void

SaveToFileL ( const TDesC & )

IMPORT_C TUint16SaveToFileL(const TDesC &aFileName)[pure virtual]
Request the Browser Control to save the current content to a file
Since
2.8
Parameters
aFileNameThe name of the file to use for saving the content
Return Value
The number of bytes in the saved file

SetBrowserSettingL ( TUint, TUint )

IMPORT_C voidSetBrowserSettingL(TUintaSetting,
TUintaValue
)[pure virtual]
Update a Browser Control setting
Since
2.8
Parameters
aSettingThe setting to update
aValueThe new value of the setting
Return Value
void
Leave Codes
KErrArgumentif the value of aSetting is out of range.

SetFocus ( TBool, TDrawNow )

IMPORT_C voidSetFocus(TBoolaFocus,
TDrawNowaDrawNow = ENoDrawNow
)[pure virtual]
From CCoeControl Sets that the Browser Control has keyboard focus.
Since
2.8
Attention:

This function is inherited from the Symbian CCoeControl class.

Parameters
aFocusIf the Browser Control gets or loses focus
Return Value
void

SetParamL ( TBrCtlDefs::TBrCtlParams, const TDesC & )

IMPORT_C voidSetParamL(TBrCtlDefs::TBrCtlParamsaParam,
const TDesC &aValue
)[pure virtual]
Update a Browser Control parameter. consequent calls with the same aParam will replace the value, and not append to it.
Since
2.8
EParamsRequestHeaders: Pass a list of headers that the Browser Control. These headers will be added to each request. The list must be separated by ''. The header name and value must be separated by ':' e.g. "x-myheader: myvalue\rx-myotherheader: myothervalue"
Parameters
aParamThe parameter to update
aValueThe 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"
Return Value
void

SetSelfDownloadContentTypesL ( TDesC & )

IMPORT_C voidSetSelfDownloadContentTypesL(TDesC &aContentTypes)[pure virtual]
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" DeprecatedThis function is deprecated. Use the EParamsSelfDownloadableTypes parameter of the SetParamL function instead.
Since
2.8
Parameters
aContentTypesThe content types that should not use Download Manager
Return Value
void

SubscribeToMenuItemsL ( )

IMPORT_C const RPointerArray< TBrCtlSubscribeTo > &SubscribeToMenuItemsL()[pure virtual]
Return information about the linked feeds in the current page - used to build a "Subscribe to" submenu.
Since
3.0
Return Value
Information about the linked feeds in the current page. The caller adopts the result.

TakeSnapshotL ( CFbsBitmap & )

IMPORT_C voidTakeSnapshotL(CFbsBitmap &snapshot)[pure virtual]
Requests the Browser Control for offscreen bitmap
Since
5.0 @ fills offscreen bitmap.The bitmap memory has to be set and freed by the api calling that function.
Return Value
void.

VersionInfoLC ( TBrCtlDefs::TBrCtlVersionInfo )

IMPORT_C HBufC *VersionInfoLC(TBrCtlDefs::TBrCtlVersionInfoaVersionInfo)[pure virtual]
Request the Browser Control to return info about the Browser Control version. The info is returned on the Cleanup Stack.
Since
2.8
Attention:

The information is returned on the Cleanup Stack.

Parameters
aVersionInfoThe type of requested info
Return Value
A descriptor containing the requested page info

WMLOptionMenuItemsL ( )

IMPORT_C RPointerArray< TBrCtlWmlServiceOption > *WMLOptionMenuItemsL()[pure virtual]

ZoomLevels ( )

IMPORT_C RArray< TUint > *ZoomLevels()const [pure virtual]
Return the zoom levels index
Since
3.0
Return Value
The zoom levels array.