source/classes/inc/mh5tokengroup.h File Reference

Implement the MHEG5 Tokengroup Class 29 TokenGroup Class. Defines a group of Visible objects for navigation. Each Visible object in the group may hold a token, as defined in the TokenManager class. On the basis of the events that are generated when that token moves, a special behaviour for the Visible that holds the token may be implemented, such as a highlight. Base class: Presentable, TokenManager. Subclasses: ListGroup. Status: Concrete class. More...

#include "mh5tokenmanager.h"
#include "mh5presentable.h"
#include "mh5action.h"

Go to the source code of this file.

Data Structures
struct	sMHEG5TokenSlot
struct	MHEG5TokenGroup
Typedefs
typedef struct sMHEG5TokenSlot	MHEG5TokenSlot
Functions
void	MHEG5tokenGroupFree (MHEG5TokenGroup *tokenGroup)
	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.
void	MHEG5tokenGroupPrepare (MHEG5TokenGroup *tokenGroup)
void	MHEG5tokenGroupActivate (MHEG5TokenGroup *tokenGroup)
void	MHEG5tokenGroupDeactivate (MHEG5TokenGroup *tokenGroup)
void	MHEG5tokenGroupDestruct (MHEG5TokenGroup *tokenGroup)
MHEG5ErrorCode	MHEG5callActionSlot (MHEG5Root *target, MHEG5GList *params)

---

Detailed Description

Implement the MHEG5 Tokengroup Class 29 TokenGroup Class. Defines a group of Visible objects for navigation. Each Visible object in the group may hold a token, as defined in the TokenManager class. On the basis of the events that are generated when that token moves, a special behaviour for the Visible that holds the token may be implemented, such as a highlight. Base class: Presentable, TokenManager. Subclasses: ListGroup. Status: Concrete class.

Date:

01/02/2002

Author:

R.Freeman

---

Function Documentation

void MHEG5tokenGroupFree

(

MHEG5TokenGroup *

tokenGroup

)

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:

tokenGroup

Pointer to object to free.

Returns:

Void

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.

Returns:

<Return value>=""> 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:

tokenGroup

Pointer to object to free.

Returns:

Void