HbbTv  17.9.0
Open source HBBTV engine
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros
Typedefs | Enumerations | Functions
hbbtv_sif_browser.h File Reference

System Interface, Browser. More...

Go to the source code of this file.

Typedefs

typedef void(* F_HBBTV_URL_STATUS_NOTIFICATION )(S_HBBTV_STRING *url, E_HBBTV_URL_STATUS status)
 Callback function called by the browser to notify the HbbTV engine with the status of URL loading requests. A URL loading request can be triggered by the HbbTV engine itself set with HBBTV_WBSetUrl or by the HTML page. More...
 

Enumerations

enum  E_HBBTV_URL_STATUS { HBBTV_URL_LOAD_STARTED, HBBTV_URL_LOAD_OK, HBBTV_URL_LOAD_FAIL }
 

Functions

void HBBTV_WBInitalise (F_HBBTV_URL_STATUS_NOTIFICATION func)
 Initialise Browser. More...
 
void HBBTV_WBTerminate (void)
 Terminate Browser.
 
void HBBTV_WBSetUrl (const U8BIT *url)
 Asks the browser to load a new URL. If another URL is already loaded, this function should not unload the page if the new URL cannot be loaded. More...
 
void HBBTV_WBShow (void)
 Show the browser window.
 
void HBBTV_WBHide (void)
 Hide the browser window.
 
void HBBTV_WBUnload (void)
 Unload everything.
 
void HBBTV_WBSendKeyPress (E_HBBTV_KEY key)
 Send a key event.
 

Detailed Description

System Interface, Browser.

Date
January 2014
Author
Sergio Panseri

Typedef Documentation

typedef void(* F_HBBTV_URL_STATUS_NOTIFICATION)(S_HBBTV_STRING *url, E_HBBTV_URL_STATUS status)

Callback function called by the browser to notify the HbbTV engine with the status of URL loading requests. A URL loading request can be triggered by the HbbTV engine itself set with HBBTV_WBSetUrl or by the HTML page.

Parameters
urlURL this notification refers to.
statussee E_HBBTV_URL_STATUS

Enumeration Type Documentation

Enumerator
HBBTV_URL_LOAD_STARTED 

A URL started being loaded.

HBBTV_URL_LOAD_OK 

A URL has been successfully loaded.

HBBTV_URL_LOAD_FAIL 

A URL could not be loaded.

Function Documentation

void HBBTV_WBInitalise ( F_HBBTV_URL_STATUS_NOTIFICATION  func)

Initialise Browser.

Parameters
funcSee F_HBBTV_URL_STATUS_NOTIFICATION
void HBBTV_WBSetUrl ( const U8BIT *  url)

Asks the browser to load a new URL. If another URL is already loaded, this function should not unload the page if the new URL cannot be loaded.

Parameters
urlURL string