UIScrollView.hpp

Go to the documentation of this file.

//
//  CeresEngine - A game development framework
//
//  Created by Rogiel Sulzbach.
//  Copyright (c) 2018-2022 Rogiel Sulzbach. All rights reserved.
//
 
#pragma once
 
#include "UIView.hpp"
 
namespace CeresEngine {
 
    class UIClipView;
    class UIScroller;
 
    class UIScrollView : public UIView {
        using super = UIView;
 
    private:
        UIClipView* mClipView = nullptr;
 
        UIScroller* mHorizontalScroller = nullptr;
 
        UIScroller* mVerticalScroller = nullptr;
 
        bool mAutohidesScrollers = false;
 
        double mHorizontalLineScroll = 1.0;
                
        double mVerticalLineScroll = 1.0;
 
        double mHorizontalPageScroll = 10.0;
 
        double mVerticalPageScroll = 10.0;
 
        bool mScrollsDynamically = true;
 
        bool mResizesIfScrollerDisabled = true;
 
    private:
        EventConnection mHorizontalScrollerDidScrollConnection;
        EventConnection mVerticalScrollerDidScrollConnection;
 
    public:
        UIScrollView();
        
        explicit UIScrollView(const String& name);
 
        explicit UIScrollView(const UIRect& frame, const String& name = "");
 
        explicit UIScrollView(const UISize& size, const String& name = "") : UIScrollView(UIPoint(0, 0), size, name) {}
 
        explicit UIScrollView(const UIPoint& origin, const UISize& size, const String& name = "") : UIScrollView(UIRect(origin, size), name) {}
 
        explicit UIScrollView(const double x, const double y, const double width, const double height, const String& name = "") : UIScrollView(UIRect(x, y, width, height), name) {}
 
        ~UIScrollView() override;
        
    public: // Views
        [[nodiscard]] UIClipView* getClipView() const noexcept { return mClipView; }
 
        [[nodiscard]] UIView* getDocumentView() const noexcept;
        
        void setDocumentView(UIView* documentView);
 
    public: // Scrollers
        [[nodiscard]] UIScroller* getHorizontalScroller() const noexcept { return mHorizontalScroller; }
 
        [[nodiscard]] bool hasHorizontalScroller() const { return mHorizontalScroller != nullptr; }
 
        void setHasHorizontalScroller(bool hasHorizontalScroller);
 
        [[nodiscard]] UIScroller* getVerticalScroller() const noexcept { return mVerticalScroller; }
 
        [[nodiscard]] bool hasVerticalScroller() const noexcept { return mVerticalScroller != nullptr; };
 
        void setHasVerticalScroller(bool hasVerticalScroller);
 
        [[nodiscard]] bool autohidesScrollers() const noexcept { return mAutohidesScrollers; }
 
        void setAutohidesScrollers(bool autohidesScrollers);
 
        bool resizesIfScrollerDisabled() const noexcept { return mResizesIfScrollerDisabled; }
 
        void setResizesIfScrollerDisabled(bool resizesIfScrollerDisabled);
 
    public: // Scrolling behavior
        [[nodiscard]] double getHorizontalLineScroll() const noexcept { return mHorizontalLineScroll; }
 
        void setHorizontalLineScroll(double horizontalLineScroll);
 
        [[nodiscard]] double getVerticalLineScroll() const noexcept { return mVerticalLineScroll; }
 
        void setVerticalLineScroll(double verticalLineScroll);
 
        [[nodiscard]] double getHorizontalPageScroll() const noexcept { return mHorizontalPageScroll; }
 
        void setHorizontalPageScroll(double horizontalPageScroll);
 
        [[nodiscard]] double getVerticalPageScroll() const noexcept { return mVerticalPageScroll; }
 
        void setVerticalPageScroll(double verticalPageScroll);
 
        [[nodiscard]] bool isScrollsDynamically() const noexcept { return mScrollsDynamically; }
 
        void setScrollsDynamically(bool scrollsDynamically);
 
    public:
        void reflectScrolledClipView();
 
    public: // UIView
        void layoutSubviews() override;
 
        [[nodiscard]] UIScrollView* getScrollView() const final { return const_cast<UIScrollView*>(this); }
 
        void draw(CeresEngine::UIGraphicsContext &context, const CeresEngine::UIRect &dirtyRect) override;
 
        [[nodiscard]] UISize calculateFittingLayoutSize(const UISize& targetSize) const override;
 
    public: // UIResponder
        void scrollWheel(const CeresEngine::UIMouseEvent &event) override;
 
    protected:
        UIRect getInsetBounds() const;
 
        virtual UIRect getVerticalScrollerFrame() const;
 
        virtual UIRect getHorizontalScrollerFrame() const;
 
        virtual UIRect getClipViewFrame() const;
 
    private:
        void didScrollVertically();
 
        void didScrollHorizontally();
    };
 
} // namespace CeresEngine