source/classes/inc/mh5switchbutton.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 _MH5SWITCHBUTTON_H_
#define _MH5SWITCHBUTTON_H_

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

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

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

/*---Global type defs for public use-----------------------------------------*/
typedef struct
{
   /* Base class */
   MHEG5Pushbutton pushbutton;

   /* Exchanged attributes */
   MHEG5PushbuttonStyle style;

   /* No internal attributes for this class */
} MHEG5Switchbutton;

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

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

void MHEG5switchbuttonInit(MHEG5Switchbutton *switchbutton);


void MHEG5switchbuttonFree(MHEG5Switchbutton *switchbutton);


/*
    Internal behaviours
 */
void MHEG5switchbuttonPrepare(MHEG5Switchbutton *switchbutton);
void MHEG5switchbuttonActivate(MHEG5Switchbutton *switchbutton);
void MHEG5switchbuttonDeactivate(MHEG5Switchbutton *switchbutton);
void MHEG5switchbuttonDestruct(MHEG5Switchbutton *switchbutton);


MHEG5ErrorCode MHEG5toggle(MHEG5Root *target, MHEG5GList *params);

MHEG5ErrorCode MHEG5getSelectionStatus(MHEG5Root *target, MHEG5GList *params);

/*
   Debug
 */
#ifdef MH5PRINTOUT

void MHEG5switchbuttonPrint(MHEG5Switchbutton *switchbutton, char *out);
#endif

#endif /*_MH5SWITCHBUTTON_H_*/