IEmbeddedBrowser Class Reference

Embedded Browser Interface. More...

#include <embedded_browser_interface.h>

Public Member Functions
virtual SDKError	SetEvent (IEmbeddedBrowserEvent *pEvent)=0
	Set embedded browser callback event handler. More...
virtual SDKError	Navigate (const char *url)=0
	Start to navigate. More...
virtual SDKError	Resize ()=0
	Resize the embedded browser window to cover the client area of the parent window. More...
virtual const char *	GetURL ()=0
	Gets the URL matched to the present displayed content or get the full path of file, or the full path containing the file name. More...
virtual const char *	GetTitle ()=0
	Get the title of the present displayed content. More...
virtual SDKError	GoBack ()=0
	Navigate to the previous page by the web control if exists navigation history. More...
virtual SDKError	GoForward ()=0
	Navigate to the next page by the web control if exists navigation history. More...
virtual SDKError	DoRefresh ()=0
	Reloads the present document displayed on the web browser. More...
virtual SDKError	DoStop ()=0
	Cancel all pending navigations or dynamic elements, such as background sounds and animations. More...

Detailed Description

Embedded Browser Interface.

Member Function Documentation

DoRefresh()

virtual SDKError IEmbeddedBrowser::DoRefresh ( )

pure virtual

Reloads the present document displayed on the web browser.

Returns

If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

DoStop()

virtual SDKError IEmbeddedBrowser::DoStop ( )

pure virtual

Cancel all pending navigations or dynamic elements, such as background sounds and animations.

Returns

If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

GetTitle()

virtual const char* IEmbeddedBrowser::GetTitle ( )

pure virtual

Get the title of the present displayed content.

Returns

The title of the present displayed content. If the resource is a HTML web-page, the name is the title of the document. If the resource is a folder or file on the network or local computer, the name is the full path of folder or file in Universal Naming Convention (UNC) format.

GetURL()

virtual const char* IEmbeddedBrowser::GetURL ( )

pure virtual

Gets the URL matched to the present displayed content or get the full path of file, or the full path containing the file name.

Returns

The URL matched to the present displayed content or the full path of file, or the full path containing the file name.

GoBack()

virtual SDKError IEmbeddedBrowser::GoBack ( )

pure virtual

Navigate to the previous page by the web control if exists navigation history.

Returns

If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

GoForward()

virtual SDKError IEmbeddedBrowser::GoForward ( )

pure virtual

Navigate to the next page by the web control if exists navigation history.

Returns

If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Navigate()

virtual SDKError IEmbeddedBrowser::Navigate ( const char *  url )

pure virtual

Start to navigate.

Parameters

url	The URL to browser or the full path of file to be visited, or the full path of file to be opened in UTF8 encoding format.

Returns

If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Resize()

virtual SDKError IEmbeddedBrowser::Resize ( )

pure virtual

Resize the embedded browser window to cover the client area of the parent window.

Returns

If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

SetEvent()

virtual SDKError IEmbeddedBrowser::SetEvent ( IEmbeddedBrowserEvent *  pEvent )

pure virtual

Set embedded browser callback event handler.

Parameters

pEvent

A pointer to the IEmbeddedBrowserEvent that receives Embedded Browser event.

Returns

If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

---

The documentation for this class was generated from the following file:

• h/embedded_browser_interface.h