Progress

This page has been automatically translated using the Google Translate API services. We are working on improving texts. Thank you for your understanding and patience.

Functions

Progress*	progress_create (void)
void	progress_undefined (...)
void	progress_value (...)

Progress bars are passive controls that show the remaining time to complete a certain task (Figure 1). As time passes we must update the control. The undefined state will show an animation without indicating status, which will be useful when we cannot determine the required time.

Use progress_create to create a progress bar.
Use progress_undefined to set the bar as undefined.
Use progress_value to update the progress of the task.

Window where several controls appear progress bars. — Figure 1: ProgressBar on Windows, macOS and Linux.

progress_create ()

Create a progress bar.

Progress*
progress_create(void);

Return

The progress.

progress_undefined ()

Set the progress bar as undefined.

void
progress_undefined(Progress *progress,
                   const bool_t running);

progress	The progress.
running	`TRUE`to activate the animation.

progress_value ()

Set the progress position.

void
progress_value(Progress *progress,
               const real32_t value);

progress	The progress.
value	The position between 0.0 and 1.0.