FIFE  6e1afdbeda11afe9ac53e6023a4be96ef88f1dc6
percentagebar.h
Go to the documentation of this file.
1 /***************************************************************************
2  * Copyright (C) 2005-2017 by the FIFE team *
3  * http://www.fifengine.net *
4  * This file is part of FIFE. *
5  * *
6  * FIFE is free software; you can redistribute it and/or *
7  * modify it under the terms of the GNU Lesser General Public *
8  * License as published by the Free Software Foundation; either *
9  * version 2.1 of the License, or (at your option) any later version. *
10  * *
11  * This library is distributed in the hope that it will be useful, *
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
14  * Lesser General Public License for more details. *
15  * *
16  * You should have received a copy of the GNU Lesser General Public *
17  * License along with this library; if not, write to the *
18  * Free Software Foundation, Inc., *
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
20  ***************************************************************************/
21 
22 #ifndef FCN_PERCENTAGE_BAR_HPP
23 #define FCN_PERCENTAGE_BAR_HPP
24 
25 // Standard C++ library includes
26 
27 // 3rd party library includes
28 #include <fifechan/image.hpp>
29 #include <fifechan/platform.hpp>
30 #include <fifechan/widget.hpp>
31 
32 // FIFE includes
33 // These includes are split up in two parts, separated by one empty line
34 // First block: files included from the FIFE root src directory
35 // Second block: files included from the same folder
36 #include "util/base/fife_stdint.h"
37 
38 namespace fcn
39 {
45  class PercentageBar : public Widget
46  {
47  public:
48 
50  {
53  };
54 
59  PercentageBar();
60  virtual ~PercentageBar() {}
61 
62  // Inherited from Widget
63 
64  virtual void draw(Graphics* graphics);
65 
66  /*
67  * Sets the image that will be displayed above the widget
68  *
69  * @param image Image to be displayed
70  */
71  void setForegroundImage(Image* image);
72 
79  void setOrientation(Orientation orientation);
80 
88 
94  int32_t getValue() const;
95 
101  void setValue(int32_t value);
102 
103  // changed from private to allow derived instance access
104  protected:
105  Image* mImage;
106 
110  double mValue;
111 
117  };
118 }
119 
120 #endif // end FCN_PERCENTAGE_BAR_HPP
int32_t getValue() const
Gets the value of the percentage bar.
virtual ~PercentageBar()
Definition: percentagebar.h:60
void setForegroundImage(Image *image)
void setOrientation(Orientation orientation)
Sets the orientation of the percentage bar.
virtual void draw(Graphics *graphics)
double mValue
Holds the current value of the percentage bar.
A simple percentage bar.
Definition: percentagebar.h:45
Orientation mOrientation
Holds the orientation of the percentage bar.
PercentageBar()
Constructor.
void setValue(int32_t value)
Sets the value of the percentage bar.
Orientation getOrientation() const
Gets the orientation of the percentage bar.