SpinButton.hpp

//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2025 Bruno Van de Velde (vdv_b@tgui.eu)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#ifndef TGUI_SPIN_BUTTON_HPP
#define TGUI_SPIN_BUTTON_HPP
 
#include <TGUI/Renderers/SpinButtonRenderer.hpp>
#include <TGUI/Widgets/ClickableWidget.hpp>
#include <TGUI/Timer.hpp>
 
#if !TGUI_EXPERIMENTAL_USE_STD_MODULE
    #include <cmath>
#endif

 
TGUI_MODULE_EXPORT namespace tgui
{
    class TGUI_API SpinButton : public ClickableWidget
    {
    public:
 
        using Ptr = std::shared_ptr<SpinButton>; 
        using ConstPtr = std::shared_ptr<const SpinButton>; 
 
        static constexpr const char StaticWidgetType[] = "SpinButton"; 

        SpinButton(const char* typeName = StaticWidgetType, bool initRenderer = true);

        TGUI_NODISCARD static SpinButton::Ptr create(float minimum = 0, float maximum = 10);

        TGUI_NODISCARD static SpinButton::Ptr copy(const SpinButton::ConstPtr& spinButton);

        TGUI_NODISCARD SpinButtonRenderer* getSharedRenderer() override;
        TGUI_NODISCARD const SpinButtonRenderer* getSharedRenderer() const override;

        TGUI_NODISCARD SpinButtonRenderer* getRenderer() override;

        void setSize(const Layout2d& size) override;
        using Widget::setSize;

        void setMinimum(float minimum);

        TGUI_NODISCARD float getMinimum() const;

        void setMaximum(float maximum);

        TGUI_NODISCARD float getMaximum() const;

        template <typename T, typename = typename std::enable_if_t<std::is_arithmetic<T>::value, T>>
        void setValue(T value)
        {
            // TGUI_NEXT: For backwards compatibility, this function needs to accept a float without conversion warnings.
            //            We however need the function to take a double as parameter to actually make use of the extra significant digits.
            const double oldValue = m_value;
 
            // Round to nearest allowed value
            if (m_step != 0)
                m_value = m_minimum + (std::round((static_cast<double>(value) - m_minimum) / m_step) * m_step);
 
            // When the value is below the minimum or above the maximum then adjust it
            if (m_value < m_minimum)
                m_value = m_minimum;
            else if (m_value > m_maximum)
                m_value = m_maximum;
 
            if (oldValue != m_value)
                onValueChange.emit(this, static_cast<float>(m_value));
        }

        TGUI_NODISCARD float getValue() const;

        template <typename T, typename = typename std::enable_if_t<std::is_arithmetic<T>::value, T>>
        void setStep(T step)
        {
            // TGUI_NEXT: For backwards compatibility, this function needs to accept a float without conversion warnings.
            //            We however need the function to take a double as parameter to actually make use of the extra significant digits in calculations.
            m_step = static_cast<double>(step);
        }

        TGUI_NODISCARD float getStep() const;

        TGUI_DEPRECATED("Use setOrientation instead")void setVerticalScroll(bool vertical);

        TGUI_DEPRECATED("Use getOrientation instead")TGUI_NODISCARD bool getVerticalScroll() const;

        void setOrientation(Orientation orientation);

        TGUI_NODISCARD Orientation getOrientation() const;

        bool leftMousePressed(Vector2f pos) override;

        void leftMouseReleased(Vector2f pos) override;

        void mouseMoved(Vector2f pos) override;

        void draw(BackendRenderTarget& target, RenderStates states) const override;

    protected:

        TGUI_NODISCARD Signal& getSignal(String signalName) override;

        void rendererChanged(const String& property) override;

        TGUI_NODISCARD std::unique_ptr<DataIO::Node> save(SavingRenderersMap& renderers) const override;

        void load(const std::unique_ptr<DataIO::Node>& node, const LoadingRenderersMap& renderers) override;

        // Returns the size of the arrows
        TGUI_NODISCARD Vector2f getArrowSize() const;

        // Makes a copy of the widget
        TGUI_NODISCARD Widget::Ptr clone() const override;

    private:

        // Schedules a callback to regularly change the value of the spin button as long as the mouse remains pressed on an arrow
        void callMousePressPeriodically(std::chrono::time_point<std::chrono::steady_clock> clickedTime, bool repeatedCall);

    public:
 
        SignalFloat onValueChange = {"ValueChanged"}; 

    protected:
 
        Orientation m_orientation = Orientation::Vertical; // Is the spin button draw horizontally (arrows next to each other) or vertically (arrows on top of each other)?
        bool m_orientationLocked = false; // Will setSize change the orientation or not?
        std::chrono::time_point<std::chrono::steady_clock> m_lastMousePressTime;
 
        double m_minimum = 0;
        double m_maximum = 10;
        double m_value = 0;
        double m_step = 1;
 
        // On which arrow is the mouse?
        bool m_mouseHoverOnTopArrow = false;
        bool m_mouseDownOnTopArrow = false;
 
        Sprite m_spriteArrowUp;
        Sprite m_spriteArrowUpHover;
        Sprite m_spriteArrowDown;
        Sprite m_spriteArrowDownHover;
 
        // Cached renderer properties
        Borders m_bordersCached;
        Color   m_borderColorCached;
        Color   m_backgroundColorCached;
        Color   m_backgroundColorHoverCached;
        Color   m_arrowColorCached;
        Color   m_arrowColorHoverCached;
        float   m_borderBetweenArrowsCached = 0;
    };

}

 
#endif // TGUI_SPIN_BUTTON_HPP