 |
MHEG-5
19.3.0
MHEG-5 Documentation
|
Keypress functions. More...
#include <glue_memory.h>#include <glue_debug.h>#include <glue_queue.h>#include <glue_main.h>#include "mheg5_keypress.h"#include "mheg5_events.h"#include "mh5application.h"#include "mh5scene.h"#include "mh5queue.h"#include "mh5display.h"#include "mh5entryfield.h"#include "mh5hypertext.h"#include "mh5slider.h"#include "mh5profile.h"#include "mh5support.h"#include "mh5keypress.h"Go to the source code of this file.
Classes | |
| struct | s_keyMask |
Typedefs | |
| typedef struct s_keyMask | s_keyMask_t |
Functions | |
| void | MHEG5setInputEventRegister (MHEG5Int inputEventRegister) |
| Change the input event register. This indicates which keypresses the MHEG-5 engine requires to be passed. See UK 1.05 profile section 3.6 for a description of which keypresses must be passed to MHEG-5 for the different input event register values. These values are likely to change for UK1.06 profile. More... | |
| BOOLEAN | MHEG5_IsKeyNeeded (E_MHEG5_KEY keyPress) |
| Enquire from MHEG5 engine about whether a key is needed, without actually passing the key to it. More... | |
| void | MHEG5userInputEvent (S_KeyPressEvent *params) |
| Process the UserInput from the system. According to the current profile and the UserInputRegister of the current screen the UserInput is processed. MHEG5mouseMoveEvent. More... | |
| MHEG5Bool | MHEG5IsInputMaskSupported (MHEG5String query_mask) |
| Tell whether the set of keys indicated by the input mask is supported by the receiver (this means that every key in the mask is supported). More... | |
| void | MHEG5setInputEventMask (MHEG5String *inputEventMask) |
| Change the input mask. This indicates which keypresses the MHEG-5 engine requires to be passed. More... | |
| BOOLEAN | MHEG5_NotifyKeyPress (E_MHEG5_KEY key) |
| Notify MHEG5 engine of a key press. If FALSE is returned, the external application may use the key. More... | |
| void | MHEG5PromotionalLinkControl (BOOLEAN isEnabled) |
| BOOLEAN | MHEG5_IsPromotionalLinkingEnabled (void) |
| This function is relevant to PVR products that support NativeApplicationExtension for broadcast-triggered native applications, The returned state indicates whether MHEG group 3 keys (CANCEL, RED, GREEN, YELLOW, BLUE, TEXT) may be intercepted by the external application for promotional linking. Only when the state is set to TRUE, can group 3 keys be used for broadcast-triggered native application. If the key is not consumed for this purpose, then it must be presented to MHEG5_NotifyKeyPress(), as normal. More... | |
| void | MHEG5_KeySupportDisabled (E_MHEG5_KEY key) |
| Inform MHEG5 engine that key is not supported by the platform or product. By default MHEG5 engine assumes all keys are supported. Call this function after MHEG5_Open(). More... | |
| void | MHEG5_KeySupportEnabled (E_MHEG5_KEY key) |
| Key press support is enabled. May be called after the key has been disabled by MHEG5_KeySupportDisabled() More... | |
Variables | |
| BOOLEAN | key_mask_enable [TOTAL_MHEG5_KEYS] |
| BOOLEAN | key_unsupported [TOTAL_MHEG5_KEYS] |
| BOOLEAN MHEG5_IsKeyNeeded | ( | E_MHEG5_KEY | key | ) |
Enquire from MHEG5 engine about whether a key is needed, without actually passing the key to it.
| key | Value of Key press |
Definition at line 470 of file mh5keypress.c.
| BOOLEAN MHEG5_IsPromotionalLinkingEnabled | ( | void | ) |
This function is relevant to PVR products that support NativeApplicationExtension for broadcast-triggered native applications, The returned state indicates whether MHEG group 3 keys (CANCEL, RED, GREEN, YELLOW, BLUE, TEXT) may be intercepted by the external application for promotional linking. Only when the state is set to TRUE, can group 3 keys be used for broadcast-triggered native application. If the key is not consumed for this purpose, then it must be presented to MHEG5_NotifyKeyPress(), as normal.
Definition at line 1269 of file mh5keypress.c.
| void MHEG5_KeySupportDisabled | ( | E_MHEG5_KEY | key | ) |
Inform MHEG5 engine that key is not supported by the platform or product. By default MHEG5 engine assumes all keys are supported. Call this function after MHEG5_Open().
| key | Value of Key press |
Definition at line 1280 of file mh5keypress.c.
| void MHEG5_KeySupportEnabled | ( | E_MHEG5_KEY | key | ) |
Key press support is enabled. May be called after the key has been disabled by MHEG5_KeySupportDisabled()
| key | Value of Key press |
Definition at line 1293 of file mh5keypress.c.
| BOOLEAN MHEG5_NotifyKeyPress | ( | E_MHEG5_KEY | key | ) |
Notify MHEG5 engine of a key press. If FALSE is returned, the external application may use the key.
| key | Value of Key press |
Definition at line 1214 of file mh5keypress.c.
| MHEG5Bool MHEG5IsInputMaskSupported | ( | MHEG5String | query_mask | ) |
Tell whether the set of keys indicated by the input mask is supported by the receiver (this means that every key in the mask is supported).
| query_mask | The input key mask to check |
Definition at line 1076 of file mh5keypress.c.
| void MHEG5setInputEventMask | ( | MHEG5String * | inputEventMask | ) |
Change the input mask. This indicates which keypresses the MHEG-5 engine requires to be passed.
| inputMask | New input mask. The input mask is only valid if the input event register is 0. |
Definition at line 1146 of file mh5keypress.c.
| void MHEG5setInputEventRegister | ( | MHEG5Int | inputEventRegister | ) |
Change the input event register. This indicates which keypresses the MHEG-5 engine requires to be passed. See UK 1.05 profile section 3.6 for a description of which keypresses must be passed to MHEG-5 for the different input event register values. These values are likely to change for UK1.06 profile.
| inputEventRegister | New input event register value. 0 indicates that there is no scene currently running. |
Definition at line 320 of file mh5keypress.c.
| void MHEG5userInputEvent | ( | S_KeyPressEvent * | params | ) |
Process the UserInput from the system. According to the current profile and the UserInputRegister of the current screen the UserInput is processed. MHEG5mouseMoveEvent.
| ui | User input. |
Definition at line 507 of file mh5keypress.c.
1.8.11