wiki/MHEG5_15_3_1/mh5hotspot_8h_source.html

00001 /*******************************************************************************
00002  * Copyright � 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
00003  * Copyright � 2004 Ocean Blue Software Ltd
00004  * Copyright � 2000 Koninklijke Philips Electronics N.V
00005  *
00006  * This file is part of a DTVKit Software Component
00007  * You are permitted to copy, modify or distribute this file subject to the terms
00008  * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
00009  *
00010  * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
00011  * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
00012  * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
00013  *
00014  * If you or your organisation is not a member of DTVKit then you have access
00015  * to this source code outside of the terms of the licence agreement
00016  * and you are expected to delete this and any associated files immediately.
00017  * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
00018  *******************************************************************************/
00031 #ifndef _MH5HOTSPOT_H_
00032 #define _MH5HOTSPOT_H_
00033
00034 /*---includes for this file--------------------------------------------------*/
00035 #include "mh5button.h"
00036
00037 /*---Constant and macro definitions for public use---------------------------*/
00038 typedef struct
00039 {
00040    /* Base class */
00041    MHEG5Button button;
00042
00043    /* No exchanged attributes for this class */
00044
00045    /* No internal attributes for this class */
00046 } MHEG5Hotspot;
00047
00048 /*---Enumerations for public use---------------------------------------------*/
00049
00050 /*---Global type defs for public use-----------------------------------------*/
00051
00052 /*---Global variable declarations for public use-----------------------------*/
00053
00054 /*---Global Function prototypes for public use-------------------------------*/
00055
00066 void MHEG5hotspotInit(MHEG5Hotspot *hotspot);
00067
00068
00076 void MHEG5hotspotFree(MHEG5Hotspot *hotspot);
00077
00078
00079 /*
00080     Internal behaviours
00081  */
00082 void MHEG5hotspotPrepare(MHEG5Hotspot *hotspot);
00083 void MHEG5hotspotActivate(MHEG5Hotspot *hotspot);
00084 void MHEG5hotspotDeactivate(MHEG5Hotspot *hotspot);
00085 void MHEG5hotspotDestruct(MHEG5Hotspot *hotspot);
00086
00087 /*
00088    Debug
00089  */
00090 #ifdef MH5PRINTOUT
00091 void MHEG5hotspotPrint(MHEG5Hotspot *hotspot, char *out);
00092 #endif
00093
00094 #endif /*_MH5HOTSPOT_H_*/