SpinControl.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_CONTROL_HPP
#define TGUI_SPIN_CONTROL_HPP
 
#include <TGUI/SubwidgetContainer.hpp>
#include <TGUI/Widgets/SpinButton.hpp>
#include <TGUI/Widgets/EditBox.hpp>

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

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

        SpinControl(const SpinControl& copy);

        SpinControl(SpinControl&& copy) noexcept;

        SpinControl& operator= (const SpinControl& right);

        SpinControl& operator= (SpinControl&& right) noexcept;

        TGUI_NODISCARD static SpinControl::Ptr create(float min = 0.0f, float max = 10.0f, float value = 0.0f, unsigned int decimal = 0, float step = 1.0f);

        TGUI_NODISCARD static SpinControl::Ptr copy(const SpinControl::ConstPtr& SpinCtrl);

        TGUI_NODISCARD SpinButtonRenderer* getSpinButtonSharedRenderer();
        TGUI_NODISCARD const SpinButtonRenderer* getSpinButtonSharedRenderer() const;

        TGUI_NODISCARD SpinButtonRenderer* getSpinButtonRenderer();

        TGUI_NODISCARD EditBoxRenderer* getSpinTextSharedRenderer();
        TGUI_NODISCARD const EditBoxRenderer* getSpinTextSharedRenderer() const;

        TGUI_NODISCARD EditBoxRenderer* getSpinTextRenderer();

        void setSize(const Layout2d& size) override;
        using SubwidgetContainer::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>>
        bool 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.
            if (m_spinButton->getValue() != static_cast<float>(value) && inRange(static_cast<float>(value)))
            {
                m_spinButton->setValue(value);
                setString(String::fromNumberRounded(value, m_decimalPlaces));
                return true;
            }
            return false;
        }

        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_spinButton->setStep(step);
        }

        TGUI_NODISCARD float getStep() const;

        void setDecimalPlaces(unsigned int decimalPlaces);

        TGUI_NODISCARD unsigned int getDecimalPlaces() const;

        TGUI_DEPRECATED("Use setSpinButtonWidth(\"100%\") or setSpinButtonWidth(\"50%\") instead") void setUseWideArrows(bool useWideArrows);

        TGUI_DEPRECATED("Use getSpinButtonWidth() instead") TGUI_NODISCARD bool getUseWideArrows() const;

        void setSpinButtonWidth(AbsoluteOrRelativeValue width);

        TGUI_NODISCARD float getSpinButtonWidth() const;

    protected:

        TGUI_NODISCARD Signal& getSignal(String signalName) override;

        // Makes a copy of the widget
        TGUI_NODISCARD Widget::Ptr clone() const 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;

    private:

        // Helper function that initializes the widget when constructing a new widget or loading one from a file
        void init();

        // Checks whether a value lies between the minimum and maximum
        bool inRange(const float value) const;

        // Updates the text in the edit box
        void setString(const String& str);

    public:
 
        SignalFloat onValueChange = {"ValueChanged"}; 

    protected:
 
        unsigned int m_decimalPlaces = 0;
        bool m_useWideArrows = false; // TGUI_NEXT: Remove
        AbsoluteOrRelativeValue m_spinButtonWidth;

    private:
        SpinButton::Ptr m_spinButton = SpinButton::create();
        EditBox::Ptr m_spinText = EditBox::create();
    };

}

 
#endif // TGUI_SPIN_CONTROL_HPP