progress_bar.hpp

Go to the documentation of this file.

/*
    Copyright (C) 2010 - 2024
    by Mark de Wever <koraq@xs4all.nl>
    Part of the Battle for Wesnoth Project https://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.
*/
 
#pragma once
 
#include "gui/widgets/styled_widget.hpp"
 
#include "gui/core/widget_definition.hpp"
 
namespace gui2
{
namespace implementation
{
struct builder_progress_bar;
}
 
// ------------ WIDGET -----------{
 
/**
 * @ingroup GUIWidgetWML
 *
 * This object shows the progress of a certain action, or the value state of a certain item.
 *
 * The following states exist:
 * * state_enabled - the progress bar is enabled.
 */
class progress_bar : public styled_widget
{
public:
    explicit progress_bar(const implementation::builder_progress_bar& builder);
 
    /***** ***** ***** ***** Inherited ***** ***** ***** *****/
 
    /** See @ref styled_widget::set_active. */
    virtual void set_active(const bool active) override;
 
    /** See @ref styled_widget::get_active. */
    virtual bool get_active() const override;
 
    /** See @ref styled_widget::get_state. */
    virtual unsigned get_state() const override;
 
    /** See @ref widget::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 state_t {
        ENABLED,
    };
 
    /** The percentage done. */
    unsigned percentage_;
 
public:
    /** Static type getter that does not rely on the widget being constructed. */
    static const std::string& type();
 
private:
    /** Inherited from styled_widget, implemented by REGISTER_WIDGET. */
    virtual const std::string& get_control_type() const override;
};
 
// }---------- DEFINITION ---------{
 
struct progress_bar_definition : public styled_widget_definition
{
    explicit progress_bar_definition(const config& cfg);
 
    struct resolution : public resolution_definition
    {
        explicit resolution(const config& cfg);
    };
};
 
// }---------- BUILDER -----------{
 
namespace implementation
{
 
struct builder_progress_bar : public builder_styled_widget
{
 
    explicit builder_progress_bar(const config& cfg);
 
    using builder_styled_widget::build;
 
    virtual std::unique_ptr<widget> build() const override;
};
 
} // namespace implementation
 
// }------------ END --------------
 
} // namespace gui2