percentagebar.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005-2013 by the FIFE team                              *
 *   http://www.fifengine.net                                              *
 *   This file is part of FIFE.                                            *
 *                                                                         *
 *   FIFE is free software; you can redistribute it and/or                 *
 *   modify it under the terms of the GNU Lesser General Public            *
 *   License as published by the Free Software Foundation; either          *
 *   version 2.1 of the License, or (at your option) any later version.    *
 *                                                                         *
 *   This library is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the                 *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
 ***************************************************************************/

#ifndef FCN_PERCENTAGE_BAR_HPP
#define FCN_PERCENTAGE_BAR_HPP

// Standard C++ library includes

// 3rd party library includes
#include <fifechan/image.hpp>
#include <fifechan/platform.hpp>
#include <fifechan/widget.hpp>

// FIFE includes
// These includes are split up in two parts, separated by one empty line
// First block: files included from the FIFE root src directory
// Second block: files included from the same folder
#include "util/base/fife_stdint.h"

namespace fcn
{
    class PercentageBar : public Widget
    {
    public:

        enum Orientation
        {
            HORIZONTAL = 0,
            VERTICAL
        };

        PercentageBar();
        virtual ~PercentageBar() {}

        // Inherited from Widget

        virtual void draw(Graphics* graphics);

        /*
         * Sets the image that will be displayed above the widget
         *
         * @param image Image to be displayed
         */
        void setForegroundImage(Image* image);

        void setOrientation(Orientation orientation);

        Orientation getOrientation() const;

        int32_t getValue() const;

        void setValue(int32_t value);

        // changed from private to allow derived instance access
    protected:
        Image* mImage;

        double mValue;

        Orientation mOrientation;
    };
}

#endif // end FCN_PERCENTAGE_BAR_HPP