Implement the MHEG5 Slider Class Description Slider Class Defines the behaviour of sliders. Base class: Visible, Interactible Subclasses: None Status: Concrete class. More...

#include "mh5slider.h"
#include "mh5scene.h"
#include "mh5object.h"
#include "mh5variable.h"
#include "mh5display.h"
#include "mh5application.h"
#include "mh5queue.h"
#include "mh5memory.h"
#include "mh5debug.h"

Functions
void	MHEG5sliderInit (MHEG5Slider *slider)
	<Function description>=""> More...

void	MHEG5sliderFree (MHEG5Slider *slider)
	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	MHEG5sliderPrepare (MHEG5Slider *slider)
	Apply the preparation behaviour of the slider class Apply the preparation behaviour of the slider class. As this class has no own preparation behaviour this function just invokes the preparation behaviour from the base class. More...

void	MHEG5sliderActivate (MHEG5Slider *slider)
	Apply the activation behaviour of the slider class. As this class has no own activation behaviour this function just invokes the activation behaviour from the base class. More...

void	MHEG5sliderDeactivate (MHEG5Slider *slider)
	Apply the deactivation behaviour of the slider class. As this class has no own deactivation behaviour this function just invokes the deactivation behaviour from the base class. More...

void	MHEG5sliderDestruct (MHEG5Slider *slider)
	Destruct a slider object. More...

MHEG5ErrorCode	MHEG5step (MHEG5Root target, MHEG5GList params)
	The effect of this action is to modify the SliderValue of the target by the number given. Implementation of the Step (Target, NbOfSteps) action of the slider class. More...

MHEG5ErrorCode	MHEG5setSliderValue (MHEG5Root target, MHEG5GList params)
	The effect of this action is to set the SliderValue to the given value. Implementation of the SetSliderValue (Target, NewSliderValue) action of the slider class. More...

MHEG5ErrorCode	MHEG5getSliderValue (MHEG5Root target, MHEG5GList params)
	This action retrieves the SliderValue from the target and stores it in the variable, passed as the second parameter of this action. Implementation of the GetSliderValue (Target, SliderValueVar) action of the slider class. More...

MHEG5ErrorCode	MHEG5setPortion (MHEG5Root target, MHEG5GList params)
	This action sets the portion of the slider to a new value, given as the second parameter to this action. Implementation of the SetPortion (Target, NewPortion) action of the slider class. More...

MHEG5ErrorCode	MHEG5getPortion (MHEG5Root target, MHEG5GList params)
	This action retrieves the size of the slider portion and stores it in the PortionVar, which is passed to this action as the second parameter. Implementation of the GetPortion (Target, PortionVar) action of the slider class. More...

MHEG5ErrorCode	MHEG5setSliderParameters (MHEG5Root target, MHEG5GList params)
	The effect of this action is to set the MinValue, MaxValue and StepSize to the given values. Implementation of the MHEG5setSliderParameters (Target, NewMinValue, NewMaxValue, NewStepSize) action of the slider class. More...

void	MHEG5sliderLEFT (MHEG5Slider *slider)
	Perform action of left arrow key on interacting Slider. More...

void	MHEG5sliderUP (MHEG5Slider *slider)
	Perform action of up arrow key on interacting Slider. More...

void	MHEG5sliderRIGHT (MHEG5Slider *slider)
	Perform action of right arrow key on interacting Slider. More...

void	MHEG5sliderDOWN (MHEG5Slider *slider)
	Perform action of down arrow key on interacting Slider. More...

void	MHEG5sliderSELECT (MHEG5Slider *slider)
	Perform action of select key on interacting Slider. More...

void	MHEG5sliderEXIT (MHEG5Slider *slider)
	Perform action of exit key on interacting Slider. More...

Detailed Description

Implement the MHEG5 Slider Class Description Slider Class Defines the behaviour of sliders. Base class: Visible, Interactible Subclasses: None Status: Concrete class.

Date: 22/04/2002

Author: iwillis

Function Documentation

MHEG5ErrorCode MHEG5getPortion	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

