scrolling_frame.hpp

Go to the documentation of this file.

/*
    Copyright 2020-2021 natinusala
    Copyright 2021 XITRIX
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at
 
        http://www.apache.org/licenses/LICENSE-2.0
 
    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
*/
 
#pragma once
 
#include <aurore/core/time.hpp>
 
#include <aurore/core/animation.hpp>
#include <aurore/core/box.hpp>
#include <aurore/views/rectangle.hpp>
 
namespace aurore
{
 
enum class ScrollingBehavior
{
    NATURAL,
 
    CENTERED,
};
 
class ScrollingFrame : public Box
{
  public:
    ScrollingFrame();
    ~ScrollingFrame();
 
    void draw(NVGcontext* vg, float x, float y, float width, float height, Style style, FrameContext* ctx) override;
    void onFocusGained() override;
    void onChildFocusGained(View* directChild, View* focusedView) override;
    void onChildFocusLost(View* directChild, View* focusedView) override;
    void willAppear(bool resetState) override;
    void addView(View* view) override;
    void removeView(View* view, bool free = true) override;
    void onLayout() override;
    void setPadding(float top, float right, float bottom, float left) override;
    void setPaddingTop(float top) override;
    void setPaddingRight(float right) override;
    void setPaddingBottom(float bottom) override;
    void setPaddingLeft(float left) override;
    View* getParentNavigationDecision(View* from, View* newFocus, FocusDirection direction) override;
    View* getNextFocus(FocusDirection direction, View* currentView) override;
    View* getDefaultFocus() override;
    enum Sound getFocusSound() override;
    Rect getVisibleFrame();
 
    void setContentView(View* view);
 
    void setScrollingBehavior(ScrollingBehavior behavior);
 
    float getContentOffsetY() const
    {
        return contentOffsetY;
    }
 
    void setContentOffsetY(float value, bool animated);
 
    void setScrollingIndicatorAutoHide(bool autoHide)
    {
        autoHideScrollingIndicator = autoHide;
    }
 
    void setScrollingIndicatorVisible(bool visible)
    {
        showScrollingIndicator = visible;
    }
 
    static View* create();
 
  protected:
    View* contentView             = nullptr;
    Rectangle* scrollingIndicator = nullptr;
 
    bool updateScrollingOnNextFrame = false;
    bool childFocused               = false;
    bool showScrollingIndicator     = true;
    bool autoHideScrollingIndicator = true;
    float lastIndicatorOffset       = -1;
    bool indicatorShowsFocus = false;
    Time lastScrollTime      = 0;
 
    float middleY = 0; 
    float bottomY = 0; 
 
    Animatable contentOffsetY = 0.0f;
 
    void prebakeScrolling();
    bool updateScrolling(bool animated);
    void startScrolling(bool animated, float newScroll);
    void animateScrolling(float newScroll, float time);
    void scrollAnimationTick();
 
    float getScrollingAreaTopBoundary();
    float getScrollingAreaHeight();
 
    float getContentHeight();
 
    ScrollingBehavior behavior     = ScrollingBehavior::NATURAL;
    bool naturalScrollingCanScroll = false;
    bool isRubberBanding           = false; 
    void naturalScrollingBehaviour();
    void naturalScrollingButtonProcessing(FocusDirection focusDirection, bool* repeat);
    View* findTopMostFocusableView();
 
    void setupScrollingIndicator();
    void updateScrollingIndicatior();
 
    Event<InputType>::Subscription inputTypeSubscription;
};
 
} // namespace aurore