FIFE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
percentagebar.h
Go to the documentation of this file.
1 /***************************************************************************
2  * Copyright (C) 2005-2013 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 GCN_PERCENTAGE_BAR_HPP
23 #define GCN_PERCENTAGE_BAR_HPP
24 
25 // Standard C++ library includes
26 
27 // 3rd party library includes
28 #include <guichan/image.hpp>
29 #include <guichan/platform.hpp>
30 #include <guichan/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 gcn
39 {
45  class PercentageBar : public Widget
46  {
47  public:
48 
50  {
53  };
54 
59  PercentageBar();
60  virtual ~PercentageBar() {}
61 
62 
63  // Inherited from Widget
64 
65  virtual void draw(Graphics* graphics);
66 
67  /*
68  * Sets the image that will be displayed above the widget
69  *
70  * @param image Image to be displayed
71  */
72  void setForegroundImage(Image* image);
73 
80  void setOrientation(Orientation orientation);
81 
89 
95  int32_t getValue() const;
96 
102  void setValue(int32_t value);
103 
104  // changed from private to allow derived instance access
105  protected:
106  Image* mImage;
107 
111  double mValue;
112 
118  };
119 }
120 
121 #endif // end GCN_PERCENTAGE_BAR_HPP
Orientation mOrientation
Holds the orientation of the percentage bar.
void setValue(int32_t value)
Sets the value of the percentage bar.
void setOrientation(Orientation orientation)
Sets the orientation of the percentage bar.
double mValue
Holds the current value of the percentage bar.
virtual void draw(Graphics *graphics)
virtual ~PercentageBar()
Definition: percentagebar.h:60
A simple percentage bar.
Definition: percentagebar.h:45
Orientation getOrientation() const
Gets the orientation of the percentage bar.
void setForegroundImage(Image *image)
PercentageBar()
Constructor.
int32_t getValue() const
Gets the value of the percentage bar.