button.hpp

Go to the documentation of this file.

/*
    Copyright (C) 2008 - 2025
    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/core/widget_definition.hpp"
 
#include "gui/widgets/styled_widget.hpp"
#include "gui/widgets/clickable_item.hpp"
 
namespace gui2
{
namespace implementation
{
    struct builder_button;
}
 
// ------------ WIDGET -----------{
 
/**
 * Simple push button.
 */
class button : public styled_widget, public clickable_item
{
public:
    explicit button(const implementation::builder_button& 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;
 
    void set_success(bool success);
 
    /** Inherited from clickable_item. */
    virtual void connect_click_handler(const event::signal& signal) override
    {
        connect_signal_mouse_left_click(*this, signal);
    }
 
    /** Inherited from clickable_item. */
    virtual void disconnect_click_handler(const event::signal& signal) override
    {
        disconnect_signal_mouse_left_click(*this, signal);
    }
 
    /***** ***** ***** setters / getters for members ***** ****** *****/
 
    void set_retval(const int retval)
    {
        retval_ = retval;
    }
 
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,
        DISABLED,
        PRESSED,
        FOCUSED,
        SUCCESS
    };
 
    void set_state(const state_t state);
    /**
     * Current state of the widget.
     *
     * The state of the widget determines what to render and how the widget
     * reacts to certain 'events'.
     */
    state_t state_;
 
    /**
     * The return value of the button.
     *
     * If this value is not 0 and the button is clicked it sets the retval of
     * the window and the window closes itself.
     */
    int retval_;
 
    /**
     * Action performed by this button succeeded.
     */
    bool success_;
 
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;
 
    /***** ***** ***** signal handlers ***** ****** *****/
 
    void signal_handler_mouse_enter(const event::ui_event event, bool& handled);
 
    void signal_handler_mouse_leave(const event::ui_event event, bool& handled);
 
    void signal_handler_left_button_down(const event::ui_event event,
                                         bool& handled);
 
    void signal_handler_left_button_up(const event::ui_event event,
                                       bool& handled);
 
    void signal_handler_left_button_click(const event::ui_event event,
                                          bool& handled);
};
 
// }---------- DEFINITION ---------{
 
struct button_definition : public styled_widget_definition
{
    explicit button_definition(const config& cfg);
 
    struct resolution : public resolution_definition
    {
        explicit resolution(const config& cfg);
    };
};
 
// }---------- BUILDER -----------{
 
namespace implementation
{
 
struct builder_button : public builder_styled_widget
{
public:
    explicit builder_button(const config& cfg);
 
    using builder_styled_widget::build;
 
    virtual std::unique_ptr<widget> build() const override;
 
private:
    std::string retval_id_;
    int retval_;
};
 
} // namespace implementation
 
// }------------ END --------------
 
} // namespace gui2