repeating_button.hpp

Go to the documentation of this file.

/*
    Copyright (C) 2009 - 2022
    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/widgets/clickable_item.hpp"

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

namespace gui2
{
namespace implementation
{
struct builder_repeating_button;
}

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

/**
 * @ingroup GUIWidgetWML
 *
 * A repeating_button is a control that can be pushed down and repeat a certain action.
 * Once the button is down every x milliseconds it is down a new down event is triggered.
 *
 * The following states exist:
 * * state_enabled - the repeating_button is enabled.
 * * state_disabled - the repeating_button is disabled.
 * * state_pressed - the left mouse repeating_button is down.
 * * state_focussed - the mouse is over the repeating_button.
 */
class repeating_button : public styled_widget, public clickable_item
{
public:
    explicit repeating_button(const implementation::builder_repeating_button& builder);
    ~repeating_button();

    /**
     * Connects a signal handler for a left mouse button down.
     *
     * This event is triggered when the button is pressed and, as long as the
     * button stays down, every x ms afterwards.
     *
     * @param signal              The signal to connect.
     */
    void connect_signal_mouse_left_down(const event::signal& signal);

    /**
     * Disconnects a signal handler for a left mouse button down.
     *
     * @param signal              The signal to disconnect (should be the same
     *                            as send to the connect call.
     */
    void
    disconnect_signal_mouse_left_down(const event::signal& signal);

    /***** ***** ***** ***** 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;

    /** Inherited from clickable_item. */
    virtual void connect_click_handler(const event::signal& signal) override
    {
        connect_signal_mouse_left_down(signal);
    }

    /** Inherited from clickable_item. */
    virtual void disconnect_click_handler(const event::signal& signal) override
    {
        disconnect_signal_mouse_left_down(signal);
    }

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,
    };

    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 timer for the repeating events. */
    std::size_t repeat_timer_;

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);
};

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

struct repeating_button_definition : public styled_widget_definition
{
    explicit repeating_button_definition(const config& cfg);

    struct resolution : public resolution_definition
    {
        explicit resolution(const config& cfg);
    };
};

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

namespace implementation
{

struct builder_repeating_button : public builder_styled_widget
{
public:
    explicit builder_repeating_button(const config& cfg);

    using builder_styled_widget::build;

    virtual std::unique_ptr<widget> build() const override;
};

} // namespace implementation

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

} // namespace gui2