HbbTv  17.9.0
Open source HBBTV engine
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros
app.h
Go to the documentation of this file.
1 /*******************************************************************************
2  * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
3  * Copyright © 2013 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  *******************************************************************************/
25 #ifndef _APP_H
26 #define _APP_H
27 
28 #include "object.h"
29 
30 /***************************************************************************/
31 /* class: Application */
32 /* reference: Section 7.2.2 */
33 /***************************************************************************/
34 
35 typedef struct s_app
36 {
37  S_JS_OBJECT object;
38  void *app_private_data;
39  S_HBBTV_STRING uri;
40  S_HBBTV_STRING base_url;
41  U32BIT org_id;
42  U16BIT app_id;
43  U8BIT control_code;
44  BOOLEAN is_broadcast;
45  BOOLEAN is_service_bound;
46  BOOLEAN is_visible;
47  U8BIT num_boundaries;
48  S_HBBTV_STRING *boundaries;
49  BOOLEAN enforce_security_restrictions;
50 } S_APP;
51 
52 extern void *JS_APP_CLASS;
53 
54 S32BIT HBBTV_AppGetKeysetValue(void *obj);
55 
61 E_HBBTV_ERR HBBTV_AppAcceptKeyPress(E_HBBTV_KEY key);
62 
69 E_HBBTV_ERR HBBTV_AppSendKeyPress(E_HBBTV_KEY key);
70 
71 #endif /* _APP_H */
E_HBBTV_KEY
Key codes.
Definition: hbbtv_types.h:87
E_HBBTV_ERR HBBTV_AppSendKeyPress(E_HBBTV_KEY key)
Internal function to handle a key press and send it to the browser.
Definition: app.c:273
Definition: object.h:57
Generic object class.
Definition: hbbtv_types.h:167
Definition: app.h:35
E_HBBTV_ERR HBBTV_AppAcceptKeyPress(E_HBBTV_KEY key)
Internal function to check whether or not a key is accepted by the application.
Definition: app.c:80