Geogram  Version 1.9.1
A programming library of geometric algorithms
GEO::StatusBar Class Reference

StatusBar displays the progress bar. More...

#include <geogram_gfx/gui/status_bar.h>

Inheritance diagram for GEO::StatusBar:
GEO::ProgressClient GEO::Counted

Public Member Functions

 StatusBar ()
 StatusBar constructor.
 
void begin () override
 Starts listening progress. More...
 
void progress (GEO::index_t step, GEO::index_t percent) override
 Tracks progress. More...
 
void end (bool canceled) override
 Stops listening progress. More...
 
void draw ()
 Draws the status bar and handles the GUI.
 
bool active () const
 Tests whether this status bar should be displayed. More...
 
virtual void update ()
 Redraws the GUI.
 
float get_window_height () const
 Gets the height of the status bar window. More...
 
- Public Member Functions inherited from GEO::Counted
void ref () const
 Increments the reference count. More...
 
void unref () const
 Decrements the reference count. More...
 
bool is_shared () const
 Check if the object is shared. More...
 
int nb_refs () const
 Gets the number of references that point to this object. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from GEO::Counted
static void ref (const Counted *counted)
 Increments the reference count. More...
 
static void unref (const Counted *counted)
 Decrements the reference count. More...
 
- Protected Member Functions inherited from GEO::ProgressClient
 ~ProgressClient () override
 
- Protected Member Functions inherited from GEO::Counted
 Counted ()
 Creates a reference counted object. More...
 
virtual ~Counted ()
 Destroys a reference counted object. More...
 

Detailed Description

StatusBar displays the progress bar.

Definition at line 56 of file status_bar.h.

Member Function Documentation

◆ active()

bool GEO::StatusBar::active ( ) const
inline

Tests whether this status bar should be displayed.

The status bar is displayed whenever there is an active progress bar.

Definition at line 89 of file status_bar.h.

◆ begin()

void GEO::StatusBar::begin ( )
overridevirtual

Starts listening progress.

This function is called by the ProgressTask to start tracking the execution of a new task. Clients are free to do whatever is appropriate (show a progress bar, a progress dialog, ...)

Implements GEO::ProgressClient.

◆ end()

void GEO::StatusBar::end ( bool  canceled)
overridevirtual

Stops listening progress.

This function is called by the ProgressTask to stop tracking the execution of the task. Clients are free to do whatever is appropriate (hide a progress bar, a progress dialog, log the elapsed time, ...). If the task was not terminated normally (i.e., canceled() then parameter canceled is set to true.

Parameters
[in]canceledset to true if the task was canceled, false otherwise.

Implements GEO::ProgressClient.

◆ get_window_height()

float GEO::StatusBar::get_window_height ( ) const
inline

Gets the height of the status bar window.

Returns
the height of the window.

Needs to have drawn the window at least once, else it returns 0.

Definition at line 104 of file status_bar.h.

◆ progress()

void GEO::StatusBar::progress ( GEO::index_t  step,
GEO::index_t  percent 
)
overridevirtual

Tracks progress.

This function is called by the ProgressTask repeatedly during the execution of the task. Clients are free to do whatever is appropriate (update a progress bar, log the current values, ...).

Parameters
[in]stepthe current progress step
[in]percentthe percentage of completion of the task

Implements GEO::ProgressClient.


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