source/classes/inc/mh5application.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 _MH5APPLICATION_H
#define _MH5APPLICATION_H

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

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

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

/*---Global type defs for public use-----------------------------------------*/
/*
     Display Stack
 */
typedef struct sMHEG5DisplayStackItem
{
   MHEG5Root *item;
   struct sMHEG5DisplayStackItem *next;
   struct sMHEG5DisplayStackItem *prev;
} MHEG5DisplayStackItem;


/*
     Applicatin Object
 */
typedef struct
{
   /* Base class */
   MHEG5Group group;

   /* Exchanged attributes */
   MHEG5ActionList onSpawnCloseDown;
   MHEG5ActionList onRestart;
   MHEG5Int characterSet;
   MHEG5Colour backgroundColour;
   MHEG5Colour textColour;
   MHEG5FontBody fontBody;
   MHEG5String fontAttributes;
   MHEG5Int bitmapContentHook;
   MHEG5Int streamContentHook;
   MHEG5Int textContentHook;
   MHEG5Int lineArtContentHook;
   MHEG5Int interchangedProgramContentHook;
   MHEG5Colour buttonRefColour;
   MHEG5Colour highlightRefColour;
   MHEG5Colour sliderRefColour;
   MHEG5Colour originalDesktopColour;

   /* Internal attributes */
   MHEG5Int lockCount;
   MHEG5DisplayStackItem *displayStackTop;
   MHEG5DisplayStackItem *displayStackBottom;
   MHEG5Bool streamContinuanceFlag;                 /* See UK1.05 section 6.3.4 */
   MHEG5Colour desktopColour;
} MHEG5Application;

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

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

#ifdef MH5PRINTOUT

void MHEG5fontBodyPrint(MHEG5FontBody fontBody, char *out);

void MHEG5applicationPrint(MHEG5Application *application, char *out);

#endif /* MH5PRINTOUT */



/*
     Access to current Application
 */
MHEG5Application* MHEG5getCurrentApplication(void);


/*   Clear the application stack */
void MHEG5applicationStackClear(BOOLEAN isNdt);
#ifndef CI_PLUS_ONLY
void MHEG5applicationCarouselUnload( void *carousel );
void MHEG5applicationNDTcarouselAttach( void *carousel );
#endif


MHEG5ErrorCode MHEG5applicationBootup( char *app_name );

void MHEG5applicationBootAbort( void );

/*
     Access the display Stack
 */
void MHEG5displayStackAdd(MHEG5Root *visible, MHEG5Bool atTop);
MHEG5Bool MHEG5displayStackDelete(MHEG5Root *visible);
void MHEG5displayStackToTop(MHEG5Root *visible);
void MHEG5displayStackToBottom(MHEG5Root *visible);
void MHEG5displayStackPutBefore(MHEG5Root *target, MHEG5Root *refVisible);
void MHEG5displayStackPutBehind(MHEG5Root *target, MHEG5Root *refVisible);
MHEG5DisplayStackItem* MHEG5displayStackBottom(void);
MHEG5DisplayStackItem* MHEG5displayStackPrev(MHEG5DisplayStackItem *item);
MHEG5DisplayStackItem* MHEG5displayStackPrevVisible(MHEG5Root *visible);
MHEG5Root* MHEG5displayStackGetVisible(MHEG5DisplayStackItem *item);

void MHEG5applicationInit(MHEG5Application *application);


void MHEG5applicationFree(MHEG5Application *application);

/*
     Internal behaviours
 */
void MHEG5applicationPrepare(MHEG5Application *application);
void MHEG5applicationDestruct(MHEG5Application *application);
void MHEG5ActivateCurrentApplication(void);
void MHEG5applicationDeactivate(MHEG5Application *application);

/*
     Actions
 */
MHEG5ErrorCode MHEG5storePersistent(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5readPersistent(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5launch(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5spawn(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5quit(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5lockScreen(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5unlockScreen(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5getEngineSupport(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5setDesktopColour(MHEG5Root *target, MHEG5GList *params);

#ifndef MHEG5PROFILE_UK1_06
MHEG5ErrorCode MHEG5openConnection(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5closeConnection(MHEG5Root *target, MHEG5GList *params);
#endif 
/*
   Engine behaviours
 */
void MHEG5quitApp(void);

void MHEG5applicationClearGroupTargets(MHEG5Application *application,
   MHEG5Group *group);

void MHEG5applicationResolveTargets(MHEG5Application *application);

/* For CI interface */
void MHEG5applicationPush(MHEG5String groupid);


#endif /*_MH5APPLICATION_H*/