source/classes/src/mh5button.c File Reference

Implement the MHEG5 Button Class Description Defines functionality associated with the rendering and interaction with one-state and two-state buttons. Base class: Visible , Interactible Subclasses: Hotspot , PushButton Status: Abstract class. More...

#include "mh5profile.h"
#include "mh5button.h"
#include "mh5object.h"
#include "mh5variable.h"
#include "mh5display.h"
#include "mh5application.h"
#include "mh5queue.h"
#include "mh5debug.h"

Functions
void	MHEG5buttonInit (MHEG5Button *button)
	<Function description>="">
void	MHEG5buttonFree (MHEG5Button *button)
	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	MHEG5buttonPrepare (MHEG5Button *button)
	Apply the preparation behaviour of the button class Apply the preparation behaviour of the button class. As this class has no own preparation behaviour this function just invokes the preparation behaviour from the base class.
void	MHEG5buttonActivate (MHEG5Button *button)
	Apply the activation behaviour of the button class. As this class has no own activation behaviour this function just invokes the activation behaviour from the base class.
void	MHEG5buttonDeactivate (MHEG5Button *button)
	Apply the deactivation behaviour of the button class. As this class has no own deactivation behaviour this function just invokes the deactivation behaviour from the base class.
void	MHEG5buttonDestruct (MHEG5Button *button)
	Destruct a button object.
MHEG5ErrorCode	MHEG5select (MHEG5Root *target, MHEG5GList *params)
	The effect of this action is to select a button. Implementation of the Select action of the button class.
MHEG5ErrorCode	MHEG5deselect (MHEG5Root *target, MHEG5GList *params)
	The effect of this action is to deselect the button. Implementation of the Deselect action of the button class.

---

Detailed Description

Implement the MHEG5 Button Class Description Defines functionality associated with the rendering and interaction with one-state and two-state buttons. Base class: Visible , Interactible Subclasses: Hotspot , PushButton Status: Abstract class.

Date:

22/04/2002

Author:

iwillis

---

Function Documentation

void MHEG5buttonActivate

(

MHEG5Button *

button

)

Apply the activation behaviour of the button class. As this class has no own activation behaviour this function just invokes the activation behaviour from the base class.

Parameters:

MHEG5Button

*button

Returns:

void

void MHEG5buttonDeactivate

(

MHEG5Button *

button

)

Apply the deactivation behaviour of the button class. As this class has no own deactivation behaviour this function just invokes the deactivation behaviour from the base class.

Parameters:

MHEG5Button

*button

Returns:

void

void MHEG5buttonDestruct

(

MHEG5Button *

button

)

Destruct a button object.

Parameters:

MHEG5Button

*button

Returns:

void

void MHEG5buttonFree

(

MHEG5Button *

button

)

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:

button

Pointer to object to free.

Returns:

Void

void MHEG5buttonInit

(

MHEG5Button *

button

)

<Function description>="">

Returns:

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

Parameters:

button

Pointer to object to initialise.

Returns:

Void

void MHEG5buttonPrepare

(

MHEG5Button *

button

)

Apply the preparation behaviour of the button class Apply the preparation behaviour of the button class. As this class has no own preparation behaviour this function just invokes the preparation behaviour from the base class.

Parameters:

MHEG5Button

*button

Returns:

void

MHEG5ErrorCode MHEG5deselect	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

The effect of this action is to deselect the button. Implementation of the Deselect action of the button class.

Parameters:

MHEG5Root	*target
MHEG5GList	*params

Returns:

MHEG5ErrorCode MHEG5ErrorCode

MHEG5ErrorCode MHEG5select	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

The effect of this action is to select a button. Implementation of the Select action of the button class.

Parameters:

MHEG5Root	*target
MHEG5GList	*params

Returns:

MHEG5ErrorCode MHEG5ErrorCode