source/classes/inc/mh5visible.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 _MH5VISIBLE_H
#define _MH5VISIBLE_H

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

#include "techtype.h"
#include "mh5ingredient.h"
#include "osdtypes.h"

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

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

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


typedef struct
{
   /* Base class */
   MHEG5Ingredient ingredient;

   /* Exchanged attributes */
   MHEG5Int originalBoxSize[2];
   MHEG5Int originalPosition[2];
   MHEG5Int originalPaletteRefID;
   MH5GroupRef originalPaletteRefGROUPID;

   /* Internal attributes */
   MHEG5Int boxSize[2];
   MHEG5Int position[2];
#if 0
   MHEG5Int paletteRefID;
   MH5GroupRef paletteRefGROUPID;
#endif
   void *graphic_data;
   S_REGION rect;
   BOOLEAN restricted;
} MHEG5Visible;

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

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

/*
   Debug
 */
#ifdef MH5PRINTOUT

void MHEG5visiblePrint(MHEG5Visible *visible, char *out);
#endif

/*
   Test for Visible Objects
 */
MHEG5Bool MHEG5visibleIs(MHEG5Root *target);

/*
   Constructor
 */
void MHEG5visibleInit(MHEG5Visible *visible);


void MHEG5visibleFree(MHEG5Visible *visible);


/*
   Clone help function
 */
void MHEG5visibleClone(MHEG5Visible *destination, MHEG5Visible *source);


/*
   Internal behaviours
 */
void MHEG5visiblePrepare(MHEG5Visible *visible);
void MHEG5visibleActivate(MHEG5Visible *visible);
void MHEG5visibleDeactivate(MHEG5Visible *visible);
void MHEG5visibleDestruct(MHEG5Visible *visible);

/*
    For ListGroup
 */
void MHEG5visibleResetPosition(MHEG5Visible *visible);
void MHEG5visibleSetPosition(MHEG5Visible *visible, MHEG5Int x, MHEG5Int y);

/*
   Actions
 */
MHEG5ErrorCode MHEG5setPosition(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5getPosition(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5setBoxSize(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5getBoxSize(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5bringToFront(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5sendToBack(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5putBefore(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5putBehind(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5setPaletteRef(MHEG5Root *target, MHEG5GList *params);

#endif /*_MH5VISIBLE_H*/