SpinControl.hpp

 
//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2022 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>
 
 
namespace tgui
{
    class TGUI_API SpinControl : public SubwidgetContainer
    {
    public:
 
        typedef std::shared_ptr<SpinControl> Ptr; 
        typedef std::shared_ptr<const SpinControl> ConstPtr; 
 
 
        SpinControl(const char* typeName = "SpinControl", bool initRenderer = true);
 
 
        static SpinControl::Ptr create(float min = 0.0f, float max = 10.0f, float value = 0.0f, unsigned int decimal = 0, float step = 1.0f);
 
 
        static SpinControl::Ptr copy(SpinControl::ConstPtr SpinCtrl);
 
 
        SpinButtonRenderer* getSpinButtonSharedRenderer();
        const SpinButtonRenderer* getSpinButtonSharedRenderer() const;
 
        SpinButtonRenderer* getSpinButtonRenderer();
        const SpinButtonRenderer* getSpinButtonRenderer() const;
 
 
        EditBoxRenderer* getSpinTextSharedRenderer();
        const EditBoxRenderer* getSpinTextSharedRenderer() const;
 
 
        EditBoxRenderer* getSpinTextRenderer();
        const EditBoxRenderer* getSpinTextRenderer() const;
 
 
        void setSize(const Layout2d& size) override;
        using SubwidgetContainer::setSize;
 
 
        void setMinimum(float minimum);
 
 
        float getMinimum() const;
 
 
        void setMaximum(float maximum);
 
 
        float getMaximum() const;
 
 
        bool setValue(float value);
 
 
        float getValue() const;
 
 
        void setStep(float step);
 
 
        float getStep() const;
 
 
        void setDecimalPlaces(unsigned int decimalPlaces);
 
 
        unsigned int getDecimalPlaces() const;
 
 
    protected:
 
        // Makes a copy of the widget
        Widget::Ptr clone() const override
        {
            return std::make_shared<SpinControl>(*this);
        }
 
 
        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 tgui::String& str);
 
 
    public:
 
        SignalFloat onValueChange = {"ValueChanged"}; 
 
 
    protected:
 
        unsigned int m_decimalPlaces = 0;
 
    private:
        tgui::SpinButton::Ptr m_spinButton;
        tgui::EditBox::Ptr m_spinText;
    };
 
}
 
 
#endif // TGUI_SPIN_CONTROL_HPP