ZFUIPage.h

Go to the documentation of this file.

 
#ifndef _ZFI_ZFUIPage_h_
#define _ZFI_ZFUIPage_h_
 
#include "ZFUIWidgetDef.h"
ZF_NAMESPACE_GLOBAL_BEGIN

ZFENUM_BEGIN(ZFLIB_ZFUIWidget, ZFUIPageResumeReason)
    ZFENUM_VALUE(ByManagerResume)
    ZFENUM_VALUE(ByRequest)
    ZFENUM_VALUE(FromBackground)
ZFENUM_SEPARATOR()
    ZFENUM_VALUE_REGISTER(ByManagerResume)
    ZFENUM_VALUE_REGISTER(ByRequest)
    ZFENUM_VALUE_REGISTER(FromBackground)
ZFENUM_END(ZFLIB_ZFUIWidget, ZFUIPageResumeReason)
ZFENUM_REG(ZFLIB_ZFUIWidget, ZFUIPageResumeReason)

ZFENUM_BEGIN(ZFLIB_ZFUIWidget, ZFUIPagePauseReason)
    ZFENUM_VALUE(ByManagerPause)
    ZFENUM_VALUE(ToBackground)
    ZFENUM_VALUE(BeforeDestroy)
ZFENUM_SEPARATOR()
    ZFENUM_VALUE_REGISTER(ByManagerPause)
    ZFENUM_VALUE_REGISTER(ToBackground)
    ZFENUM_VALUE_REGISTER(BeforeDestroy)
ZFENUM_END(ZFLIB_ZFUIWidget, ZFUIPagePauseReason)
ZFENUM_REG(ZFLIB_ZFUIWidget, ZFUIPagePauseReason)
 
// ============================================================
zfclassFwd ZFUIPageManager;
zfclass ZFLIB_ZFUIWidget ZFUIPage : zfextend ZFObject {
    ZFOBJECT_DECLARE_WITH_CUSTOM_CTOR(ZFUIPage, ZFObject)
 
    // ============================================================
    // observers
public:
    ZFEVENT(PageOnCreate)
    ZFEVENT(PageOnResume)
    ZFEVENT(PageOnPause)
    ZFEVENT(PageOnDestroy)

    ZFEVENT(PageOrientationOnUpdate)

    ZFEVENT(PageAniOnPrepare)

    ZFEVENT(PageAniOnStart)
    ZFEVENT(PageAniOnStop)
 
    // ============================================================
    // page manager
public:
    ZFMETHOD_DECLARE_0(zfanyT<ZFUIPageManager>, pageManager)

    ZFMETHOD_DECLARE_0(ZFUIView *, pageView)
    ZFPROPERTY_ASSIGN(const ZFClass *, pageViewClass)
 
    // ============================================================
    // page property
public:
    ZFPROPERTY_ASSIGN(zfstring, pageGroupId)
    ZFPROPERTY_RETAIN(zfany, pageResult)
 
    // ============================================================
    // page state
public:
    ZFMETHOD_DECLARE_0(zfbool, pageCreated)
    ZFMETHOD_DECLARE_0(zfbool, pageResumed)
 
public:
    ZFMETHOD_DECLARE_2(void, pageCreate
            , ZFMP_IN(ZFUIPage *, page)
            , ZFMP_IN_OPT(const ZFListener &, pageResultCallback, zfnull)
            )
    ZFMETHOD_DECLARE_1(void, pageReplace
            , ZFMP_IN(ZFUIPage *, page)
            )
    ZFMETHOD_DECLARE_0(void, pageResume)
    ZFMETHOD_DECLARE_0(void, pageDestroy)

    ZFMETHOD_DECLARE_0(zfbool, isLandscape)
 
    // ============================================================
    // page life cycle
protected:
    virtual void pageOnCreate(void);
    virtual void pageOnResume(ZF_IN ZFUIPageResumeReason reason);
    virtual void pageOnPause(ZF_IN ZFUIPagePauseReason reason);
    virtual void pageOnDestroy(void);

    virtual inline void pageOrientationOnUpdate(void) {}
 
    // ============================================================
    // page ani
public:
    ZFPROPERTY_ASSIGN(zfint, pageAniPriority)
 
    
    ZFMETHOD_DECLARE_1(void, pageAni
            , ZFMP_IN(ZFAnimation *, pageAni)
            )
    ZFMETHOD_DECLARE_0(ZFAnimation *, pageAni)
 
protected:
    virtual void pageAniOnPrepare(
            ZF_IN ZFEnum *resumeOrPauseReason
            , ZF_IN ZFUIPage *siblingPage
            ) {
    }
 
    // ============================================================
private:
    ZFUIPageManager *_ZFP_ZFUIPage_pageManager;
    ZFUIView *_ZFP_ZFUIPage_pageView;
    zfbool _ZFP_ZFUIPage_pageCreated;
    zfbool _ZFP_ZFUIPage_pageResumed;
    zfbyte _ZFP_ZFUIPage_pageOrientation; // -1: not initialized, 0: port, 1: land
    ZFAnimation *_ZFP_ZFUIPage_pageAni;
protected:
    ZFUIPage(void)
    : _ZFP_ZFUIPage_pageManager(zfnull)
    , _ZFP_ZFUIPage_pageView(zfnull)
    , _ZFP_ZFUIPage_pageCreated(zffalse)
    , _ZFP_ZFUIPage_pageResumed(zffalse)
    , _ZFP_ZFUIPage_pageOrientation((zfbyte)-1)
    , _ZFP_ZFUIPage_pageAni(zfnull)
    {
    }
    zfoverride
    virtual void objectOnDealloc(void) {
        zfobjRetainChange(this->_ZFP_ZFUIPage_pageView, zfnull);
        zfobjRetainChange(this->_ZFP_ZFUIPage_pageAni, zfnull);
        zfsuper::objectOnDealloc();
    }
private:
    friend zfclassFwd ZFUIPageManager;
    friend zfclassFwd _ZFP_ZFUIPageManagerPrivate;
};
 
