Defines progress bar behavior, allowing to monitor the progress of a process.
More...
|
| ~AppProgressBar () |
| Destructor.
|
|
AppBase & | get_application () const |
|
bool | is_valid_context () const |
|
const CoreString & | get_text () const |
| Get the text associated to the progress bar.
|
|
const CoreString & | get_task_name () const |
| Get the text associated to the current task.
|
|
float | get_global_value () const |
| Get the global progress value.
|
|
float | get_value () const |
| Get the progress value for the current task.
|
|
void | set_value (const float &value) |
| Set the progress value for the current task.
|
|
void | set_increment (const float &increment) |
| Define an progress increment for the current task.
|
|
void | increment () |
| Increment the progress value with the recorded increment.
|
|
void | increment (const float &value) |
| Increment the progress of the current task with the specified value.
|
|
void | set_step_count (const unsigned int &step_count) |
| Set a number of step that will be processed for the current task.
|
|
void | step (const unsigned int &i) |
| Specify the step that has been processed.
|
|
void | begin_task (const bool &compute_duration=false) |
| Start a new task that will cover from the current progress to 100% of the parent task.
|
|
void | begin_task (const CoreString &name, const bool &compute_duration=false) |
| Start a new task that will cover from the current progress to 100% of the parent task.
|
|
void | begin_task (const float &scale, const bool &compute_duration=false) |
| Start a new task.
|
|
void | begin_task (const CoreString &name, const float &scale, const bool &compute_duration=false) |
| Start a new task.
|
|
unsigned long | end_task () |
| End the current task.
|
|
void | start () |
| Reset the progress to 0%.
|
|
void | finish () |
| Set the progress to 100% and comute the total duration.
|
|
bool | abort () |
| Inform the process that is monitored by the current progress bar to abort.
|
|
void | destroy () |
| Tells the progress bar to destroy itself once it is not useful anymore.
|
|
bool | is_abortable () const |
| Tells wether the process monitored by the current progress bar can be aborted.
|
|
bool | must_abort () const |
| Tells wether the process monitored by the current progress bar must be aborted.
|
|
const bool & | is_destroyed () const |
| Tells wether the progress bar has been destroyed.
|
|
const bool & | keep_in_history () const |
| Tells wether the progress remains visible in the history.
|
|
void | detach_from_main_thread () |
| This function must be called when the progress bar is updated from a thread.
|
|
const unsigned long & | get_duration () const |
| Get the duration of the process that has been monitored by the progress bar.
|
|
bool | is_kindof (const CoreClassInfo &cinfo) const |
|
Defines progress bar behavior, allowing to monitor the progress of a process.
The progress bar allows to monitor a process that can be split into several tasks. Each task can then be split into steps. Each time the value of the progress is updated the UI is informed in order to be refreshed.
A progress bar must be created through the application by calling AppBase::create_progress_bar(). Once it is not useful anymore, it must be released by using the destroy() method.
- Examples:
- app_progress_bar_example.cc.