Implement the MHEG5 ListGroup Class Defines the location of list elements on the screen and theire internal storage within certain datastructures. |NOTE:| The ListGroup is implemented according to the technical changes and clarifications introduced in the DCOR. Base class: TokenGroup. Subclasses: None. Status: Concrete class. More...

#include "mh5tokengroup.h"

Classes
struct	sMHEG5PosList

struct	sMHEG5ItemList

struct	sMHEG5ListGroup

Typedefs
typedef struct sMHEG5PosList	MHEG5PosList

typedef struct sMHEG5ItemList	MHEG5ItemList

typedef struct sMHEG5ListGroup	MHEG5ListGroup

Functions
void	MHEG5listGroupInit (MHEG5ListGroup *listGroup)
	<Function description>=""> More...

void	MHEG5listGroupFree (MHEG5ListGroup *listGroup)
	Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed. More...

void	MHEG5listGroupAddPosition (MHEG5ListGroup *listGroup, MHEG5Int x, MHEG5Int y)
	Adds a new cell position to the ListGroup. More...

void	MHEG5listGroupPrepare (MHEG5ListGroup *listGroup)
	Implementation of the ListGroup Preparation behaviour. More...

void	MHEG5listGroupActivate (MHEG5ListGroup *listGroup)
	Implementation of the ListGroup Activation behaviour. More...

void	MHEG5listGroupDeactivate (MHEG5ListGroup *listGroup)
	Implementation of the ListGroup Deactivation behaviour. More...

void	MHEG5listGroupDestruct (MHEG5ListGroup *listGroup)
	Implementation of the ListGroup Destruction behaviour. More...

MHEG5ErrorCode	MHEG5addItem (MHEG5Root target, MHEG5GList params)
	Implementation of the ListGroup AddItem elementary action. More...

MHEG5ErrorCode	MHEG5delItem (MHEG5Root target, MHEG5GList params)
	Implementation of the ListGroup DelItem elementary action. More...

MHEG5ErrorCode	MHEG5getListItem (MHEG5Root target, MHEG5GList params)
	Implementation of the ListGroup GetListItem elementary action. More...

MHEG5ErrorCode	MHEG5getCellItem (MHEG5Root target, MHEG5GList params)
	Implementation of the ListGroup GetCellItem elementary action. More...

MHEG5ErrorCode	MHEG5getItemStatus (MHEG5Root target, MHEG5GList params)
	Implementation of the ListGroup GetItemStatus elementary action. More...

MHEG5ErrorCode	MHEG5selectItem (MHEG5Root target, MHEG5GList params)
	Implementation of the ListGroup SelectItem elementary action. More...

MHEG5ErrorCode	MHEG5deselectItem (MHEG5Root target, MHEG5GList params)
	Implementation of the ListGroup DeselectItem elementary action. More...

MHEG5ErrorCode	MHEG5toggleItem (MHEG5Root target, MHEG5GList params)
	Implementation of the ListGroup ToggleItem elementary action. More...

MHEG5ErrorCode	MHEG5scrollItems (MHEG5Root target, MHEG5GList params)
	Implementation of the ListGroup ScrollItems elementary action. More...

MHEG5ErrorCode	MHEG5setFirstItem (MHEG5Root target, MHEG5GList params)
	Implementation of the ListGroup SetFirstItem elementary action. More...

MHEG5ErrorCode	MHEG5getFirstItem (MHEG5Root target, MHEG5GList params)
	Implementation of the ListGroup GetFirstItem elementary action. More...

MHEG5ErrorCode	MHEG5getListSize (MHEG5Root target, MHEG5GList params)
	Implementation of the ListGroup GetListSize elementary action. More...

MHEG5ErrorCode	MHEG5setCellPosition (MHEG5Root target, MHEG5GList params)
	Implementation of the ListGroup SetCellPosition elementary action. More...

Detailed Description

Implement the MHEG5 ListGroup Class Defines the location of list elements on the screen and theire internal storage within certain datastructures. |NOTE:| The ListGroup is implemented according to the technical changes and clarifications introduced in the DCOR. Base class: TokenGroup. Subclasses: None. Status: Concrete class.

Date: 01/02/2002

Author: R.Freeman

Function Documentation

MHEG5ErrorCode MHEG5addItem	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

Implementation of the ListGroup AddItem elementary action.

