FIFE  2008.0
percentagebar.hpp
00001 /***************************************************************************
00002  *   Copyright (C) 2005-2010 by the FIFE team                              *
00003  *   http://www.fifengine.net                                               *
00004  *   This file is part of FIFE.                                            *
00005  *                                                                         *
00006  *   FIFE is free software; you can redistribute it and/or                 *
00007  *   modify it under the terms of the GNU Lesser General Public            *
00008  *   License as published by the Free Software Foundation; either          *
00009  *   version 2.1 of the License, or (at your option) any later version.    *
00010  *                                                                         *
00011  *   This library is distributed in the hope that it will be useful,       *
00012  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
00013  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
00014  *   Lesser General Public License for more details.                       *
00015  *                                                                         *
00016  *   You should have received a copy of the GNU Lesser General Public      *
00017  *   License along with this library; if not, write to the                 *
00018  *   Free Software Foundation, Inc.,                                       *
00019  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
00020  ***************************************************************************/
00021 
00022 #ifndef GCN_PERCENTAGE_BAR_HPP
00023 #define GCN_PERCENTAGE_BAR_HPP
00024 
00025 // Standard C++ library includes
00026 
00027 // 3rd party library includes
00028 #include <guichan/image.hpp>
00029 #include <guichan/platform.hpp>
00030 #include <guichan/widget.hpp>
00031 
00032 // FIFE includes
00033 // These includes are split up in two parts, separated by one empty line
00034 // First block: files included from the FIFE root src directory
00035 // Second block: files included from the same folder
00036 
00037 namespace gcn
00038 {
00044     class PercentageBar : public Widget
00045     {
00046     public:
00047 
00048         enum Orientation
00049         {
00050             HORIZONTAL = 0,
00051             VERTICAL
00052         };
00053 
00058         PercentageBar();
00059         virtual ~PercentageBar() {}
00060 
00061 
00062         // Inherited from Widget
00063 
00064         virtual void draw(Graphics* graphics);
00065 
00066         /*
00067          * Sets the image that will be displayed above the widget
00068          *
00069          * @param image Image to be displayed
00070          */
00071         void setForegroundImage(Image* image);
00072 
00079         void setOrientation(Orientation orientation);
00080 
00087         Orientation getOrientation() const;
00088 
00094         int getValue() const;
00095 
00101         void setValue(int value);
00102 
00103         // changed from private to allow derived instance access
00104     protected:
00105         Image* mImage;
00106 
00110         double mValue;
00111 
00116         Orientation mOrientation;
00117     };
00118 }
00119 
00120 #endif // end GCN_PERCENTAGE_BAR_HPP