HbbTv  17.9.0
Open source HBBTV engine
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros
hbbtv_sif_browser.h
Go to the documentation of this file.
1 /*******************************************************************************
2  * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
3  * Copyright © 2014 Ocean Blue Software Ltd
4  *
5  * This file is part of a DTVKit Software Component
6  * You are permitted to copy, modify or distribute this file subject to the terms
7  * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
8  *
9  * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
10  * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
11  * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
12  *
13  * If you or your organisation is not a member of DTVKit then you have access
14  * to this source code outside of the terms of the licence agreement
15  * and you are expected to delete this and any associated files immediately.
16  * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
17  *******************************************************************************/
26 /* pre-processor mechanism so multiple inclusions don't cause compilation error*/
27 
28 #ifndef HBBTV_SIF_BROWSER_H
29 
30 #define HBBTV_SIF_BROWSER_H
31 
32 /*---Constant and macro definitions for public use-----------------------------*/
33 
34 /*---Enumerations for public use-----------------------------------------------*/
35 
36 typedef enum
37 {
42 
47 
53 
54 
55 /*---Global type defs for public use-------------------------------------------*/
56 
65 
66 
67 /*---Global Function prototypes for public use---------------------------------*/
68 
74 
78 void HBBTV_WBTerminate(void);
79 
85 void HBBTV_WBSetUrl(const U8BIT *url);
86 
90 void HBBTV_WBShow(void);
91 
95 void HBBTV_WBHide(void);
96 
100 void HBBTV_WBUnload(void);
101 
106 
107 #endif /* HBBTV_SIF_BROWSER_H */
E_HBBTV_KEY
Key codes.
Definition: hbbtv_types.h:87
A URL started being loaded.
Definition: hbbtv_sif_browser.h:41
void HBBTV_WBInitalise(F_HBBTV_URL_STATUS_NOTIFICATION func)
Initialise Browser.
void HBBTV_WBSendKeyPress(E_HBBTV_KEY key)
Send a key event.
void HBBTV_WBTerminate(void)
Terminate Browser.
E_HBBTV_URL_STATUS
Definition: hbbtv_sif_browser.h:36
A URL could not be loaded.
Definition: hbbtv_sif_browser.h:51
void HBBTV_WBHide(void)
Hide the browser window.
A URL has been successfully loaded.
Definition: hbbtv_sif_browser.h:46
void HBBTV_WBShow(void)
Show the browser window.
Definition: hbbtv_types.h:167
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 req...
Definition: hbbtv_sif_browser.h:64
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...
void HBBTV_WBUnload(void)
Unload everything.