mh5hypertext.h File Reference

Implement the MHEG5 Hypertext Class. The HyperText class is a subclass of the Text class, with the special property of allowing for portions of the text to be associated with a piece of information. These portions of text are called anchors in the rest of this clause. Base classes: Text, Interactible. Subclasses: None. Status: Concrete class. More...

#include "mh5text.h"
#include "mh5interactible.h"

Go to the source code of this file.

Data Structures
struct	MHEG5Hypertext

Functions
void	MHEG5hypertextInit (MHEG5Hypertext *hypertext)
	<Function description>=""> More...
void	MHEG5hypertextFree (MHEG5Hypertext *hypertext)
	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	MHEG5hypertextPrepare (MHEG5Hypertext *hypertext)
void	MHEG5hypertextActivate (MHEG5Hypertext *hypertext)
void	MHEG5hypertextDeactivate (MHEG5Hypertext *hypertext)
void	MHEG5hypertextDestruct (MHEG5Hypertext *hypertext)
void	MHEG5hyperTextInitCurrentLink (MHEG5Hypertext *hypertext)
void	MHEG5hypertextUP (MHEG5Hypertext *hypertext)
void	MHEG5hypertextDOWN (MHEG5Hypertext *hypertext)
void	MHEG5hypertextSELECT (MHEG5Hypertext *hypertext)
MHEG5ErrorCode	MHEG5getLastAnchorFired (MHEG5Root *target, MHEG5GList *params)
MHEG5ErrorCode	MHEG5getFocusPosition (MHEG5Root *target, MHEG5GList *params)
MHEG5ErrorCode	MHEG5setFocusPosition (MHEG5Root *target, MHEG5GList *params)

Detailed Description

Implement the MHEG5 Hypertext Class. The HyperText class is a subclass of the Text class, with the special property of allowing for portions of the text to be associated with a piece of information. These portions of text are called anchors in the rest of this clause. Base classes: Text, Interactible. Subclasses: None. Status: Concrete class.

Date

01/02/2002

Author

R.Freeman

Function Documentation

void MHEG5hypertextDOWN

(

MHEG5Hypertext *

hypertext

)

Parameters

hypertext

Pointer to hypertext object.

Returns

Void

void MHEG5hypertextFree

(

MHEG5Hypertext *

hypertext

)

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

hypertext

Pointer to object to free.

Returns

Void

void MHEG5hypertextInit

(

MHEG5Hypertext *

hypertext

)

<Function description>="">

Returns

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

Parameters

hypertext

Pointer to object to initialise.

Returns

Void

<Function description>="">

Parameters

hypertext

Pointer to object to initialise.

Returns

Void

void MHEG5hypertextUP

(

MHEG5Hypertext *

hypertext

)

Parameters

hypertext

Pointer to hypertext object.

Returns

Void