source/classes/inc/mh5pushbutton.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2004 Ocean Blue Software Ltd
 * Copyright © 2000 Koninklijke Philips Electronics N.V
 *
 * This file is part of a DTVKit Software Component
 * You are permitted to copy, modify or distribute this file subject to the terms
 * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
 * 
 * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
 * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
 * 
 * If you or your organisation is not a member of DTVKit then you have access
 * to this source code outside of the terms of the licence agreement
 * and you are expected to delete this and any associated files immediately.
 * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
 *******************************************************************************/
#ifndef _MH5PUSHBUTTON_H
#define _MH5PUSHBUTTON_H

/*---includes for this file--------------------------------------------------*/
#include "mh5button.h"

typedef struct
{
   /* Base class */
   MHEG5Button button;

   /* Exchanged attributes */
   MHEG5String originalLabel;
   MHEG5Int characterSet;

   /* Internal attributes */
   MHEG5String label;
} MHEG5Pushbutton;


/*---Constant and macro definitions for public use---------------------------*/

/*---Enumerations for public use---------------------------------------------*/

/*---Global type defs for public use-----------------------------------------*/

/*---Global variable declarations for public use-----------------------------*/

/*---Global Function prototypes for public use-------------------------------*/

void MHEG5pushbuttonInit(MHEG5Pushbutton *pushbutton);


void MHEG5pushbuttonFree(MHEG5Pushbutton *pushbutton);


/*
    Internal behaviours
 */
void MHEG5pushbuttonPrepare(MHEG5Pushbutton *pushbutton);
void MHEG5pushbuttonActivate(MHEG5Pushbutton *pushbutton);
void MHEG5pushbuttonDeactivate(MHEG5Pushbutton *pushbutton);
void MHEG5pushbuttonDestruct(MHEG5Pushbutton *pushbutton);

/*
    Actions
 */
MHEG5ErrorCode MHEG5setLabel(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5getLabel(MHEG5Root *target, MHEG5GList *params);

/*
   Debug
 */
#ifdef MH5PRINTOUT

void MHEG5pushbuttonPrint(MHEG5Pushbutton *pushbutton, char *out);
#endif


#endif /*_MH5PUSHBUTTON_H*/