source/classes/inc/mh5interactible.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 _MH5INTERACTIBLE_H
#define _MH5INTERACTIBLE_H

/*---includes for this file--------------------------------------------------*/

#include "mh5base.h"

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

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

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

typedef struct
{
   /* No base class (mix-in) */

   /* Exchanged attributes */
   MHEG5Bool engineResp;
   MHEG5Colour highlightRefColour;

   /* Internal attributes */
   MHEG5Bool highlightStatus;
   MHEG5Bool interactionStatus;
} MHEG5Interactible;

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

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

/*
   Debug
 */
#ifdef MH5PRINTOUT
void MHEG5interactiblePrint(MHEG5Interactible *interactible, char *out);
#endif


/*
   Constructor
 */
void MHEG5interactibleInit(MHEG5Interactible *interactible);


void MHEG5interactiblePrepare(MHEG5Interactible *interactible);


void MHEG5interactibleFree(MHEG5Interactible *interactible);


/*
   Clone
 */
void MHEG5interactibleClone(MHEG5Interactible *destination, MHEG5Interactible *source);

/*
   Internal behaviours
 */
void MHEG5interactibleDestruct(MHEG5Interactible *interactible);


void MHEG5interactibleDeactivate(MHEG5Interactible *interactible);


void MHEG5interactibleInteractionCompleted(MHEG5Interactible *interactible, MHEG5Root *item);

/*
   Actions
 */
MHEG5ErrorCode MHEG5setInteractionStatus(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5getInteractionStatus(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5setHighlightStatus(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5getHighlightStatus(MHEG5Root *target, MHEG5GList *params);

#endif /*_MH5INTERACTIBLE_H*/