Main Page | Modules | Alphabetical List | Data Structures | File List | Data Fields | Related Pages

Progressbar: A progressbar from a value


Data Structures

struct  Ewl_Progressbar
 Inherits from Ewl_Container and creates an internal Ewl_Widget, the statusbar itself. More...

struct  Ewl_Progressbar
 Inherits from Ewl_Container and creates an internal Ewl_Widget, the statusbar itself. More...


Defines

#define EWL_PROGRESSBAR(progressbar)   ((Ewl_Progressbar *) progressbar)
 Typecasts a pointer to an Ewl_Progressbar pointer.


Typedefs

typedef Ewl_Progressbar Ewl_Progressbar
 The Ewl_Progressbar provides a statusbar from a given value.


Functions

Ewl_Widgetewl_progressbar_new (void)
 Allocate and initialize a new progressbar.

void ewl_progressbar_init (Ewl_Progressbar *p)
 Initialize the progressbar to some sane starting values.

void ewl_progressbar_value_set (Ewl_Progressbar *p, double v)
 Set the value of the progressbars location.

double ewl_progressbar_value_get (Ewl_Progressbar *p)
 Retrieve the current value of the progressbars.

void ewl_progressbar_range_set (Ewl_Progressbar *p, double r)
 Set the range of the progressbar. Cannot be less then 1.

double ewl_progressbar_range_get (Ewl_Progressbar *p)
 Retrieve the current range of the progressbars (default 100).

void ewl_progressbar_label_set (Ewl_Progressbar *p, char *label)
 Sets the given text on the progressbar.

void ewl_progressbar_custom_label_set (Ewl_Progressbar *p, char *format_string)
 Sets the given format string on the progressbar (lf of lf beers).

void ewl_progressbar_label_show (Ewl_Progressbar *p)
 Shows the given progressbars label.

void ewl_progressbar_label_hide (Ewl_Progressbar *p)
 Hides the given progressbars label.


Function Documentation

void ewl_progressbar_custom_label_set Ewl_Progressbar p,
char *  format_string
 

Sets the given format string on the progressbar (lf of lf beers).

Parameters:
p: the progressbars whose label will be changed
format_string: format string for the new label
Returns:
Returns no value

void ewl_progressbar_init Ewl_Progressbar p  ) 
 

Initialize the progressbar to some sane starting values.

Parameters:
p: the progressbar to be initialized
Returns:
Returns no value.

void ewl_progressbar_label_hide Ewl_Progressbar p  ) 
 

Hides the given progressbars label.

Parameters:
p: the progressbars whose label will be hidden
Returns:
Returns no value

void ewl_progressbar_label_set Ewl_Progressbar p,
char *  label
 

Sets the given text on the progressbar.

Parameters:
p: the progressbars whose text will be changed
label: the new label
Returns:
Returns no value

void ewl_progressbar_label_show Ewl_Progressbar p  ) 
 

Shows the given progressbars label.

Parameters:
p: the progressbars whose label will be shown
Returns:
Returns no value

Ewl_Widget* ewl_progressbar_new void   ) 
 

Allocate and initialize a new progressbar.

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

double ewl_progressbar_range_get Ewl_Progressbar p  ) 
 

Retrieve the current range of the progressbars (default 100).

Parameters:
p: the progressbars to retrieve the range
Returns:
Returns 0 on failure, the value of the progressbars location on success.

void ewl_progressbar_range_set Ewl_Progressbar p,
double  r
 

Set the range of the progressbar. Cannot be less then 1.

Parameters:
p: the progressbar whose range will be changed
r: the new range of the statusbar
Returns:
Returns no value.

double ewl_progressbar_value_get Ewl_Progressbar p  ) 
 

Retrieve the current value of the progressbars.

Parameters:
p: the progressbars to retrieve the value
Returns:
Returns 0 on failure, the value of the progressbars location on success.

void ewl_progressbar_value_set Ewl_Progressbar p,
double  v
 

Set the value of the progressbars location.

Parameters:
p: the progressbar whose value will be changed
v: the new value of the statusbar
Returns:
Returns no value.