Flu_Dual_Progress_Meter Class Reference

This class provides a simple meter showing both current and total progress that also provides canceling behavior. More...

#include <Flu_Dual_Progress_Meter.h>

List of all members.

Public Member Functions
	Flu_Dual_Progress_Meter (const char *t=NULL)
	Constructor which makes the progress meter with the title t.
virtual	~Flu_Dual_Progress_Meter ()
	Default destructor.
void	title (const char *t)
	Set the title of the progress meter to t.
const char *	title () const
	the title of this meter
void	label (const char *current, const char *total)
	Convenience routine combining setCurrentLabel() and setTotalLabel().
void	current_label (const char *l)
	Set the "current" label displayed during the operation.
void	total_label (const char *l)
	Set the "total" label displayed during the operation.
const char *	current_label () const
	Get the label for the current progress.
const char *	total_label () const
	Get the label for the total progress.
void	color (Fl_Color c)
	Set the color of the progress bar.
Fl_Color	color () const
	the current color of the progress bar
bool	value (float currentVal, float totalVal)
	Convenience routine combining setCurrentValue() and setTotalValue().
bool	current_value (float v)
	Set the value of the current progress bar. v should be on [0,1].
bool	total_value (float v)
	Set the value of the total progress bar. v should be on [0,1].
float	current_value () const
	the current value of the progress bar, on [0,1]
float	total_value () const
	the current value of the progress bar, on [0,1]
void	show (bool cancelBtnVisible=false)
	Show the meter. If cancelBtnVisible is true, then the "Cancel" button will be shown.
void	hide ()
	Hide the meter.
bool	shown () const
	true if the meter is shown, false otherwise
void	cancel_callback (void(*cb)(void *), void *cbd=NULL)
	Set the function that will be called when the "Cancel" button is pressed.
void	set_modal ()
Static Public Member Functions
void	current_value_callback (float v, void *arg)
	This function can be registered to update the progress bar.
void	total_value_callback (float v, void *arg)
	This function can be registered to update the progress bar.

---

Detailed Description

This class provides a simple meter showing both current and total progress that also provides canceling behavior.

---

Member Function Documentation

void Flu_Dual_Progress_Meter::color (  Fl_Color  c  )  [inline]

Set the color of the progress bar. Default is FL_BLUE

bool Flu_Dual_Progress_Meter::current_value (  float  v  )

Set the value of the current progress bar. v should be on [0,1]. Returns: true if the cancel button has been pressed

bool Flu_Dual_Progress_Meter::total_value (  float  v  )

Set the value of the total progress bar. v should be on [0,1]. Returns: true if the cancel button has been pressed

---

The documentation for this class was generated from the following file:

• Flu_Dual_Progress_Meter.h

---