source/classes/inc/mh5tokenmanager.h File Reference

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"

Go to the source code of this file.

Data Structures
struct	sMHEG5IntList
struct	sMHEG5MovementTable
struct	MHEG5TokenManager
Typedefs
typedef struct sMHEG5IntList	MHEG5IntList
typedef struct sMHEG5MovementTable	MHEG5MovementTable
Functions
void	MHEG5tokenManagerInit (MHEG5TokenManager *tokenManager)
	<Function description>="">
void	MHEG5tokenManagerPrepare (MHEG5TokenManager *tokenManager)
	Sets all internal attributes for the specified object to their default values.
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.
void	MHEG5tokenManagerAddRow (MHEG5TokenManager *tokenManager)
void	MHEG5tokenManagerAddNumber (MHEG5TokenManager *tokenManager, MHEG5Int number)
void	MHEG5tokenManagerCopy (MHEG5TokenManager *destination, MHEG5TokenManager *source)
void	MHEG5tokenManagerDestruct (MHEG5TokenManager *tokenManager)
MHEG5ErrorCode	MHEG5move (MHEG5Root *target, MHEG5GList *params)
MHEG5ErrorCode	MHEG5moveTo (MHEG5Root *target, MHEG5GList *params)
MHEG5ErrorCode	MHEG5getTokenPosition (MHEG5Root *target, MHEG5GList *params)

---

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

---

Function Documentation

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

void MHEG5tokenManagerInit

(

MHEG5TokenManager *

tokenManager

)

<Function description>="">

Returns:

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

Parameters:

tokenManager

Pointer to object to initialise.

Returns:

Void

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