ScrollablePanel.hpp

 
//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2020 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_SCROLLABLE_PANEL_HPP
#define TGUI_SCROLLABLE_PANEL_HPP
 
#include <TGUI/CopiedSharedPtr.hpp>
#include <TGUI/Widgets/Panel.hpp>
#include <TGUI/Widgets/Scrollbar.hpp>
#include <TGUI/Renderers/ScrollablePanelRenderer.hpp>
 
 
namespace tgui
{
 class TGUI_API ScrollablePanel : public Panel
 {
 public:
 
 typedef std::shared_ptr<ScrollablePanel> Ptr; 
 typedef std::shared_ptr<const ScrollablePanel> ConstPtr; 
 
#ifndef TGUI_REMOVE_DEPRECATED_CODE
 using ScrollbarPolicy TGUI_DEPRECATED("Use tgui::Scrollbar::Policy instead") = Scrollbar::Policy;
#endif
 
 ScrollablePanel(const Layout2d& size = {"100%", "100%"}, Vector2f contentSize = {0, 0});
 
 
 ScrollablePanel(const ScrollablePanel& copy);
 
 
 ScrollablePanel(ScrollablePanel&& copy);
 
 
 ScrollablePanel& operator= (const ScrollablePanel& other);
 
 
 ScrollablePanel& operator= (ScrollablePanel&& other);
 
 
 static ScrollablePanel::Ptr create(Layout2d size = {"100%", "100%"}, Vector2f contentSize = {0, 0});
 
 
 static ScrollablePanel::Ptr copy(ScrollablePanel::ConstPtr panel);
 
 
 ScrollablePanelRenderer* getSharedRenderer();
 const ScrollablePanelRenderer* getSharedRenderer() const;
 
 ScrollablePanelRenderer* getRenderer();
 const ScrollablePanelRenderer* getRenderer() const;
 
 
 void setSize(const Layout2d& size) override;
 using Widget::setSize;
 
 
 Vector2f getAbsolutePosition() const override;
 
 
 void add(const Widget::Ptr& widget, const sf::String& widgetName = "") override;
 
 
 bool remove(const Widget::Ptr& widget) override;
 
 
 void removeAllWidgets() override;
 
 
 void setContentSize(Vector2f size);
 
 
 Vector2f getContentSize() const;
 
 
 Vector2f getContentOffset() const;
 
#ifndef TGUI_REMOVE_DEPRECATED_CODE
 TGUI_DEPRECATED("Use the ScrollbarWidth renderer property instead") void setScrollbarWidth(float width);
#endif
 
 float getScrollbarWidth() const;
 
 
 void setVerticalScrollbarPolicy(Scrollbar::Policy policy);
 
 
 Scrollbar::Policy getVerticalScrollbarPolicy() const;
 
 
 void setHorizontalScrollbarPolicy(Scrollbar::Policy policy);
 
 
 Scrollbar::Policy getHorizontalScrollbarPolicy() const;
 
 
 void setVerticalScrollAmount(unsigned int scrollAmount);
 
 
 unsigned int getVerticalScrollAmount() const;
 
 
 void setHorizontalScrollAmount(unsigned int scrollAmount);
 
 
 unsigned int getHorizontalScrollAmount() const;
 
 
 void setVerticalScrollbarValue(unsigned int value);
 
 
 unsigned int getVerticalScrollbarValue() const;
 
 
 void setHorizontalScrollbarValue(unsigned int value);
 
 
 unsigned int getHorizontalScrollbarValue() const;
 
 
 void enableSkipDrawingWidgetsOutsideView(bool skipDrawing = true);
 
 
 Widget::Ptr getWidgetAtPosition(sf::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 mouseNoLongerOnWidget() override;
 
 void leftMouseButtonNoLongerDown() override;
 
 
 // Shows the tool tip when the widget is located below the mouse.
 // Returns its tool tip or the tool tip from a child widget if the mouse is on top of the widget.
 // A nullptr is returned when the mouse is not on top of the widget or when the tool tip is empty.
 Widget::Ptr askToolTip(Vector2f mousePos) override;
 
 
 void draw(sf::RenderTarget& target, sf::RenderStates states) const override;
 
 
 protected:
 
 void rendererChanged(const std::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;
 
 
 // Makes a copy of the widget
 Widget::Ptr clone() const override
 {
 return std::make_shared<ScrollablePanel>(*this);
 }
 
 
 private:
 
 // Update the position, size and value of the scrollbars
 void updateScrollbars();
 
 
 // Find out what the most right and bottom positions are that are in use by the child widgets
 void recalculateMostBottomRightPosition();
 
 
 // Connect the position and size events to recalculate the bottom right position when a widget is updated
 void connectPositionAndSize(Widget::Ptr widget);
 
 
 // Disconnect the position and size events that were connected to keep track of widget changes
 void disconnectAllChildWidgets();
 
 
 private:
 
 Vector2f m_contentSize;
 Vector2f m_mostBottomRightPosition;
 CopiedSharedPtr<ScrollbarChildWidget> m_verticalScrollbar;
 CopiedSharedPtr<ScrollbarChildWidget> m_horizontalScrollbar;
 
 Scrollbar::Policy m_verticalScrollbarPolicy = Scrollbar::Policy::Automatic;
 Scrollbar::Policy m_horizontalScrollbarPolicy = Scrollbar::Policy::Automatic;
 
 unsigned int m_verticalScrollAmount = 0;
 unsigned int m_horizontalScrollAmount = 0;
 
 bool m_skipDrawingWidgetsOutsideView = false;
 
 std::map<Widget::Ptr, unsigned int> m_connectedCallbacks;
 
 };
 
}
 
 
#endif // TGUI_SCROLLABLE_PANEL_HPP