// ============================================================
zfclassFwd _ZFP_ZFUIPageManagerPrivate;
zfclass ZFLIB_ZFUIWidget ZFUIPageManager : zfextend ZFObject {
    ZFOBJECT_DECLARE(ZFUIPageManager, ZFObject)
 
    // ============================================================
    // observers
public:
    ZFEVENT(ManagerOnCreate)
    ZFEVENT(ManagerOnResume)
    ZFEVENT(ManagerOnPause)
    ZFEVENT(ManagerOnDestroy)

    ZFEVENT(ManagerOrientationOnUpdate)

    ZFEVENT(ManagerUIBlockOnUpdate)
 
    // ============================================================
    // page observers
public:
    ZFEVENT(PageOnCreate)
    ZFEVENT(PageOnResume)
    ZFEVENT(PageOnPause)
    ZFEVENT(PageOnDestroy)
    ZFEVENT(PageOrientationOnUpdate)
    ZFEVENT(PageAniOnPrepare)
    ZFEVENT(PageAniOnStart)
    ZFEVENT(PageAniOnStop)
 
    // ============================================================
    // manager creation
public:
    ZFMETHOD_DECLARE_0(void, managerCreate)
    ZFMETHOD_DECLARE_0(void, managerResume)
    ZFMETHOD_DECLARE_0(void, managerPause)
    ZFMETHOD_DECLARE_0(void, managerDestroy)
 
protected:
    virtual void managerOnCreate(void);
    virtual void managerOnResume(void) {}
    virtual void managerOnPause(void) {}
    virtual void managerOnDestroy(void);

    virtual inline void managerOrientationOnUpdate(void) {}
 
public:
    ZFMETHOD_DECLARE_0(zfbool, managerCreated)
    ZFMETHOD_DECLARE_0(zfbool, managerResumed)

    ZFMETHOD_DECLARE_0(zfbool, isLandscape)
 
public:
    ZFMETHOD_DECLARE_1(void, managerCreateForWindow
            , ZFMP_IN_OPT(ZFUIRootWindow *, rootWindow, zfnull)
            )
    ZFMETHOD_DECLARE_0(ZFUIWindow *, managerWindow)
    ZFMETHOD_DECLARE_2(void, managerWindow
            , ZFMP_IN(ZFUIWindow *, window)
            , ZFMP_IN_OPT(zfbool, autoHidePrev, zftrue)
            )
 
    // ============================================================
    // container
public:
    ZFMETHOD_DECLARE_0(ZFUIView *, managerContainer)
    ZFMETHOD_DECLARE_0(ZFUIView *, pageContainer)

    ZFPROPERTY_ASSIGN(const ZFClass *, managerContainerClass)
    ZFPROPERTY_ASSIGN(const ZFClass *, pageContainerClass)
 
    // ============================================================
    // manager control
public:
    ZFMETHOD_DECLARE_1(void, managerUIBlock
            , ZFMP_IN(zfbool, value)
            )
    ZFMETHOD_DECLARE_0(zfbool, managerUIBlock)
    ZFMETHOD_DECLARE_0(zfindex, managerUIBlockCount)
protected:
    virtual inline void managerUIBlockOnUpdate(void) {
        if(this->pageContainer()) {
            this->pageContainer()->viewUIEnableTree(!this->managerUIBlock());
        }
    }
 
    // ============================================================
    // page access
public:
    ZFMETHOD_DECLARE_0(zfindex, pageCount)
    ZFMETHOD_DECLARE_0(ZFCoreArray<ZFUIPage *> &, pageList)
    ZFMETHOD_DECLARE_1(zfanyT<ZFUIPage>, pageAt
            , ZFMP_IN(zfindex, index)
            )
    ZFMETHOD_DECLARE_0(zfanyT<ZFUIPage>, currentPage)
    ZFMETHOD_DECLARE_1(zfindex, pageIndex
            , ZFMP_IN(ZFUIPage *, page)
            )

    ZFMETHOD_DECLARE_1(ZFCoreArray<ZFUIPage *>, pageListForGroupId
            , ZFMP_IN(const zfstring &, pageGroupId)
            )
 
    // ============================================================
    // page management
public:
    ZFMETHOD_DECLARE_3(void, pageAniOverride
            , ZFMP_IN(ZFAnimation *, resumeAni)
            , ZFMP_IN(ZFAnimation *, pauseAni)
            , ZFMP_IN_OPT(zfbool, pauseAniHigherPriority, zffalse)
            )

    ZFMETHOD_DECLARE_2(void, pageCreate
            , ZFMP_IN(ZFUIPage *, page)
            , ZFMP_IN_OPT(const ZFListener &, pageResultCallback, zfnull)
            )
    ZFMETHOD_DECLARE_1(void, pageReplace
            , ZFMP_IN(ZFUIPage *, page)
            )

    ZFMETHOD_DECLARE_1(void, pageResume
            , ZFMP_IN(ZFUIPage *, page)
            )
    ZFMETHOD_DECLARE_1(void, pageResume
            , ZFMP_IN(zfindex, pageIndex)
            )
    ZFMETHOD_DECLARE_1(void, pageResumeForGroupId
            , ZFMP_IN(const zfstring &, pageGroupId)
            )

    ZFMETHOD_DECLARE_1(void, pageDestroy
            , ZFMP_IN(ZFUIPage *, page)
            )

    ZFMETHOD_DECLARE_0(void, pageMoveBegin)
    ZFMETHOD_DECLARE_0(void, pageMoveEnd)

    ZFMETHOD_DECLARE_1(void, pageRequest
            , ZFMP_IN(const ZFListener &, callback)
            )
    ZFMETHOD_DECLARE_1(void, pageRequestCancel
            , ZFMP_IN(const ZFListener &, callback)
            )
    ZFMETHOD_DECLARE_0(zfindex, pageRequestCount)
 
protected:
    zfoverride
    virtual void objectOnInit(void);
    zfoverride
    virtual void objectOnDealloc(void);
private:
    _ZFP_ZFUIPageManagerPrivate *d;
    friend zfclassFwd _ZFP_ZFUIPageManagerPrivate;
};
 
ZF_NAMESPACE_GLOBAL_END
#endif // #ifndef _ZFI_ZFUIPage_h_