source/classes/inc/mh5listgroup.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 _MH5LISTGROUP_H_
#define _MH5LISTGROUP_H_

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

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

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

/*---Global type defs for public use-----------------------------------------*/
struct sMHEG5PosList
{
   MHEG5IntPair position;
   struct sMHEG5PosList *next;
};

typedef struct sMHEG5PosList MHEG5PosList;

struct sMHEG5ItemList
{
   MHEG5Int id;
   MH5GroupRef groupRef;
   MHEG5Bool itemSelectionStatus;
   MHEG5Int visibleIndex;           /* Internal flag */
   struct sMHEG5ItemList *next;
};

typedef struct sMHEG5ItemList MHEG5ItemList;

typedef struct sMHEG5ListGroup
{
   /* Base class */
   MHEG5TokenGroup tokenGroup;

   /* Exchanged attributes */
   MHEG5PosList *originalPositions;
   MHEG5Bool wrapAround;
   MHEG5Bool multipleSelection;

   /* Internal attributes */
   MHEG5PosList *positions;
   MHEG5ItemList *itemList;
   MHEG5Int firstItem;

   /* Engine data */
   MHEG5Int positionCount;
   MHEG5Int itemCount;
   MHEG5Bool firstItemVisible;
   MHEG5Bool lastItemVisible;
} MHEG5ListGroup;

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

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

void MHEG5listGroupInit(MHEG5ListGroup *listGroup);


void MHEG5listGroupFree(MHEG5ListGroup *listGroup);


void MHEG5listGroupAddPosition(MHEG5ListGroup *listGroup, MHEG5Int x, MHEG5Int y);


void MHEG5listGroupPrepare(MHEG5ListGroup *listGroup);


void MHEG5listGroupActivate(MHEG5ListGroup *listGroup);


void MHEG5listGroupDeactivate(MHEG5ListGroup *listGroup);


void MHEG5listGroupDestruct(MHEG5ListGroup *listGroup);


/*
     Actions
 */
MHEG5ErrorCode MHEG5addItem(MHEG5Root *target, MHEG5GList *params);


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


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


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


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


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


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


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


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


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


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


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


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


/*
   Debug
 */
#ifdef MH5PRINTOUT
void MHEG5listGroupPrint(MHEG5ListGroup *listGroup, char *out);
#endif

#endif /*_MH5LISTGROUP_H_*/