mh5switchbutton.h File Reference

Implement the MHEG5 SwitchButton Class. Defines the behaviour of pressable buttons. Base class: PushButton. Subclasses: None. Status: Concrete class. More...

#include "mh5pushbutton.h"

Go to the source code of this file.

Classes
struct	MHEG5Switchbutton

Functions
void	MHEG5switchbuttonInit (MHEG5Switchbutton *switchbutton)
	<Function description>=""> More...
void	MHEG5switchbuttonFree (MHEG5Switchbutton *switchbutton)
	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	MHEG5switchbuttonPrepare (MHEG5Switchbutton *switchbutton)
	Apply the preparation behaviour of the switchbutton class Apply the preparation behaviour of the switchbutton class. As this class has no own preparation behaviour this function just invokes the preparation behaviour from the base class. More...
void	MHEG5switchbuttonActivate (MHEG5Switchbutton *switchbutton)
	Apply the activation behaviour of the switchbutton class. As this class has no own activation behaviour this function just invokes the activation behaviour from the base class. More...
void	MHEG5switchbuttonDeactivate (MHEG5Switchbutton *switchbutton)
	Apply the deactivation behaviour of the switchbutton class. As this class has no own deactivation behaviour this function just invokes the deactivation behaviour from the base class. More...
void	MHEG5switchbuttonDestruct (MHEG5Switchbutton *switchbutton)
	Destruct a switchbutton object. More...
MHEG5ErrorCode	MHEG5toggle (MHEG5Root *target, MHEG5GList *params)
	The effect of this action is to toggle the selection state of the switchbutton. Implementation of the Toggle (target) action of the switchbutton class. If the switchbutton is selected, it is deselected and vice versa. More...
MHEG5ErrorCode	MHEG5getSelectionStatus (MHEG5Root *target, MHEG5GList *params)
	Implementation of the GetSelectionStatus action. More...

Detailed Description

Implement the MHEG5 SwitchButton Class. Defines the behaviour of pressable buttons. Base class: PushButton. Subclasses: None. Status: Concrete class.

Date

01/02/2002

Author

R.Freeman

Function Documentation

MHEG5ErrorCode MHEG5getSelectionStatus	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

Implementation of the GetSelectionStatus action.

Parameters

target	target object for this action
params	Linked list of action parameters

Returns

MHEG5ErrorCode

void MHEG5switchbuttonActivate

(

MHEG5Switchbutton *

switchbutton

)

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

Parameters

MHEG5Switchbutton

*switchbutton

Returns

void

void MHEG5switchbuttonDeactivate

(

MHEG5Switchbutton *

switchbutton

)

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

Parameters

MHEG5Switchbutton

*switchbutton

Returns

void

void MHEG5switchbuttonDestruct

(

MHEG5Switchbutton *

switchbutton

)

Destruct a switchbutton object.

Parameters

MHEG5Switchbutton

*switchbutton

Returns

void

void MHEG5switchbuttonFree

(

MHEG5Switchbutton *

switchbutton

)

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

switchbutton

Pointer to object to free.

Returns

Void

void MHEG5switchbuttonInit

(

MHEG5Switchbutton *

switchbutton

)

<Function description>="">

Returns

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

Parameters

switchbutton

Pointer to object to initialise.

Returns

Void

<Function description>="">

Parameters

switchbutton

Pointer to object to initialise.

Returns

Void

void MHEG5switchbuttonPrepare

(

MHEG5Switchbutton *

switchbutton

)

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

Parameters

MHEG5Switchbutton

*switchbutton

Returns

void

MHEG5ErrorCode MHEG5toggle	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

The effect of this action is to toggle the selection state of the switchbutton. Implementation of the Toggle (target) action of the switchbutton class. If the switchbutton is selected, it is deselected and vice versa.

Parameters

MHEG5Root	*target
MHEG5GList	*params

Returns

MHEG5ErrorCode MHEG5ErrorCode