mh5slider.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 _MH5SLIDER_H_
#define _MH5SLIDER_H_

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

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

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

/*---Global type defs for public use-----------------------------------------*/
typedef struct
{
   /* Base classes */
   MHEG5Visible visible;
   MHEG5Interactible interactible;

   /* Exchanged atributes */
   MHEG5Orientation orientation;
   MHEG5Int initialValue;
   MHEG5Int originalMinValue;
   MHEG5Int originalMaxValue;
   MHEG5Int initialPortion;
   MHEG5Int originalStepSize;
   MHEG5SliderStyle sliderStyle;
   MHEG5Colour sliderRefColour;

   /* Internal attributes */
   MHEG5Int sliderValue;
   MHEG5Int portion;
   MHEG5Int minValue;
   MHEG5Int maxValue;
   MHEG5Int stepSize;
} MHEG5Slider;

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

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

void MHEG5sliderInit(MHEG5Slider *slider);


void MHEG5sliderFree(MHEG5Slider *slider);


/*
    Internal behaviours
 */
void MHEG5sliderPrepare(MHEG5Slider *slider);
void MHEG5sliderActivate(MHEG5Slider *slider);
void MHEG5sliderDeactivate(MHEG5Slider *slider);
void MHEG5sliderDestruct(MHEG5Slider *slider);

/*
    Actions
 */
MHEG5ErrorCode MHEG5step(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5setSliderValue(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5getSliderValue(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5setPortion(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5getPortion(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5setSliderParameters(MHEG5Root *target, MHEG5GList *params);


void MHEG5sliderLEFT(MHEG5Slider *slider);


void MHEG5sliderUP(MHEG5Slider *slider);


void MHEG5sliderRIGHT(MHEG5Slider *slider);


void MHEG5sliderDOWN(MHEG5Slider *slider);


void MHEG5sliderSELECT(MHEG5Slider *slider);


void MHEG5sliderEXIT(MHEG5Slider *slider);


/*
   Debug
 */
#ifdef MH5PRINTOUT

void MHEG5sliderPrint(MHEG5Slider *slider, char *out);
#endif

#endif /*_MH5SLIDER_H_*/