mh5link.h File Reference

Implement the MHEG5 Link Class. Defines the functionality associated with reacting to events by performing a sequence of elementary actions. Base class: Ingredient Subclasses: None Status: Concrete class. More...

#include "mh5ingredient.h"
#include "mh5action.h"

Go to the source code of this file.

Data Structures
struct	sMHEG5Link

Macros
#define	HTEXT_TOP_STR   1
#define	HTEXT_BOT_STR   2

Typedefs
typedef struct sMHEG5Link	MHEG5Link

Functions
void	MHEG5linkInit (MHEG5Link *link)
	<Function description>=""> More...
void	MHEG5linkFree (MHEG5Link *link)
	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	MHEG5linkPrepare (MHEG5Link *link)
void	MHEG5linkDestruct (MHEG5Link *link)
void	MHEG5linkActivate (MHEG5Link *link)
void	MHEG5linkDeactivate (MHEG5Link *link)
U8BIT *	MHEG5linkEventName (MHEG5Link *link)
MHEG5ErrorCode	MHEG5activate (MHEG5Root *target, MHEG5GList *params)
MHEG5ErrorCode	MHEG5deactivate (MHEG5Root *target, MHEG5GList *params)
int	LNK_RegisterString (MHEG5String s)
int	LNK_GetStringIndex (MHEG5String s)
MHEG5String	LNK_GetString (int i)
void	initialiseActiveLinkQs (void)
	<Function description>=""> More...

Variables
MHEG5Link *	activeLinksHead [MHEG5LASTEVENT+1]
unsigned int	existsLinkCount [MHEG5LASTEVENT+1]

Detailed Description

Implement the MHEG5 Link Class. Defines the functionality associated with reacting to events by performing a sequence of elementary actions. Base class: Ingredient Subclasses: None Status: Concrete class.

Date

05/02/2002

Author

R.Freeman

Macro Definition Documentation

#define HTEXT_BOT_STR   2

#define HTEXT_TOP_STR   1

Typedef Documentation

typedef struct sMHEG5Link MHEG5Link

Function Documentation

void initialiseActiveLinkQs

(

void

)

<Function description>="">

Returns

<Return value>="">

MHEG5String LNK_GetString

(

int

i

)

int LNK_GetStringIndex

(

MHEG5String

s

)

int LNK_RegisterString

(

MHEG5String

s

)

MHEG5ErrorCode MHEG5activate	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

MHEG5ErrorCode MHEG5deactivate	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

void MHEG5linkActivate

(

MHEG5Link *

link

)

void MHEG5linkDeactivate

(

MHEG5Link *

link

)

void MHEG5linkDestruct

(

MHEG5Link *

link

)

U8BIT* MHEG5linkEventName

(

MHEG5Link *

link

)

void MHEG5linkFree

(

MHEG5Link *

link

)

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

link	Pointer to object to free.

Returns

Void

void MHEG5linkInit

(

MHEG5Link *

link

)

<Function description>="">

Returns

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

Parameters

link	Pointer to object to initialise.

Returns

Void

<Function description>="">

Parameters

link	Pointer to object to initialise.

Returns

Void

void MHEG5linkPrepare

(

MHEG5Link *

link

)

Variable Documentation

MHEG5Link* activeLinksHead[MHEG5LASTEVENT+1]

unsigned int existsLinkCount[MHEG5LASTEVENT+1]