Implement the MHEG5 TokenManager Class 28 TokenManager Class Mix-in class that defines functions to manage the navigation of a logical token among a group of elements. The token may be used to give a special behaviour to one element in the group, such as the highlight in a jumping-highlight navigation scheme. Base class: None (mix-in) Subclasses: TokenGroup Status: Abstract class. More...

#include "mh5base.h"
#include "mh5root.h"

Classes
struct	sMHEG5IntList

struct	sMHEG5MovementTable

struct	MHEG5TokenManager

Typedefs
typedef struct sMHEG5IntList	MHEG5IntList

typedef struct sMHEG5MovementTable	MHEG5MovementTable

Functions
void	MHEG5tokenManagerInit (MHEG5TokenManager *tokenManager)
	<Function description>=""> More...

void	MHEG5tokenManagerPrepare (MHEG5TokenManager *tokenManager)
	Sets all internal attributes for the specified object to their default values. More...

void	MHEG5tokenManagerFree (MHEG5TokenManager *tokenManager)
	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	MHEG5tokenManagerAddRow (MHEG5TokenManager *tokenManager)
	Add a new row to a TokenManager. More...

void	MHEG5tokenManagerAddNumber (MHEG5TokenManager *tokenManager, MHEG5Int number)
	Insert a number into the last element of the movement table. More...

void	MHEG5tokenManagerCopy (MHEG5TokenManager destination, MHEG5TokenManager source)
	Copy a TokenManager object. The movement table of the TokenManager object is copied as well. More...

void	MHEG5tokenManagerDestruct (MHEG5TokenManager *tokenManager)
	Destruct a TokenManager object. More...

MHEG5ErrorCode	MHEG5move (MHEG5Root target, MHEG5GList params)
	Move the token between elements of the group. The movement to apply from any particular element location is described in the MovementTable attribute. Implementation of the Move (Target, MovementIdentifier) action of the TokenManager class. More...

MHEG5ErrorCode	MHEG5moveTo (MHEG5Root target, MHEG5GList params)
	Move the token to a specific element of the group. Implementation of the MoveTo (Target, Index) action of the TokenManager class. More...

MHEG5ErrorCode	MHEG5getTokenPosition (MHEG5Root target, MHEG5GList params)
	Set the Variable referenced by TokenPositionVar to the value of the TokenPosition attribute. Implementation of the GetTokenPosition (Target, TokenPositionVar) action of the TokenManager class. More...

Detailed Description

Implement the MHEG5 TokenManager Class 28 TokenManager Class Mix-in class that defines functions to manage the navigation of a logical token among a group of elements. The token may be used to give a special behaviour to one element in the group, such as the highlight in a jumping-highlight navigation scheme. Base class: None (mix-in) Subclasses: TokenGroup Status: Abstract class.

Date: 29/04/2002

Author: iwillis

Definition in file mh5tokenmanager.h.

Typedef Documentation

typedef struct sMHEG5IntList MHEG5IntList

typedef struct sMHEG5MovementTable MHEG5MovementTable

Function Documentation

MHEG5ErrorCode MHEG5getTokenPosition	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

Set the Variable referenced by TokenPositionVar to the value of the TokenPosition attribute. Implementation of the GetTokenPosition (Target, TokenPositionVar) action of the TokenManager class.

Parameters

MHEG5Root	*target
MHEG5GList	*params

Returns: MHEG5ErrorCode MHEG5ErrorCode

Definition at line 487 of file mh5tokenmanager.c.

MHEG5ErrorCode MHEG5move	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

Move the token between elements of the group. The movement to apply from any particular element location is described in the MovementTable attribute. Implementation of the Move (Target, MovementIdentifier) action of the TokenManager class.

Parameters

MHEG5Root	*target
MHEG5GList	* params

Returns: void MHEG5ErrorCode

Definition at line 383 of file mh5tokenmanager.c.

MHEG5ErrorCode MHEG5moveTo	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

Move the token to a specific element of the group. Implementation of the MoveTo (Target, Index) action of the TokenManager class.

Parameters

MHEG5Root	*target
MHEG5GList	*params

Returns: MHEG5ErrorCode MHEG5ErrorCode

Definition at line 451 of file mh5tokenmanager.c.

void MHEG5tokenManagerAddNumber	(	MHEG5TokenManager *	tokenManager,
		MHEG5Int	number
	)

Insert a number into the last element of the movement table.

Parameters

MHEG5TokenManager	*tokenManager
MHEG5Int	number

Returns: void

Definition at line 214 of file mh5tokenmanager.c.

void MHEG5tokenManagerAddRow ( MHEG5TokenManager * tokenManager )

Add a new row to a TokenManager.

Parameters

MHEG5TokenManager *tokenManager

Returns: void

Definition at line 183 of file mh5tokenmanager.c.

void MHEG5tokenManagerCopy	(	MHEG5TokenManager *	destination,
		MHEG5TokenManager *	source
	)

Copy a TokenManager object. The movement table of the TokenManager object is copied as well.

Parameters

MHEG5TokenManager	*destination
MHEG5TokenManager	*source

Returns: void

Definition at line 293 of file mh5tokenmanager.c.

void MHEG5tokenManagerDestruct ( MHEG5TokenManager * tokenManager )

Destruct a TokenManager object.

Parameters

MHEG5TokenManager *tokenManager

Returns: void

Definition at line 310 of file mh5tokenmanager.c.

void MHEG5tokenManagerFree ( MHEG5TokenManager * tokenManager )

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

tokenManager Pointer to object to free.

Returns: Void

Definition at line 154 of file mh5tokenmanager.c.

void MHEG5tokenManagerInit ( MHEG5TokenManager * tokenManager )

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

Parameters

tokenManager Pointer to object to initialise.

Returns: Void

Parameters

tokenManager Pointer to object to initialise.

Returns: Void

Definition at line 127 of file mh5tokenmanager.c.

void MHEG5tokenManagerPrepare ( MHEG5TokenManager * tokenManager )

Sets all internal attributes for the specified object to their default values.

Parameters

tokenManager Pointer to object to initialise internal attributes for.

Returns: Void

Definition at line 140 of file mh5tokenmanager.c.

Classes

Typedefs

Functions

Detailed Description

Typedef Documentation

Function Documentation