progress_bar.h File Reference

Progress_Bar Widget. More...

#include "ntw.h"

Go to the source code of this file.

Functions

double ntw_progress_bar_get_fraction (ntwWidget *widget)
 Get amount of progress made.
double ntw_progress_bar_set_fraction (ntwWidget *widget, double fraction)
 Set amount of progress made.
int ntw_progress_bar_set_horizontal (ntwWidget *widget)
 Change orientation to horizontal.
int ntw_progress_bar_set_vertical (ntwWidget *widget)
 Change orientation to vertical.
int ntw_progress_bar_set_text (ntwWidget *widget, char *text)
 Set current text shown in progress bar.
char * ntw_progress_bar_get_text (ntwWidget *widget)
 Get current text shown in progress bar.
ntwWidget * ntw_progress_bar_new ()
 Create progress_bar.


Detailed Description

Progress_Bar Widget.

A progress_bar looks like a thermometer that indicates a percentage. It may be oriented vertically or horizontally.


Function Documentation

double ntw_progress_bar_get_fraction ntwWidget *  widget  ) 
 

Get amount of progress made.

Parameters:
widget progress_bar widget
Returns:
percentage of progress, should be between 0.0 and 1.0

char* ntw_progress_bar_get_text ntwWidget *  widget  ) 
 

Get current text shown in progress bar.

Parameters:
widget progress_bar widget
Returns:
Progress bar's text

ntwWidget* ntw_progress_bar_new  ) 
 

Create progress_bar.

Returns:
Newly created progress_bar

double ntw_progress_bar_set_fraction ntwWidget *  widget,
double  fraction
 

Set amount of progress made.

Parameters:
widget progress_bar widget
fraction percentage of progress, should be between 0.0 and 1.0
Returns:
actual value of fraction set

int ntw_progress_bar_set_horizontal ntwWidget *  widget  ) 
 

Change orientation to horizontal.

Parameters:
widget progress_bar widget
Returns:
-1 on failure

int ntw_progress_bar_set_text ntwWidget *  widget,
char *  text
 

Set current text shown in progress bar.

Parameters:
widget progress_bar widget
text text string to show
Returns:
-1 on failure

int ntw_progress_bar_set_vertical ntwWidget *  widget  ) 
 

Change orientation to vertical.

Parameters:
widget progress_bar widget
Returns:
-1 on failure


Generated on Wed Jun 28 17:00:07 2006 for NTW Server C Library by  doxygen 1.4.6