ProgressBar.hpp

 
//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2024 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_PROGRESS_BAR_HPP
#define TGUI_PROGRESS_BAR_HPP
 
#include <TGUI/Renderers/ProgressBarRenderer.hpp>
#include <TGUI/Widgets/ClickableWidget.hpp>
#include <TGUI/Text.hpp>
 
 
TGUI_MODULE_EXPORT namespace tgui
{
    class TGUI_API ProgressBar : public ClickableWidget
    {
    public:
 
        using Ptr = std::shared_ptr<ProgressBar>; 
        using ConstPtr = std::shared_ptr<const ProgressBar>; 
 
        static constexpr const char StaticWidgetType[] = "ProgressBar"; 
 
        enum class FillDirection
        {
            LeftToRight,  
            RightToLeft,  
            TopToBottom,  
            BottomToTop   
        };
 
        ProgressBar(const char* typeName = StaticWidgetType, bool initRenderer = true);
 
        TGUI_NODISCARD static ProgressBar::Ptr create();
 
        TGUI_NODISCARD static ProgressBar::Ptr copy(const ProgressBar::ConstPtr& progressBar);
 
        TGUI_NODISCARD ProgressBarRenderer* getSharedRenderer() override;
        TGUI_NODISCARD const ProgressBarRenderer* getSharedRenderer() const override;
 
        TGUI_NODISCARD ProgressBarRenderer* getRenderer() override;
 
        void setSize(const Layout2d& size) override;
        using Widget::setSize;
 
        void setMinimum(unsigned int minimum);
 
        TGUI_NODISCARD unsigned int getMinimum() const;
 
        void setMaximum(unsigned int maximum);
 
        TGUI_NODISCARD unsigned int getMaximum() const;
 
        void setValue(unsigned int value);
 
        TGUI_NODISCARD unsigned int getValue() const;
 
        unsigned int incrementValue();
 
        void setText(const String& text);
 
        TGUI_NODISCARD const String& getText() const;
 
        void setFillDirection(FillDirection direction);
 
        TGUI_NODISCARD FillDirection getFillDirection() const;
 
        TGUI_NODISCARD bool isMouseOnWidget(Vector2f pos) const 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;
 
        void updateTextSize() override;
 
        // Returns the size without the borders
        TGUI_NODISCARD Vector2f getInnerSize() const;
 
        // When the value changes, or when the minimum/maximum limits change then a smaller of bigger piece of the front image
        // must be drawn. This function is called to calculate the size of the piece to draw.
        void recalculateFillSize();
 
        // Returns the size of the front image.
        TGUI_NODISCARD Vector2f getFrontImageSize() const;
 
        // Makes a copy of the widget
        TGUI_NODISCARD Widget::Ptr clone() const override;
 
    public:
 
        SignalUInt onValueChange = {"ValueChanged"}; 
        Signal     onFull        = {"Full"};         
 
    protected:
 
        unsigned int m_minimum = 0;
        unsigned int m_maximum = 100;
        unsigned int m_value = 0;
 
        Text m_textBack;
        Text m_textFront;
 
        FloatRect m_backRect;
        FloatRect m_frontRect;
 
        FillDirection m_fillDirection = FillDirection::LeftToRight;
 
        Sprite m_spriteBackground;
        Sprite m_spriteFill;
 
        // Cached renderer properties
        Borders m_bordersCached;
        Color   m_borderColorCached;
        Color   m_backgroundColorCached;
        Color   m_fillColorCached;
    };
 
}
 
 
#endif // TGUI_PROGRESS_BAR_HPP