Scrollbar.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_SCROLLBAR_HPP
#define TGUI_SCROLLBAR_HPP
 
 
#include <TGUI/Widget.hpp>
#include <TGUI/Renderers/ScrollbarRenderer.hpp>
 
#if !TGUI_EXPERIMENTAL_USE_STD_MODULE
 #include <chrono>
#endif
 
 
TGUI_MODULE_EXPORT namespace tgui
{
 class TGUI_API Scrollbar : public Widget
 {
 public:
 
 using Ptr = std::shared_ptr<Scrollbar>; 
 using ConstPtr = std::shared_ptr<const Scrollbar>; 
 
 static constexpr const char StaticWidgetType[] = "Scrollbar"; 
 
 
 enum class Policy
 {
 Automatic, 
 Always, 
 Never 
 };
 
 
 Scrollbar(const char* typeName = StaticWidgetType, bool initRenderer = true);
 
 
 TGUI_NODISCARD static Scrollbar::Ptr create();
 
 
 TGUI_NODISCARD static Scrollbar::Ptr copy(const Scrollbar::ConstPtr& scrollbar);
 
 
 TGUI_NODISCARD ScrollbarRenderer* getSharedRenderer() override;
 TGUI_NODISCARD const ScrollbarRenderer* getSharedRenderer() const override;
 
 TGUI_NODISCARD ScrollbarRenderer* getRenderer() override;
 
 
 void setSize(const Layout2d& size) override;
 using Widget::setSize;
 
 
 void setMaximum(unsigned int maximum);
 
 
 TGUI_NODISCARD unsigned int getMaximum() const;
 
 
 void setValue(unsigned int value);
 
 
 TGUI_NODISCARD unsigned int getValue() const;
 
 
 void setViewportSize(unsigned int viewport);
 
 
 TGUI_NODISCARD unsigned int getViewportSize() const;
 
 
 void setScrollAmount(unsigned int scrollAmount);
 
 
 TGUI_NODISCARD unsigned int getScrollAmount() const;
 
 
 void setAutoHide(bool autoHide);
 
 
 TGUI_NODISCARD bool getAutoHide() const;
 
 
 void setVerticalScroll(bool vertical);
 
 
 TGUI_NODISCARD bool getVerticalScroll() const;
 
 
 TGUI_NODISCARD float getDefaultWidth();
 
 
 TGUI_NODISCARD bool isMouseOnWidget(Vector2f pos) const override;
 
 bool leftMousePressed(Vector2f pos) override;
 
 void leftMouseReleased(Vector2f pos) override;
 
 void mouseMoved(Vector2f pos) override;
 
 bool scrolled(float delta, Vector2f pos, bool touch) override;
 
 void leftMouseButtonNoLongerDown() override;
 
 
 void draw(BackendRenderTarget& target, RenderStates states) const override;
 
 
 protected:
 
 
 // Updates the scrollbar after a size change
 void updateSize();
 
 
 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;
 
 
 // Updates the position of the thumb based on the current value of the slider
 void updateThumbPosition();
 
 
 // Makes a copy of the widget
 TGUI_NODISCARD Widget::Ptr clone() const override;
 
 
 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?
 
 std::chrono::steady_clock::time_point m_lastSuccessfulScrollTime; // Timestamp of the last mouse wheel scroll event
 Vector2f m_lastSuccessfulScrollPos; // Mouse position at the last mouse wheel scroll event
 
 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(BackendRenderTarget& target, RenderStates states) const override;
 
 
 };
 
}
 
 
#endif // TGUI_SCROLLBAR_HPP