wiki/MHEG5_15_3_1/mheg5__keypress_8h_source.html

00001 /*******************************************************************************
00002  * Copyright � 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
00003  * Copyright � 2013 Ocean Blue Software Ltd
00004  *
00005  * This file is part of a DTVKit Software Component
00006  * You are permitted to copy, modify or distribute this file subject to the terms
00007  * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
00008  *
00009  * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
00010  * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
00011  * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
00012  *
00013  * If you or your organisation is not a member of DTVKit then you have access
00014  * to this source code outside of the terms of the licence agreement
00015  * and you are expected to delete this and any associated files immediately.
00016  * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
00017  *******************************************************************************/
00025 #ifndef _MHEG5_KEYPRESS_H
00026 #define _MHEG5_KEYPRESS_H
00027
00028 #include "techtype.h"
00029
00030 /*---Constant and macro definitions for public use-----------------------------*/
00031
00032 /*---Enumerations for public use-----------------------------------------------*/
00033
00034 /* User interface key presses given to MHEG5 engine */
00035 typedef enum
00036 {
00037    MHEG5_KEY_UP,
00038    MHEG5_KEY_DOWN,
00039    MHEG5_KEY_LEFT,
00040    MHEG5_KEY_RIGHT,
00041    MHEG5_KEY_0,
00042    MHEG5_KEY_1,
00043    MHEG5_KEY_2,
00044    MHEG5_KEY_3,
00045    MHEG5_KEY_4,
00046    MHEG5_KEY_5,
00047    MHEG5_KEY_6,
00048    MHEG5_KEY_7,
00049    MHEG5_KEY_8,
00050    MHEG5_KEY_9,
00051    MHEG5_KEY_SELECT,
00052    MHEG5_KEY_CANCEL,
00053    MHEG5_KEY_HELP,
00054    MHEG5_KEY_RED,
00055    MHEG5_KEY_GREEN,
00056    MHEG5_KEY_YELLOW,
00057    MHEG5_KEY_BLUE,
00058    MHEG5_KEY_TEXT,
00059    MHEG5_KEY_INFO,
00060    MHEG5_KEY_EPG,
00061    MHEG5_KEY_STOP,
00062    MHEG5_KEY_PLAY,
00063    MHEG5_KEY_PAUSE,
00064    MHEG5_KEY_SKIP_FWD,
00065    MHEG5_KEY_SKIP_BACK,
00066    MHEG5_KEY_FAST_FWD,
00067    MHEG5_KEY_REWIND,
00068    MHEG5_KEY_PLAY_PAUSE,
00069    MHEG5_KEY_RECORD,
00070
00071    /* Last item is not a real key and should not be passed as a key press
00072     * It is only useful as definitive value for total number of keys */
00073    TOTAL_MHEG5_KEYS
00074 } E_MHEG5_KEY;
00075
00076 /*---Global type defs for public use-------------------------------------------*/
00077
00078 /*---Global Function prototypes for public use---------------------------------*/
00079
00086 BOOLEAN MHEG5_NotifyKeyPress( E_MHEG5_KEY key );
00087
00094 BOOLEAN MHEG5_IsKeyNeeded( E_MHEG5_KEY key );
00095
00108 BOOLEAN MHEG5_IsPromotionalLinkingEnabled(void);
00109
00116 void MHEG5_KeySupportDisabled(E_MHEG5_KEY key);
00117
00123 void MHEG5_KeySupportEnabled(E_MHEG5_KEY key);
00124
00125
00126 #endif // _MHEG5_KEYPRESS_H