Scrollbar.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_SCROLLBAR_HPP
#define TGUI_SCROLLBAR_HPP
 
 
#include <TGUI/Widget.hpp>
#include <TGUI/Renderers/ScrollbarRenderer.hpp>
 
 
namespace tgui
{
    class TGUI_API Scrollbar : public Widget
    {
    public:
 
        typedef std::shared_ptr<Scrollbar> Ptr; 
        typedef std::shared_ptr<const Scrollbar> ConstPtr; 
 
 
        enum class Policy
        {
            Automatic,  
            Always,     
            Never       
        };
 
 
        Scrollbar(const char* typeName = "Scrollbar", bool initRenderer = true);
 
 
        static Scrollbar::Ptr create();
 
 
        static Scrollbar::Ptr copy(Scrollbar::ConstPtr scrollbar);
 
 
        ScrollbarRenderer* getSharedRenderer();
        const ScrollbarRenderer* getSharedRenderer() const;
 
        ScrollbarRenderer* getRenderer();
        const ScrollbarRenderer* getRenderer() const;
 
 
        void setSize(const Layout2d& size) override;
        using Widget::setSize;
 
 
        void setMaximum(unsigned int maximum);
 
 
        unsigned int getMaximum() const;
 
 
        void setValue(unsigned int value);
 
 
        unsigned int getValue() const;
 
 
        void setViewportSize(unsigned int viewport);
 
 
        unsigned int getViewportSize() const;
 
 
        void setScrollAmount(unsigned int scrollAmount);
 
 
        unsigned int getScrollAmount() const;
 
 
        void setAutoHide(bool autoHide);
 
 
        bool getAutoHide() const;
 
 
        void setVerticalScroll(bool vertical);
 
 
        bool getVerticalScroll() const;
 
 
        float getDefaultWidth();
 
 
        bool isMouseOnWidget(Vector2f pos) const override;
 
        void leftMousePressed(Vector2f pos) override;
 
        void leftMouseReleased(Vector2f pos) override;
 
        void mouseMoved(Vector2f pos) override;
 
        bool mouseWheelScrolled(float delta, Vector2f pos) override;
 
        void leftMouseButtonNoLongerDown() override;
 
 
        void draw(BackendRenderTargetBase& target, RenderStates states) const override;
 
 
    protected:
 
 
        // Updates the scrollbar after a size change
        void updateSize();
 
 
        Signal& getSignal(String signalName) override;
 
 
        void rendererChanged(const String& property) override;
 
 
        std::unique_ptr<DataIO::Node> save(SavingRenderersMap& renderers) const override;
 
 
        void load(const std::unique_ptr<DataIO::Node>& node, const LoadingRenderersMap& renderers) override;
 
 
        // Updates the position of the thumb based on the current value of the slider
        void updateThumbPosition();
 
 
        // Makes a copy of the widget
        Widget::Ptr clone() const override
        {
            return std::make_shared<Scrollbar>(*this);
        }
 
 
    public:
 
        SignalUInt onValueChange = {"ValueChanged"}; 
 
 
    protected:
 
        enum class Part
        {
            Track,
            Thumb,
            ArrowUp,
            ArrowDown
        };
 
        // Keep track on which part of the scrollbar the mouse is standing
        Part m_mouseHoverOverPart = Part::Thumb;
 
        // When the mouse went down, did it go down on top of the thumb? If so, where?
        bool m_mouseDownOnThumb = false;
        Vector2f m_mouseDownOnThumbPos;
 
        unsigned int m_maximum = 10;
        unsigned int m_value = 0;
 
        // Maximum should be above this value before the scrollbar is needed
        unsigned int m_viewportSize = 1;
 
        // Is the scrollbar draw vertically?
        bool m_verticalScroll = true;
 
        // Does the image lie vertically?
        bool m_verticalImage = true;
 
        // How far should the value change when pressing one of the arrows?
        unsigned int m_scrollAmount = 1;
 
        // When no scrollbar is needed, should the scrollbar be drawn or stay hidden?
        bool m_autoHide = true;
 
        // Did the mouse went down on one of the arrows?
        bool m_mouseDownOnArrow = false;
 
        bool m_sizeSet = false; // Has setSize been called?
 
        FloatRect m_track;
        FloatRect m_thumb;
        FloatRect m_arrowUp;
        FloatRect m_arrowDown;
 
        Sprite m_spriteTrack;
        Sprite m_spriteTrackHover;
        Sprite m_spriteThumb;
        Sprite m_spriteThumbHover;
        Sprite m_spriteArrowUp;
        Sprite m_spriteArrowUpHover;
        Sprite m_spriteArrowDown;
        Sprite m_spriteArrowDownHover;
 
        // Cached renderer properties
        Color m_thumbColorCached;
        Color m_thumbColorHoverCached;
        Color m_trackColorCached;
        Color m_trackColorHoverCached;
        Color m_arrowColorCached;
        Color m_arrowColorHoverCached;
        Color m_arrowBackgroundColorCached;
        Color m_arrowBackgroundColorHoverCached;
 
    };
 
 
    class TGUI_API ScrollbarChildWidget : public Scrollbar
    {
    public:
 
        bool isMouseDownOnThumb() const;
 
 
        bool isShown() const;
 
 
        void draw(BackendRenderTargetBase& target, RenderStates states) const override;
 
 
    };
 
}
 
 
#endif // TGUI_SCROLLBAR_HPP