ZFUIListView.h

Go to the documentation of this file.

 
#ifndef _ZFI_ZFUIListView_h_
#define _ZFI_ZFUIListView_h_
 
#include "ZFUICellAdapter.h"
#include "ZFUICellUpdater.h"
ZF_NAMESPACE_GLOBAL_BEGIN
 
// ============================================================
// ZFUIListView
#define ZFSerializableKeyword_ZFUIListView_cellAdapter "cellAdapter"
 
zfclassFwd _ZFP_ZFUIListViewPrivate;
zfclass ZFLIB_ZFUIWidget ZFUIListView : zfextend ZFUIScrollView {
    ZFOBJECT_DECLARE(ZFUIListView, ZFUIScrollView)
    ZFSTYLE_DEFAULT_DECLARE(ZFUIListView)
 
public:
    // ============================================================
    // events
    ZFEVENT(CellOnAttach)
    ZFEVENT(CellOnDetach)
    ZFEVENT(ListVisibleCellOnUpdate)
 
public:
    // ============================================================
    // properties
    ZFPROPERTY_ASSIGN(zfanyT<ZFUICellAdapter>, cellAdapter)
    ZFPROPERTY_ON_ATTACH_DECLARE(zfanyT<ZFUICellAdapter>, cellAdapter)
    ZFPROPERTY_ON_DETACH_DECLARE(zfanyT<ZFUICellAdapter>, cellAdapter)
    ZFMETHOD_DECLARE_1(void, cellAdapterAutoRetain
            , ZFMP_IN(ZFUICellAdapter *, cellAdapter)
            )

    ZFPROPERTY_ASSIGN(zfbool, cellAdapterSerializable)

    ZFPROPERTY_RETAIN_READONLY(zfanyT<ZFArray>, cellUpdater, zfobj<ZFArray>())

    ZFPROPERTY_ASSIGN(ZFUIOrientation, orientation, v_ZFUIOrientation::e_Top)
    ZFPROPERTY_ON_ATTACH_DECLARE(ZFUIOrientation, orientation)

    ZFPROPERTY_ASSIGN(zfbool, bounceable, zftrue)
    ZFPROPERTY_ON_ATTACH_DECLARE(zfbool, bounceable)
 
    // ============================================================
    // override
protected:
    zfoverride
    virtual void objectOnInit(void);
    zfoverride
    virtual void objectOnDealloc(void);
    zfoverride
    virtual void objectOnDeallocPrepare(void);
 
protected:
    zfoverride
    virtual ZFSerializablePropertyType serializableOnCheckPropertyType(ZF_IN const ZFProperty *property);
    zfoverride
    virtual zfbool serializableOnCheckNeedSerializeChildren(void) {
        return zffalse;
    }
    zfoverride
    virtual zfbool serializableOnSerializeFromData(
            ZF_IN const ZFSerializableData &serializableData
            , ZF_OUT_OPT zfstring *outErrorHint = zfnull
            , ZF_OUT_OPT ZFSerializableData *outErrorPos = zfnull
            );
    zfoverride
    virtual zfbool serializableOnSerializeToData(
            ZF_IN_OUT ZFSerializableData &serializableData
            , ZF_OUT_OPT zfstring *outErrorHint = zfnull
            , ZF_IN_OPT ZFSerializable *refOwner = zfnull
            );
 
protected:
    zfoverride
    virtual void layoutOnLayoutPrepare(ZF_IN const ZFUIRect &bounds);
    zfoverride
    virtual void layoutOnLayout(ZF_IN const ZFUIRect &bounds);
 
    zfoverride
    virtual void viewChildOnAdd(
            ZF_IN ZFUIView *child
            , ZF_IN ZFUIViewChildLayer layer
            );
    zfoverride
    virtual void viewChildOnRemove(
            ZF_IN ZFUIView *child
            , ZF_IN ZFUIViewChildLayer layer
            );
 
    zfoverride
    virtual void scrollAreaOnUpdate(void);
    zfoverride
    virtual void scrollContentFrameOnUpdate(void);
 
protected:
    zfoverride
    virtual void scrollOnScrolledByUser(void);
    zfoverride
    virtual void scrollOnScrollEnd(void);
 
    // ============================================================
    // list control
public:
    ZFMETHOD_DECLARE_0(void, reload)
    ZFMETHOD_DECLARE_0(zfbool, reloadRequested)
    ZFMETHOD_DECLARE_1(void, reloadCellAt
            , ZFMP_IN(zfindex, index)
            )
 
public:
    ZFMETHOD_DECLARE_0(ZFCoreArray<ZFUICell *>, visibleCells)
    ZFMETHOD_DECLARE_0(const ZFIndexRange &, visibleCellRange)
 
public:
    ZFMETHOD_DECLARE_3(void, scrollCellToHead
            , ZFMP_IN(zfindex, cellIndex)
            , ZFMP_IN_OPT(zffloat, offset, 0)
            , ZFMP_IN_OPT(zfbool, animated, zftrue)
            )
    ZFMETHOD_DECLARE_3(void, scrollCellToTail
            , ZFMP_IN(zfindex, cellIndex)
            , ZFMP_IN_OPT(zffloat, offset, 0)
            , ZFMP_IN_OPT(zfbool, animated, zftrue)
            )
 
    // ============================================================
    // events
protected:
    virtual inline void cellOnAttach(ZF_IN ZFUICell *cell) {
        this->observerNotify(ZFUIListView::E_CellOnAttach(), cell);
    }

    virtual inline void cellOnDetach(ZF_IN ZFUICell *cell) {
        this->observerNotify(ZFUIListView::E_CellOnDetach(), cell);
    }

    virtual void visibleCellsOnUpdate(void);
 
private:
    _ZFP_ZFUIListViewPrivate *d;
    friend zfclassFwd _ZFP_ZFUIListViewPrivate;
};
 
ZF_NAMESPACE_GLOBAL_END
#endif // #ifndef _ZFI_ZFUIListView_h_