progress_bar.hpp

Go to the documentation of this file.

/*
   Copyright (C) 2010 - 2016 by Mark de Wever <[email protected]>
   Part of the Battle for Wesnoth Project http://www.wesnoth.org/

   This program 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.
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY.

   See the COPYING file for more details.
*/

#ifndef GUI_WIDGETS_PROGRESS_BAR_HPP_INCLUDED
#define GUI_WIDGETS_PROGRESS_BAR_HPP_INCLUDED

#include "gui/widgets/control.hpp"

#include "gui/core/widget_definition.hpp"
#include "gui/core/window_builder.hpp"

namespace gui2
{

// ------------ WIDGET -----------{

class tprogress_bar : public tcontrol
{
public:
    tprogress_bar() : tcontrol(COUNT), percentage_(static_cast<unsigned>(-1))
    {
        // Force canvas update
        set_percentage(0);
    }

    /***** ***** ***** ***** Inherited ***** ***** ***** *****/

    /** See @ref tcontrol::set_active. */
    virtual void set_active(const bool active) override;

    /** See @ref tcontrol::get_active. */
    virtual bool get_active() const override;

    /** See @ref tcontrol::get_state. */
    virtual unsigned get_state() const override;

    /** See @ref twidget::disable_click_dismiss. */
    bool disable_click_dismiss() const override;


    /***** ***** ***** setters / getters for members ***** ****** *****/

    void set_percentage(unsigned percentage);
    unsigned get_percentage() const
    {
        return percentage_;
    }

private:
    /**
     * Possible states of the widget.
     *
     * Note the order of the states must be the same as defined in settings.hpp.
     */
    enum tstate {
        ENABLED,
        COUNT
    };

    /** The percentage done. */
    unsigned percentage_;

    /** See @ref tcontrol::get_control_type. */
    virtual const std::string& get_control_type() const override;
};

// }---------- DEFINITION ---------{

struct tprogress_bar_definition : public tcontrol_definition
{
    explicit tprogress_bar_definition(const config& cfg);

    struct tresolution : public tresolution_definition_
    {
        explicit tresolution(const config& cfg);
    };
};

// }---------- BUILDER -----------{

namespace implementation
{

struct tbuilder_progress_bar : public tbuilder_control
{

    explicit tbuilder_progress_bar(const config& cfg);

    using tbuilder_control::build;

    twidget* build() const;
};

} // namespace implementation

// }------------ END --------------

} // namespace gui2

#endif