Ewl_Scrollbar: A Simple Scrollbar Widget

Detailed Description

Defines an Ewl_Scrollbar for using when scrolling values are needed.

Remarks:: Inherits from Ewl_Box.

Tutorial


Data Structures
struct	Ewl_Scrollbar
	Inherits from Ewl_Box and extends to provide a scrollbar widget. More...
Defines
#define	EWL_SCROLLBAR(scrollbar) ((Ewl_Scrollbar *) scrollbar)
#define	EWL_SCROLLBAR_IS(w) (ewl_widget_type_is(EWL_WIDGET(w), EWL_SCROLLBAR_TYPE))
#define	EWL_SCROLLBAR_TYPE "scrollbar"
Typedefs
typedef Ewl_Scrollbar	Ewl_Scrollbar
Functions
Ewl_Widget *	ewl_hscrollbar_new (void)
	Allocate and initialize a new horizontal scrollbar widget.
void	ewl_scrollbar_cb_scroll_start (Ewl_Widget w, void ev_data, void *user_data)
void	ewl_scrollbar_cb_scroll_stop (Ewl_Widget w, void ev_data, void *user_data)
int	ewl_scrollbar_init (Ewl_Scrollbar *s)
	Initialize a scrollbar to default values.
char	ewl_scrollbar_inverse_scroll_get (Ewl_Scrollbar *s)
	Checks the inverse scrolling flag on a scrollbar.
void	ewl_scrollbar_inverse_scroll_set (Ewl_Scrollbar *s, char v)
	Sets the inverse scrolling flag on a scrollbar.
Ewl_Widget *	ewl_scrollbar_new (void)
	Allocate and initialize a new scrollbar widget.
Ewl_Orientation	ewl_scrollbar_orientation_get (Ewl_Scrollbar *s)
	Change the orientation of a scrollbar.
void	ewl_scrollbar_orientation_set (Ewl_Scrollbar *s, Ewl_Orientation orientation)
	Change the orientation of a scrollbar.
double	ewl_scrollbar_step_get (Ewl_Scrollbar *s)
	Get the current step size of the scrollbar.
void	ewl_scrollbar_step_set (Ewl_Scrollbar *s, double v)
	Change the step size of a scrollbar.
double	ewl_scrollbar_value_get (Ewl_Scrollbar *s)
	Get the current value of the dragbar.
void	ewl_scrollbar_value_set (Ewl_Scrollbar *s, double v)
	Set the current value of the dragbar.
Ewl_Widget *	ewl_vscrollbar_new (void)
	Allocate and initialize a new vertical scrollbar widget.

Define Documentation

#define EWL_SCROLLBAR ( scrollbar ) ((Ewl_Scrollbar *) scrollbar)

Typecasts a pointer to an Ewl_Scrollbar pointer.

#define EWL_SCROLLBAR_IS ( w ) (ewl_widget_type_is(EWL_WIDGET(w), EWL_SCROLLBAR_TYPE))

Returns TRUE if the widget is an Ewl_Scrollbar, FALSE otherwise

#define EWL_SCROLLBAR_TYPE "scrollbar"

The type name for the Ewl_Scrollbar widget

Typedef Documentation

typedef struct Ewl_Scrollbar Ewl_Scrollbar

Provides a seeker with increment and decrement buttons arranged in a specified order.

Function Documentation

Ewl_Widget* ewl_hscrollbar_new ( void )

Allocate and initialize a new horizontal scrollbar widget.

Returns:: Returns NULL on failure, or a pointer to a new scrollbar on success.

void ewl_scrollbar_cb_scroll_start	(	Ewl_Widget *	w,
		void *	ev_data,
		void *	user_data
	)

void ewl_scrollbar_cb_scroll_stop	(	Ewl_Widget *	w,
		void *	ev_data,
		void *	user_data
	)

int ewl_scrollbar_init ( Ewl_Scrollbar * s )

Initialize a scrollbar to default values.

Parameters:

s,:

the scrollbar to initialize

Returns:: Returns no value.

char ewl_scrollbar_inverse_scroll_get ( Ewl_Scrollbar * s )

Checks the inverse scrolling flag on a scrollbar.

Parameters:

s,:

the scrollbar to get inverted scrolling value

Returns:: Returns the current value for inverted scrolling.

void ewl_scrollbar_inverse_scroll_set	(	Ewl_Scrollbar *	s,
		char	i
	)

Sets the inverse scrolling flag on a scrollbar.

Parameters:

	s,:	the scrollbar to set inverted scrolling value
	i,:	value to set for inverse scrolling

Returns:: Returns no value.

Ewl_Widget* ewl_scrollbar_new ( void )

Allocate and initialize a new scrollbar widget.

Returns:: Returns NULL on failure, or a pointer to a new scrollbar on success.

Ewl_Orientation ewl_scrollbar_orientation_get ( Ewl_Scrollbar * s )

Change the orientation of a scrollbar.

Parameters:

s,:

the scrollbar to change orientation

Returns:: Returns no value.

void ewl_scrollbar_orientation_set	(	Ewl_Scrollbar *	s,
		Ewl_Orientation	o
	)

Change the orientation of a scrollbar.

Parameters:

	s,:	the scrollbar to change orientation
	o,:	the new orientation to use on the scrollbar

Returns:: Returns no value.

double ewl_scrollbar_step_get ( Ewl_Scrollbar * s )

Get the current step size of the scrollbar.

Parameters:

s,:

the scrollbar to retrieve step size

Returns:: Returns the current step size of the scrollbar.

void ewl_scrollbar_step_set	(	Ewl_Scrollbar *	s,
		double	v
	)

Change the step size of a scrollbar.

Parameters:

	s,:	the scrollbar to change step size
	v,:	the new step size of the scrollbar

Returns:: Returns no value.

Changes the step size of the scrollbar s to v.

double ewl_scrollbar_value_get ( Ewl_Scrollbar * s )

Get the current value of the dragbar.

Parameters:

s,:

the scrollbar to get the current value

Returns:: Returns the current value of the scrollbar s.

void ewl_scrollbar_value_set	(	Ewl_Scrollbar *	s,
		double	v
	)

Set the current value of the dragbar.

Parameters:

	s,:	the scrollbar to set the current value
	v,:	the new value for the scrollbar

Returns:: Returns no value.

Sets the current value of the scrollbar s.

Ewl_Widget* ewl_vscrollbar_new ( void )

Allocate and initialize a new vertical scrollbar widget.

Returns:: Returns NULL on failure, or a pointer to a new scrollbar on success.

Ewl_Scrollbar: A Simple Scrollbar Widget

Detailed Description

Tutorial

Data Structures

Defines

Typedefs

Functions

Define Documentation

Typedef Documentation

Function Documentation