CProgressBar.h

Go to the documentation of this file.

/* Copyright (C) 2021 Wildfire Games.
 * This file is part of 0 A.D.
 *
 * 0 A.D. is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * 0 A.D. 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef INCLUDED_CPROGRESSBAR
#define INCLUDED_CPROGRESSBAR
 
#include "gui/ObjectBases/IGUIObject.h"
#include "gui/CGUISprite.h"
 
/**
 * Object used to draw a value (e.g. progress) from 0 to 100 visually.
 */
class CProgressBar : public IGUIObject
{
    GUI_OBJECT(CProgressBar)
 
public:
    CProgressBar(CGUI& pGUI);
    virtual ~CProgressBar();
 
protected:
    /**
     * Draws the progress bar
     */
    virtual void Draw(CCanvas2D& canvas);
 
    /**
     * @see IGUIObject#HandleMessage()
     * If the progress is changed, ensure the interval is between 0 and 100.
     */
    void HandleMessage(SGUIMessage& Message);
 
    // Settings
    CGUISimpleSetting<CGUISpriteInstance> m_SpriteBackground;
    CGUISimpleSetting<CGUISpriteInstance> m_SpriteBar;
    CGUISimpleSetting<float> m_Progress;
};
 
#endif // INCLUDED_CPROGRESSBAR