Ewl_Range: A Value Selector from a Range

Detailed Description

Defines an Ewl_Widget with a draggable button enclosed, used to select a value from a range.

Remarks:: Inherits from Ewl_Container.

Tutorial


Data Structures
struct	Ewl_Range
	Inherits from Ewl_Container and extends to provide a basic range widget. More...
Defines
#define	EWL_RANGE(range) ((Ewl_Range *) range)
#define	EWL_RANGE_IS(w) (ewl_widget_type_is(EWL_WIDGET(w), EWL_RANGE_TYPE))
#define	EWL_RANGE_TYPE "range"
Typedefs
typedef Ewl_Range	Ewl_Range
Functions
void	ewl_range_decrease (Ewl_Range *r)
	Decrease the value of a range by it's step size.
void	ewl_range_increase (Ewl_Range *r)
	Increase the value of a range by it's step size.
int	ewl_range_init (Ewl_Range *r)
	Initialize the range to some sane starting values.
unsigned int	ewl_range_invert_get (Ewl_Range *r)
	Retrieve the current invert value from a range.
void	ewl_range_invert_set (Ewl_Range *r, unsigned int invert)
	Changes the invert property on the range for inverting it's scale.
double	ewl_range_maximum_value_get (Ewl_Range *r)
	Retrieves the maximum value for the range.
void	ewl_range_maximum_value_set (Ewl_Range *r, double maxv)
	Set the maximum value possible for a range.
double	ewl_range_minimum_value_get (Ewl_Range *r)
	Retrieves the minimum value for the range.
void	ewl_range_minimum_value_set (Ewl_Range *r, double minv)
	Set the minimum value possible for a range.
double	ewl_range_step_get (Ewl_Range *r)
	Retrieve the step size of the range.
void	ewl_range_step_set (Ewl_Range *r, double step)
	Set the steps between increments.
unsigned int	ewl_range_unknown_get (Ewl_Range *r)
	Retrieve the current unknown value from a range.
void	ewl_range_unknown_set (Ewl_Range *r, unsigned int unknown)
	Change the unknown property of the range if you do not know the max/min values.
double	ewl_range_value_get (Ewl_Range *r)
	Retrieve the current value of the range.
void	ewl_range_value_set (Ewl_Range *r, double v)
	Set the value of pointer of the range.

Define Documentation

#define EWL_RANGE ( range ) ((Ewl_Range *) range)

Typecasts a pointer to an Ewl_Range pointer.

#define EWL_RANGE_IS ( w ) (ewl_widget_type_is(EWL_WIDGET(w), EWL_RANGE_TYPE))

Returns TRUE if the widget is an Ewl_Range, FALSE otherwise

#define EWL_RANGE_TYPE "range"

The type name for the Ewl_Range widget

Typedef Documentation

typedef struct Ewl_Range Ewl_Range

The Ewl_Range provides a means to select a value from a range using a draggable button.

Function Documentation

void ewl_range_decrease ( Ewl_Range * r )

Decrease the value of a range by it's step size.

Parameters:

r,:

the range to decrease

Returns:: Returns no value.

Decreases the value of the range r by one increment of it's step size.

void ewl_range_increase ( Ewl_Range * r )

Increase the value of a range by it's step size.

Parameters:

r,:

the range to increase

Returns:: Returns no value.

Increases the value of the range r by one increment of it's step size.

int ewl_range_init ( Ewl_Range * r )

Initialize the range to some sane starting values.

Parameters:

r,:

the range to be initialized

Returns:: Returns no value.

Note:: There is no ewl_range_new(), becasue range only serves as a common API for seeker, spinner and progressbar

unsigned int ewl_range_invert_get ( Ewl_Range * r )

Retrieve the current invert value from a range.

Parameters:

r,:

the range to retrieve invert property value

Returns:: Returns the current value of the invert property in the range.

void ewl_range_invert_set	(	Ewl_Range *	r,
		unsigned int	invert
	)

Changes the invert property on the range for inverting it's scale.

Parameters:

	r,:	the range to set invert property
	invert,:	the new value for the ranges invert property

Returns:: Returns no value.

double ewl_range_maximum_value_get ( Ewl_Range * r )

Retrieves the maximum value for the range.

Parameters:

r,:

the range to retrieve maximum value

Returns:: Returns the currently set maximum value for the specified range.

void ewl_range_maximum_value_set	(	Ewl_Range *	r,
		double	maxv
	)

Set the maximum value possible for a range.

Parameters:

	r,:	the range to change the maximum possible value
	maxv,:	the new maximum possible value for r

Returns:: Returns no value.

Sets the smallest value that r can obtain to maxv.

double ewl_range_minimum_value_get ( Ewl_Range * r )

Retrieves the minimum value for the range.

Parameters:

r,:

the range to retrieve minimum value

Returns:: Returns the currently set minimum value for the specified range.

void ewl_range_minimum_value_set	(	Ewl_Range *	r,
		double	minv
	)

Set the minimum value possible for a range.

Parameters:

	r,:	the range to change the minimum possible value
	minv,:	the new minimum possible value for r

Returns:: Returns no value.

Sets the smallest value that r can obtain to minv.

double ewl_range_step_get ( Ewl_Range * r )

Retrieve the step size of the range.

Parameters:

r,:

the range to retrieve step size

Returns:: Returns the step size of the range r.

void ewl_range_step_set	(	Ewl_Range *	r,
		double	step
	)

Set the steps between increments.

Parameters:

	r,:	the range to change step
	step,:	the new step value for the range

Returns:: Returns no value.

Changes the amount that each increment or decrement changes the value of the range r.

unsigned int ewl_range_unknown_get ( Ewl_Range * r )

Retrieve the current unknown value from a range.

Parameters:

r,:

the range to retrieve the unknown property value

Returns:: Returns the current value of the unknown property in the range.

void ewl_range_unknown_set	(	Ewl_Range *	r,
		unsigned int	unknown
	)

Change the unknown property of the range if you do not know the max/min values.

Parameters:

	r,:	range to set unknown property
	unknown,:	the new value for the ranges unknown property

Returns:: Returns no value.

double ewl_range_value_get ( Ewl_Range * r )

Retrieve the current value of the range.

Parameters:

r,:

the ranges to retrieve the value

Returns:: Returns 0 on failure, the value of the range on success.

void ewl_range_value_set	(	Ewl_Range *	r,
		double	v
	)

Set the value of pointer of the range.

Parameters:

	r,:	the range whose value will be changed
	v,:	the new value of the range, checked against the valid range

Returns:: Returns no value.

Ewl_Range: A Value Selector from a Range

Detailed Description

Tutorial

Data Structures

Defines

Typedefs

Functions

Define Documentation

Typedef Documentation

Function Documentation