Pyrogenesis  trunk
CProgressBar.h
Go to the documentation of this file.
1 /* Copyright (C) 2021 Wildfire Games.
2  * This file is part of 0 A.D.
3  *
4  * 0 A.D. is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * 0 A.D. is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with 0 A.D. If not, see <http://www.gnu.org/licenses/>.
16  */
17 
18 #ifndef INCLUDED_CPROGRESSBAR
19 #define INCLUDED_CPROGRESSBAR
20 
22 #include "gui/CGUISprite.h"
23 
24 /**
25  * Object used to draw a value (e.g. progress) from 0 to 100 visually.
26  */
27 class CProgressBar : public IGUIObject
28 {
30 
31 public:
32  CProgressBar(CGUI& pGUI);
33  virtual ~CProgressBar();
34 
35 protected:
36  /**
37  * Draws the progress bar
38  */
39  virtual void Draw(CCanvas2D& canvas);
40 
41  /**
42  * @see IGUIObject#HandleMessage()
43  * If the progress is changed, ensure the interval is between 0 and 100.
44  */
45  void HandleMessage(SGUIMessage& Message);
46 
47  // Settings
51 };
52 
53 #endif // INCLUDED_CPROGRESSBAR
CProgressBar(CGUI &pGUI)
Definition: CProgressBar.cpp:24
void HandleMessage(SGUIMessage &Message)
Definition: CProgressBar.cpp:36
GUI object such as a button or an input-box.
Definition: IGUIObject.h:59
The main object that represents a whole GUI page.
Definition: CGUI.h:60
CGUISimpleSetting< float > m_Progress
Definition: CProgressBar.h:50
virtual ~CProgressBar()
Definition: CProgressBar.cpp:32
virtual void Draw(CCanvas2D &canvas)
Draws the progress bar.
Definition: CProgressBar.cpp:56
Definition: Canvas2D.h:35
CGUISimpleSetting< CGUISpriteInstance > m_SpriteBackground
Definition: CProgressBar.h:48
CGUISimpleSetting< CGUISpriteInstance > m_SpriteBar
Definition: CProgressBar.h:49
#define GUI_OBJECT(obj)
Definition: IGUIObject.h:50
Message send to IGUIObject::HandleMessage() in order to give life to Objects manually with a derived ...
Definition: SGUIMessage.h:67
Object used to draw a value (e.g.
Definition: CProgressBar.h:27