ZFFramework
 
Loading...
Searching...
No Matches
ZFUIScroller.h
Go to the documentation of this file.
1
5
6#ifndef _ZFI_ZFUIScroller_h_
7#define _ZFI_ZFUIScroller_h_
8
9#include "ZFUITypeDef.h"
10ZF_NAMESPACE_GLOBAL_BEGIN
11
12// ============================================================
13// ZFUIScroller
29zfinterface ZFLIB_ZFUIKit ZFUIScroller : zfextend ZFInterface {
30 ZFINTERFACE_DECLARE(ZFUIScroller, ZFInterface)
31
32public:
38 ZFListener scrollAniStartCallback;
42 ZFListener scrollAniStopCallback;
43
44public:
49 virtual void scrollOwnerSizeOnUpdate(ZF_IN zffloat ownerSize) zfpurevirtual;
53 virtual void scrollBounceOnUpdate(
54 ZF_IN zfbool scrollBounce
55 , ZF_IN zfbool scrollBounceAlways
56 ) zfpurevirtual;
57
61 virtual void scrollAlignToPageOnUpdate(ZF_IN zfbool scrollAlignToPage) zfpurevirtual;
62
67 virtual void scrollContentOnUpdate(
68 ZF_IN zffloat contentOffset
69 , ZF_IN zffloat contentSize
70 ) zfpurevirtual;
71
72public:
76 virtual void scrollToFitRange(void) zfpurevirtual;
80 virtual void scrollStop(void) {
81 this->scrollWithoutAnimation(this->scrollContentOffset());
82 }
83
87 virtual void scrollWithoutAnimation(ZF_IN zffloat contentOffset) zfpurevirtual;
91 virtual void scrollByPoint(ZF_IN zffloat point) zfpurevirtual;
96 virtual zffloat scrollByPointEndPoint(void) zfpurevirtual;
100 virtual void scrollBySpeed(ZF_IN zffloat speed) zfpurevirtual;
104 virtual zffloat scrollBySpeedCurrentSpeed(void) zfpurevirtual;
109 virtual zffloat scrollBySpeedEndPointPredicted(void) zfpurevirtual;
110
115 virtual zffloat scrollEndPointPredicted(void) zfpurevirtual;
116
121 virtual zfbool scrollRequireFocus(void) zfpurevirtual;
122
123public:
127 virtual zffloat scrollOwnerSize(void) zfpurevirtual;
131 virtual zffloat scrollContentOffset(void) zfpurevirtual;
135 virtual zffloat scrollContentSize(void) zfpurevirtual;
136
137public:
143 virtual void scrollOnDragBegin(
144 ZF_IN zffloat mousePos
145 , ZF_IN zftimet mouseTime
146 ) zfpurevirtual;
152 virtual void scrollOnDrag(
153 ZF_IN zffloat mousePos
154 , ZF_IN zftimet mouseTime
155 ) zfpurevirtual;
163 virtual void scrollOnDragEnd(
164 ZF_IN zftimet mouseTime
165 , ZF_IN zfbool needScrollAni
166 ) zfpurevirtual;
167
168public:
172 virtual void scrollAniOnUpdate(ZF_IN zftimet time) zfpurevirtual;
173};
174
175// ============================================================
181ZFMETHOD_FUNC_DECLARE_1(ZFLIB_ZFUIKit, void, ZFUIScrollerClass
182 , ZFMP_IN(const ZFClass *, cls)
183 )
187ZFMETHOD_FUNC_DECLARE_0(ZFLIB_ZFUIKit, const ZFClass *, ZFUIScrollerClass)
188
189ZF_NAMESPACE_GLOBAL_END
190#endif // #ifndef _ZFI_ZFUIScroller_h_
191
zfextend
#define zfextend
dummy macro shows class inherit from another
Definition ZFCoreTypeDef_ClassType.h:53
zfpurevirtual
#define zfpurevirtual
dummy macro shows that a method is pure virtual method
Definition ZFCoreTypeDef_ClassType.h:68
ZF_IN
#define ZF_IN
dummy macro that shows the param used as required input
Definition ZFCoreTypeDef_ClassType.h:180
zfbool
_ZFT_t_zfbool zfbool
bool type
Definition ZFCoreTypeDef_CoreType.h:103
zftimet
_zft_zftimet zftimet
time unit, ensured at least 64 bit, ensured signed
Definition ZFCoreTypeDef_CoreType.h:203
zffloat
_zft_zffloat zffloat
same as float, see zfindex
Definition ZFCoreTypeDef_CoreType.h:183
ZFMP_IN
#define ZFMP_IN(ParamType, paramName)
macro to wrap param types for ZFMETHOD_INLINE_0 series
Definition ZFMethod.h:105
ZFMETHOD_FUNC_DECLARE_0
#define ZFMETHOD_FUNC_DECLARE_0(ZFLIB_, ReturnType, MethodName)
declare function type of ZFMethod
Definition ZFMethodFuncDeclare.h:493
ZFMETHOD_FUNC_DECLARE_1
#define ZFMETHOD_FUNC_DECLARE_1(ZFLIB_, ReturnType, MethodName, ZFMP_0)
see ZFMETHOD_FUNC_DECLARE_0
Definition ZFMethodFuncDeclare.h:624
ZF_NAMESPACE_GLOBAL_BEGIN
#define ZF_NAMESPACE_GLOBAL_BEGIN
begin namespace ZFFramework
Definition ZFNamespace.h:97
ZF_NAMESPACE_GLOBAL_END
#define ZF_NAMESPACE_GLOBAL_END
end namespace ZFFramework
Definition ZFNamespace.h:98
zfinterface
#define zfinterface
shows the type is an interface, see ZFInterface
Definition ZFObjectInterface.h:20
ZFINTERFACE_DECLARE
#define ZFINTERFACE_DECLARE(InterfaceName, ParentInterface,...)
see ZFInterface
Definition ZFObjectInterface.h:100
ZFLIB_ZFUIKit
#define ZFLIB_ZFUIKit
used to export symbols
Definition ZFUIKitDef.h:16
ZFUIScrollerClass
void ZFUIScrollerClass(const ZFClass *cls)
change default scroller
ZFUITypeDef.h
necessary header file for all ZFUIKit member
ZFClass
ZFObject's class info.
Definition ZFClass.h:67
ZFListener
listener as ZFCallback, mostly used by ZFObject::observerNotify
Definition ZFObjectObserver.h:30
ZFUIScroller::scrollOnDrag
virtual void scrollOnDrag(zffloat mousePos, zftimet mouseTime)=0
drag
ZFUIScroller::scrollBySpeedEndPointPredicted
virtual zffloat scrollBySpeedEndPointPredicted(void)=0
return end position of scrollBySpeed, must return current content offset if not scrolling
ZFUIScroller::scrollContentSize
virtual zffloat scrollContentSize(void)=0
used to get current content size
ZFUIScroller::scrollRequireFocus
virtual zfbool scrollRequireFocus(void)=0
whether this direction's scroller want higher priority, typically true if currently under progress to...
ZFUIScroller::scrollAniOnUpdate
virtual void scrollAniOnUpdate(zftimet time)=0
called to update scroll animation
ZFUIScroller::scrollOwnerSizeOnUpdate
virtual void scrollOwnerSizeOnUpdate(zffloat ownerSize)=0
called when owner scroll view's size changed, you should fix content frame to match bounds if necessa...
ZFUIScroller::scrollOnDragEnd
virtual void scrollOnDragEnd(zftimet mouseTime, zfbool needScrollAni)=0
drag end
ZFUIScroller::scrollOwnerSize
virtual zffloat scrollOwnerSize(void)=0
used to get current owner size
ZFUIScroller::scrollBounceOnUpdate
virtual void scrollBounceOnUpdate(zfbool scrollBounce, zfbool scrollBounceAlways)=0
whether use bounce
ZFUIScroller::scrollAniStopCallback
ZFListener scrollAniStopCallback
used to stop scroll animation's timer
Definition ZFUIScroller.h:42
ZFUIScroller::scrollAniStartCallback
ZFListener scrollAniStartCallback
used to start scroll animation's timer
Definition ZFUIScroller.h:38
ZFUIScroller::scrollContentOffset
virtual zffloat scrollContentOffset(void)=0
used to get current content offset
ZFUIScroller::scrollBySpeedCurrentSpeed
virtual zffloat scrollBySpeedCurrentSpeed(void)=0
return current speed of scrollBySpeed
ZFUIScroller::scrollBySpeed
virtual void scrollBySpeed(zffloat speed)=0
see ZFUIScrollView::scrollBySpeed
ZFUIScroller::scrollAlignToPageOnUpdate
virtual void scrollAlignToPageOnUpdate(zfbool scrollAlignToPage)=0
whether align to page
ZFUIScroller::scrollByPointEndPoint
virtual zffloat scrollByPointEndPoint(void)=0
return end position of scrollByPoint, must return current content offset if not scrolling
ZFUIScroller::scrollContentOnUpdate
virtual void scrollContentOnUpdate(zffloat contentOffset, zffloat contentSize)=0
used to update scroll content, you should keep or update previous scroll animation if necessary
ZFUIScroller::scrollToFitRange
virtual void scrollToFitRange(void)=0
cancel over scroll and ensure content offset in range
ZFUIScroller::scrollWithoutAnimation
virtual void scrollWithoutAnimation(zffloat contentOffset)=0
scroll without scroll animation, you should stop old scroll animation if necessary
ZFUIScroller::scrollByPoint
virtual void scrollByPoint(zffloat point)=0
see ZFUIScrollView::scrollByPoint
ZFUIScroller::scrollStop
virtual void scrollStop(void)
util method to stop scroll animation
Definition ZFUIScroller.h:80
ZFUIScroller::scrollEndPointPredicted
virtual zffloat scrollEndPointPredicted(void)=0
return end position, must return current content offset if not scrolling
ZFUIScroller::scrollOnDragBegin
virtual void scrollOnDragBegin(zffloat mousePos, zftimet mouseTime)=0
drag begin