Geogram  Version 1.9.1-rc
A programming library of geometric algorithms
status_bar.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2000-2022 Inria
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * * Redistributions of source code must retain the above copyright notice,
9  * this list of conditions and the following disclaimer.
10  * * Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  * * Neither the name of the ALICE Project-Team nor the names of its
14  * contributors may be used to endorse or promote products derived from this
15  * software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
21  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27  * POSSIBILITY OF SUCH DAMAGE.
28  *
29  * Contact: Bruno Levy
30  *
31  * https://www.inria.fr/fr/bruno-levy
32  *
33  * Inria,
34  * Domaine de Voluceau,
35  * 78150 Le Chesnay - Rocquencourt
36  * FRANCE
37  *
38  */
39 
40 #ifndef H_GEOGRAM_GFX_GUI_STATUS_BAR_H
41 #define H_GEOGRAM_GFX_GUI_STATUS_BAR_H
42 
44 #include <geogram/basic/progress.h>
45 
51 namespace GEO {
52 
57  public:
58 
63 
67  void begin() override;
68 
72  void progress(GEO::index_t step, GEO::index_t percent) override;
73 
77  void end(bool canceled) override;
78 
82  void draw();
83 
89  bool active() const {
90  return (nb_active_ > 0);
91  }
92 
96  virtual void update();
97 
104  float get_window_height() const {
105  return height_;
106  }
107 
108  private:
109  bool progress_;
110  index_t step_;
111  index_t percent_;
112  bool canceled_;
113  index_t nb_active_;
114  float height_;
115  };
116 
117  typedef SmartPointer<StatusBar> StatusBar_var;
118 }
119 
120 #endif
Task progress listener.
Definition: progress.h:76
StatusBar displays the progress bar.
Definition: status_bar.h:56
void progress(GEO::index_t step, GEO::index_t percent) override
Tracks progress.
void draw()
Draws the status bar and handles the GUI.
float get_window_height() const
Gets the height of the status bar window.
Definition: status_bar.h:104
virtual void update()
Redraws the GUI.
void begin() override
Starts listening progress.
StatusBar()
StatusBar constructor.
void end(bool canceled) override
Stops listening progress.
bool active() const
Tests whether this status bar should be displayed.
Definition: status_bar.h:89
#define GEOGRAM_GFX_API
Linkage declaration for geogram symbols.
Definition: defs.h:55
Common include file, providing basic definitions. Should be included before anything else by all head...
Global Vorpaline namespace.
Definition: basic.h:55
geo_index_t index_t
The type for storing and manipulating indices.
Definition: numeric.h:329
Functions and classes for displaying progress bars.