Parameters

target	target object for this action
params	Action parameters

Returns: MHEG5ErrorCode - See mh5base.h

MHEG5ErrorCode MHEG5delItem	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

Implementation of the ListGroup DelItem elementary action.

Parameters

target	target object for this action
params	Action parameters

Returns: MHEG5ErrorCode - See mh5base.h

MHEG5ErrorCode MHEG5deselectItem	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

Implementation of the ListGroup DeselectItem elementary action.

Parameters

target	target object for this action
params	Action parameters

Returns: MHEG5ErrorCode - See mh5base.h

MHEG5ErrorCode MHEG5getCellItem	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

Implementation of the ListGroup GetCellItem elementary action.

Parameters

target	target object for this action
params	Action parameters

Returns: MHEG5ErrorCode - See mh5base.h

MHEG5ErrorCode MHEG5getFirstItem	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

Implementation of the ListGroup GetFirstItem elementary action.

Parameters

target	target object for this action
params	Action parameters

Returns: MHEG5ErrorCode - See mh5base.h

MHEG5ErrorCode MHEG5getItemStatus	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

Implementation of the ListGroup GetItemStatus elementary action.

Parameters

target	target object for this action
params	Action parameters

Returns: MHEG5ErrorCode - See mh5base.h

MHEG5ErrorCode MHEG5getListItem	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

Implementation of the ListGroup GetListItem elementary action.

Parameters

target	target object for this action
params	Action parameters

Returns: MHEG5ErrorCode - See mh5base.h

MHEG5ErrorCode MHEG5getListSize	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

Implementation of the ListGroup GetListSize elementary action.

Parameters

target	target object for this action
params	Action parameters

Returns: MHEG5ErrorCode - See mh5base.h

void MHEG5listGroupActivate ( MHEG5ListGroup * listGroup )

Implementation of the ListGroup Activation behaviour.

Parameters

listGroup Pointer to the target ListGroup

Returns: void

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

Adds a new cell position to the ListGroup.

Parameters

listGroup	Pointer to the target ListGroup
x	X position of cell
y	Y position of cell

Returns: void

void MHEG5listGroupDeactivate ( MHEG5ListGroup * listGroup )

Implementation of the ListGroup Deactivation behaviour.

Parameters

listGroup Pointer to the target ListGroup

Returns: void

void MHEG5listGroupDestruct ( MHEG5ListGroup * listGroup )

Implementation of the ListGroup Destruction behaviour.

Parameters

listGroup Pointer to the target ListGroup

Returns: void

void MHEG5listGroupFree ( MHEG5ListGroup * listGroup )

Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed.

Parameters

listGroup Pointer to object to free.

Returns: Void

void MHEG5listGroupInit ( MHEG5ListGroup * listGroup )

Returns: <Return value>=""> Initialise a listGroup object with default values.

Parameters

listGroup Pointer to object to initialise.

Returns: Void

void MHEG5listGroupPrepare ( MHEG5ListGroup * listGroup )

Implementation of the ListGroup Preparation behaviour.

Parameters

listGroup Pointer to the target ListGroup

Returns: void

MHEG5ErrorCode MHEG5scrollItems	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

Implementation of the ListGroup ScrollItems elementary action.

Parameters

target	target object for this action
params	Action parameters

Returns: MHEG5ErrorCode - See mh5base.h

MHEG5ErrorCode MHEG5selectItem	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

Implementation of the ListGroup SelectItem elementary action.

Parameters

target	target object for this action
params	Action parameters

Returns: MHEG5ErrorCode - See mh5base.h

MHEG5ErrorCode MHEG5setCellPosition	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

Implementation of the ListGroup SetCellPosition elementary action.

Parameters

target	target object for this action
params	Action parameters

Returns: MHEG5ErrorCode - See mh5base.h

MHEG5ErrorCode MHEG5setFirstItem	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

Implementation of the ListGroup SetFirstItem elementary action.

Parameters

target	target object for this action
params	Action parameters

Returns: MHEG5ErrorCode - See mh5base.h

MHEG5ErrorCode MHEG5toggleItem	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

Implementation of the ListGroup ToggleItem elementary action.

Parameters

target	target object for this action
params	Action parameters

Returns: MHEG5ErrorCode - See mh5base.h

Classes

Typedefs

Functions

Detailed Description

Function Documentation