ZFUIScrollView.h

Go to the documentation of this file.

 
#ifndef _ZFI_ZFUIScrollView_h_
#define _ZFI_ZFUIScrollView_h_
 
#include "ZFUIView.h"
ZF_NAMESPACE_GLOBAL_BEGIN

ZFENUM_BEGIN(ZFLIB_ZFUIKit, ZFUIScrollViewState)
    ZFENUM_VALUE(Idle)
    ZFENUM_VALUE(Dragging)
    ZFENUM_VALUE(Scrolling)
ZFENUM_SEPARATOR()
    ZFENUM_VALUE_REGISTER(Idle)
    ZFENUM_VALUE_REGISTER(Dragging)
    ZFENUM_VALUE_REGISTER(Scrolling)
ZFENUM_END(ZFLIB_ZFUIKit, ZFUIScrollViewState)
ZFENUM_REG(ZFLIB_ZFUIKit, ZFUIScrollViewState)
 
zfclassFwd _ZFP_ZFUIScrollViewPrivate;
// ============================================================
// ZFUIScrollView
zfclass ZFLIB_ZFUIKit ZFUIScrollView : zfextend ZFUIView {
    ZFOBJECT_DECLARE(ZFUIScrollView, ZFUIView)
    ZFSTYLE_DEFAULT_DECLARE(ZFUIScrollView)
 
public:
    // ============================================================
    // event
    ZFEVENT(ScrollOnDragBegin)
    ZFEVENT(ScrollOnDrag)
    ZFEVENT(ScrollOnDragEnd)
    ZFEVENT(ScrollOnScrollBegin)
    ZFEVENT(ScrollOnScroll)
    ZFEVENT(ScrollOnScrollEnd)
    ZFEVENT(ScrollAreaOnUpdate)
    ZFEVENT(ScrollContentFrameOnUpdate)
    ZFEVENT(ScrollAutoScrollOnStart)
    ZFEVENT(ScrollAutoScrollOnStop)
    ZFEVENT(ScrollOnScrolledByUser)
 
public:
    // ============================================================
    // properties
    ZFPROPERTY_ASSIGN(zfbool, scrollEnable, zftrue)
    ZFPROPERTY_ON_ATTACH_DECLARE(zfbool, scrollEnable)

    ZFPROPERTY_ASSIGN(zfbool, scrollBounceHorizontal, zftrue)
    ZFPROPERTY_ON_ATTACH_DECLARE(zfbool, scrollBounceHorizontal)
    ZFPROPERTY_ASSIGN(zfbool, scrollBounceVertical, zftrue)
    ZFPROPERTY_ON_ATTACH_DECLARE(zfbool, scrollBounceVertical)
    ZFPROPERTY_ASSIGN(zfbool, scrollBounceHorizontalAlways, zffalse)
    ZFPROPERTY_ON_ATTACH_DECLARE(zfbool, scrollBounceHorizontalAlways)
    ZFPROPERTY_ASSIGN(zfbool, scrollBounceVerticalAlways, zffalse)
    ZFPROPERTY_ON_ATTACH_DECLARE(zfbool, scrollBounceVerticalAlways)

    ZFPROPERTY_ASSIGN(zfbool, scrollAlignToAxis, zffalse)
    ZFPROPERTY_ASSIGN(zfbool, scrollAlignToPageHorizontal)
    ZFPROPERTY_ON_ATTACH_DECLARE(zfbool, scrollAlignToPageHorizontal)
    ZFPROPERTY_ASSIGN(zfbool, scrollAlignToPageVertical)
    ZFPROPERTY_ON_ATTACH_DECLARE(zfbool, scrollAlignToPageVertical)

    ZFPROPERTY_ASSIGN(ZFUIRect, scrollContentFrame)
    ZFPROPERTY_ON_ATTACH_DECLARE(ZFUIRect, scrollContentFrame)
    zffinal void _ZFP_ZFUIScrollView_scrollContentFrameByImpl(ZF_IN const ZFUIRect &rect);
 
protected:
    zfoverride
    virtual void objectOnInit(void);
    zfoverride
    virtual void objectOnDealloc(void);
    zfoverride
    virtual void objectOnDeallocPrepare(void);
 
protected:
    zfoverride
    virtual void objectInfoImplAppend(ZF_IN_OUT zfstring &ret);
 
    // ============================================================
    // override ZFUIView
protected:
    zfoverride
    virtual void implChildOnAdd(
            ZF_IN ZFUIView *child
            , ZF_IN zfindex virtualIndex
            , ZF_IN ZFUIViewChildLayer childLayer
            , ZF_IN zfindex childLayerIndex
            );
    zfoverride
    virtual void implChildOnRemove(
            ZF_IN ZFUIView *child
            , ZF_IN zfindex virtualIndex
            , ZF_IN ZFUIViewChildLayer childLayer
            , ZF_IN zfindex childLayerIndex
            );
    zfoverride
    virtual void implChildOnRemoveAllForDealloc(void);
 
protected:
    zfoverride
    virtual void layoutOnLayoutPrepare(ZF_IN const ZFUIRect &bounds);
    zfoverride
    virtual void layoutOnLayout(ZF_IN const ZFUIRect &bounds);
    zfoverride
    virtual void layoutOnLayoutFinish(ZF_IN const ZFUIRect &bounds);
    zfoverride
    virtual inline void layoutChildOffsetOnUpdate(ZF_IN_OUT ZFUIPoint &ret) {
        ret.x += this->scrollContentFrame().x;
        ret.y += this->scrollContentFrame().y;
    }

    zfoverride
    virtual void viewEventOnMouseEvent(ZF_IN ZFUIMouseEvent *mouseEvent);
    zfoverride
    virtual void viewEventOnWheelEvent(ZF_IN ZFUIWheelEvent *wheelEvent);
 
    zfoverride
    virtual void nativeImplViewMarginOnUpdate(void);
 
    // ============================================================
    // util methods
public:
    ZFMETHOD_DECLARE_0(void, scrollToFitRange)
    ZFMETHOD_DECLARE_3(void, scrollChildToVisible
            , ZFMP_IN(ZFUIView *, child)
            , ZFMP_IN_OPT(const ZFUIMargin &, margin, ZFUIMarginCreate(ZFUIGlobalStyle::DefaultStyle()->itemMargin()))
            , ZFMP_IN_OPT(zfbool, scrollWithAni, zftrue)
            )
 
    // ============================================================
    // scroll area
public:
    ZFMETHOD_DECLARE_1(void, scrollAreaMarginAdd
            , ZFMP_IN(const ZFUIMargin &, margin)
            )
    ZFMETHOD_DECLARE_1(void, scrollAreaMarginRemove
            , ZFMP_IN(const ZFUIMargin &, margin)
            )
    ZFMETHOD_DECLARE_0(const ZFUIMargin &, scrollAreaMargin)
    ZFMETHOD_DECLARE_0(const ZFUIRect &, scrollArea)
 
    // ============================================================
    // scroll thumb
public:
    ZFMETHOD_DECLARE_1(void, scrollThumbHorizontalClass
            , ZFMP_IN(const ZFClass *, cls)
            )
    ZFMETHOD_DECLARE_0(const ZFClass *, scrollThumbHorizontalClass)
    ZFMETHOD_DECLARE_1(void, scrollThumbVerticalClass
            , ZFMP_IN(const ZFClass *, cls)
            )
    ZFMETHOD_DECLARE_0(const ZFClass *, scrollThumbVerticalClass)
protected:
    virtual void scrollThumbHorizontalOnInit(void);
    virtual void scrollThumbVerticalOnInit(void);
 
    // ============================================================
    // scroll control
public:
    ZFMETHOD_DECLARE_0(const ZFClass *, scrollerClass)
 
public:
    ZFMETHOD_DECLARE_0(zffloat, scrollContentOffsetLeft)
    ZFMETHOD_DECLARE_0(zffloat, scrollContentOffsetTop)
    ZFMETHOD_DECLARE_0(zffloat, scrollContentOffsetRight)
    ZFMETHOD_DECLARE_0(zffloat, scrollContentOffsetBottom)
 
public:
    ZFMETHOD_DECLARE_1(void, scrollContentFrameAnimated
            , ZFMP_IN(const ZFUIRect &, scrollContentFrame)
            )
    ZFMETHOD_DECLARE_1(void, scrollContentFrameUpdate
            , ZFMP_IN(const ZFUIRect &, scrollContentFrame)
            )
    ZFMETHOD_DECLARE_2(void, scrollByPoint
            , ZFMP_IN(zffloat, xPos)
            , ZFMP_IN(zffloat, yPos)
            )
    ZFMETHOD_DECLARE_0(ZFUIPoint, scrollByPointEndPoint)
    ZFMETHOD_DECLARE_2(void, scrollBySpeed
            , ZFMP_IN(zffloat, xSpeedInPixelsPerSecond)
            , ZFMP_IN(zffloat, ySpeedInPixelsPerSecond)
            )
    ZFMETHOD_DECLARE_0(zffloat, scrollBySpeedCurrentSpeedX)
    ZFMETHOD_DECLARE_0(zffloat, scrollBySpeedCurrentSpeedY)
    ZFMETHOD_DECLARE_0(ZFUIPoint, scrollBySpeedEndPointPredicted)

    ZFMETHOD_DECLARE_0(ZFUIPoint, scrollEndPointPredicted)
 
public:
    ZFMETHOD_DECLARE_1(void, autoScrollStartX
            , ZFMP_IN(zffloat, speedInPixelsPerSecond)
            )
    ZFMETHOD_DECLARE_1(void, autoScrollStartY
            , ZFMP_IN(zffloat, speedInPixelsPerSecond)
            )
    ZFMETHOD_DECLARE_0(void, autoScrollStopX)
    ZFMETHOD_DECLARE_0(void, autoScrollStopY)
    ZFMETHOD_DECLARE_0(zffloat, autoScrollSpeedX)
    ZFMETHOD_DECLARE_0(zffloat, autoScrollSpeedY)
 
public:
    ZFMETHOD_DECLARE_2(void, scrollSimulateDragBegin
            , ZFMP_IN(const ZFUIPoint &, mousePos)
            , ZFMP_IN(zftimet, mouseTime)
            )
    ZFMETHOD_DECLARE_2(void, scrollSimulateDrag
            , ZFMP_IN(const ZFUIPoint &, mousePos)
            , ZFMP_IN(zftimet, mouseTime)
            )
    ZFMETHOD_DECLARE_2(void, scrollSimulateDragEnd
            , ZFMP_IN(zftimet, mouseTime)
            , ZFMP_IN_OPT(zfbool, needScrollAni, zftrue)
            )
 
protected:
    zffinal void scrollOverride(ZF_IN zfbool scrollOverride);
    zffinal zfbool scrollOverride(void);
 
    // ============================================================
    // scroll status
public:
    ZFMETHOD_DECLARE_0(ZFUIScrollViewState, scrollViewState)
 
    // ============================================================
    // scroll callbacks
public:
    zffinal void _ZFP_ZFUIScrollView_notifyDragBegin(
            ZF_IN const ZFUIPoint &mousePos
            , ZF_IN zftimet mouseTime
            );
    zffinal void _ZFP_ZFUIScrollView_notifyDrag(
            ZF_IN const ZFUIPoint &mousePos
            , ZF_IN zftimet mouseTime
            );
    zffinal void _ZFP_ZFUIScrollView_notifyDragEnd(
            ZF_IN zftimet mouseTime
            , ZF_IN zfbool needScrollAni
            );
    zffinal void _ZFP_ZFUIScrollView_notifyScrollAnimation(ZF_IN zftimet relativeTimeInMiliseconds);
protected:
    virtual inline void scrollOnDragBegin(void) {
        this->observerNotify(ZFUIScrollView::E_ScrollOnDragBegin());
    }

    virtual inline void scrollOnDrag(void) {
        this->observerNotify(ZFUIScrollView::E_ScrollOnDrag());
    }

    virtual inline void scrollOnDragEnd(void) {
        this->observerNotify(ZFUIScrollView::E_ScrollOnDragEnd());
    }

    virtual inline void scrollOnScrollBegin(void) {
        this->observerNotify(ZFUIScrollView::E_ScrollOnScrollBegin());
    }

    virtual inline void scrollOnScroll(void) {
        this->observerNotify(ZFUIScrollView::E_ScrollOnScroll());
    }

    virtual inline void scrollOnScrollEnd(void) {
        this->observerNotify(ZFUIScrollView::E_ScrollOnScrollEnd());
    }

    virtual inline void scrollAreaOnUpdate(void) {
        this->observerNotify(ZFUIScrollView::E_ScrollAreaOnUpdate());
    }

    virtual inline void scrollContentFrameOnUpdate(void) {
        this->observerNotify(ZFUIScrollView::E_ScrollContentFrameOnUpdate());
    }

    virtual inline void scrollAutoScrollOnStart(void) {
        this->observerNotify(ZFUIScrollView::E_ScrollAutoScrollOnStart());
    }

    virtual inline void scrollAutoScrollOnStop(void) {
        this->observerNotify(ZFUIScrollView::E_ScrollAutoScrollOnStop());
    }

    virtual inline void scrollOnScrolledByUser(void) {
        this->observerNotify(ZFUIScrollView::E_ScrollOnScrolledByUser());
    }
 
private:
    _ZFP_ZFUIScrollViewPrivate *d;
    friend zfclassFwd _ZFP_ZFUIScrollViewPrivate;
};
 
ZF_NAMESPACE_GLOBAL_END
#endif // #ifndef _ZFI_ZFUIScrollView_h_