This action retrieves the size of the slider portion and stores it in the PortionVar, which is passed to this action as the second parameter. Implementation of the GetPortion (Target, PortionVar) action of the slider class.

Parameters

MHEG5Root	*target
MHEG5GList	*params

Returns: MHEG5ErrorCode MHEG5ErrorCode

MHEG5ErrorCode MHEG5getSliderValue	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

This action retrieves the SliderValue from the target and stores it in the variable, passed as the second parameter of this action. Implementation of the GetSliderValue (Target, SliderValueVar) action of the slider class.

Parameters

MHEG5Root	*target
MHEG5GList	*params

Returns: MHEG5ErrorCode MHEG5ErrorCode

MHEG5ErrorCode MHEG5setPortion	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

This action sets the portion of the slider to a new value, given as the second parameter to this action. Implementation of the SetPortion (Target, NewPortion) action of the slider class.

Parameters

MHEG5Root	*target
MHEG5GList	*params

Returns: MHEG5ErrorCode MHEG5ErrorCode

MHEG5ErrorCode MHEG5setSliderParameters	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

The effect of this action is to set the MinValue, MaxValue and StepSize to the given values. Implementation of the MHEG5setSliderParameters (Target, NewMinValue, NewMaxValue, NewStepSize) action of the slider class.

Parameters

MHEG5Root	*target
MHEG5GList	*params

Returns: MHEG5ErrorCode MHEG5ErrorCode

MHEG5ErrorCode MHEG5setSliderValue	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

The effect of this action is to set the SliderValue to the given value. Implementation of the SetSliderValue (Target, NewSliderValue) action of the slider class.

Parameters

MHEG5Root	*target
MHEG5GList	*params

Returns: MHEG5ErrorCode MHEG5ErrorCode

void MHEG5sliderActivate ( MHEG5Slider * slider )

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

Parameters

MHEG5Slider *slider

Returns: void

void MHEG5sliderDeactivate ( MHEG5Slider * slider )

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

Parameters

MHEG5Slider *slider

Returns: void

void MHEG5sliderDestruct ( MHEG5Slider * slider )

Destruct a slider object.

Parameters

MHEG5Slider *slider

Returns: void

void MHEG5sliderDOWN ( MHEG5Slider * slider )

Perform action of down arrow key on interacting Slider.

Parameters

slider Slider object to apply key press to

Returns: Void

void MHEG5sliderEXIT ( MHEG5Slider * slider )

Perform action of exit key on interacting Slider.

Parameters

slider Slider object to apply key press to

Returns: Void

void MHEG5sliderFree ( MHEG5Slider * slider )

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

slider Pointer to object to free.

Returns: Void

void MHEG5sliderInit ( MHEG5Slider * slider )

Returns: <Return value>=""> Initialise a slider object with default values.

Parameters

slider Pointer to object to initialise.

Returns: Void

void MHEG5sliderLEFT ( MHEG5Slider * slider )

Perform action of left arrow key on interacting Slider.

Parameters

slider Slider object to apply key press to

Returns: Void

void MHEG5sliderPrepare ( MHEG5Slider * slider )

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

Parameters

MHEG5Slider *slider

Returns: void

void MHEG5sliderRIGHT ( MHEG5Slider * slider )

Perform action of right arrow key on interacting Slider.

Parameters

slider Slider object to apply key press to

Returns: Void

void MHEG5sliderSELECT ( MHEG5Slider * slider )

Perform action of select key on interacting Slider.

Parameters

slider Slider object to apply key press to

Returns: Void

void MHEG5sliderUP ( MHEG5Slider * slider )

Perform action of up arrow key on interacting Slider.

Parameters

slider Slider object to apply key press to

Returns: Void

MHEG5ErrorCode MHEG5step	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

The effect of this action is to modify the SliderValue of the target by the number given. Implementation of the Step (Target, NbOfSteps) action of the slider class.

Parameters

MHEG5Root	*target
MHEG5GList	*params

Returns: MHEG5ErrorCode MHEG5ErrorCode

Functions

Detailed Description

Function Documentation