YiAbstractScreenViewController.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2017. All rights reserved.
#ifndef _YI_ABSTRACT_SCREEN_VIEW_CONTROLLER_H_
#define _YI_ABSTRACT_SCREEN_VIEW_CONTROLLER_H_

#include "utility/YiPersistentStore.h"
#include "screen/YiViewController.h"
#include "framework/YiApp.h"
#include "utility/YiBundle.h"
#include "view/YiViewProperty.h"


class CYIAbstractScreenViewController : public CYIViewController
{
public:
    
    enum NAVIGATION_HISTORY_RULE
    {
        ALL,    
        LAST,   
        NONE    
    };
    
    CYIAbstractScreenViewController();

    CYIAbstractScreenViewController(CYISceneManager *pSceneManager, CYIApp *pApplication);

    void SetTitle(const CYIString &title);

    CYIString GetTitle() const;

    virtual void Init() override;

    void PreloadValidate(CYIBundle bundle);

    void Preload(CYIBundle bundle, const CYIPersistentStore &StateData);

    void Load(const CYIPersistentStore &StateData);

    void StartLoadAnimations();

    void StartUnloadAnimations();

    void Unload(CYIPersistentStore &StateData);

    bool IsLoaded() const;
    
    bool IsInitialized() const;

    void SetBackNavigationEnabled(bool bEnabled);
    
    bool IsBackNavigationEnabled() const;

    void SetInboundActivityIndicatorEnabled(bool bEnabled);

    bool IsInboundActivityIndicatorEnabled() const;

    void SetOrientation(YIViewProperty::Orientation orientation);

    YIViewProperty::Orientation GetOrientation() const;

    void SetNavigationHistoryRule(NAVIGATION_HISTORY_RULE eRule);

    NAVIGATION_HISTORY_RULE GetNavigationHistoryRule() const;

    void SetClearNavigationHistory(bool bClear);

    bool ShouldClearNavigationHistory() const;

    void SetStatusBarVisibility(YIViewProperty::StatusBar eVisibility);

    YIViewProperty::StatusBar GetStatusBarVisibility() const;

    void SetNavigationBarVisibility(YIViewProperty::NavigationBar eVisibility);

    YIViewProperty::NavigationBar GetNavigationBarVisibility() const;

    CYISignal<CYIAbstractScreenViewController *> LoadingAnimationCompleted;

    CYISignal<CYIAbstractScreenViewController *> UnloadingAnimationCompleted;

    CYISignal<CYIAbstractScreenViewController *> UnloadCompleted;

    CYISignal<CYIAbstractScreenViewController *> PreloadFinished;

    CYISignal<CYIAbstractScreenViewController *> PreloadValidateSucceeded;

    CYISignal<CYIAbstractScreenViewController *, CYIBundle> PreloadValidateFailed;

protected:
    void SetScreenLoaded(bool bIsLoaded);

    void SetInitialized(bool bIsInitialized);

    virtual void OnInitScreen() {}
    
    virtual void OnPreloadValidateScreen(CYIBundle bundle)
    {
        YI_UNUSED(bundle);
        PreloadValidateSucceeded.Emit(this);
    }
    
    virtual void OnPreloadScreen(CYIBundle bundle, const CYIPersistentStore &StateData)
    {
        YI_UNUSED(bundle);
        YI_UNUSED(StateData);
        PreloadFinished.Emit(this);
    }
    
    virtual void OnLoadScreen(const CYIPersistentStore &StateData) { YI_UNUSED(StateData); }
    
    virtual void OnUnloadScreen(CYIPersistentStore &StateData) { YI_UNUSED(StateData); }
    
    virtual void OnStageScreen() = 0;
    
    virtual void OnUnstageScreen() = 0;
    
private:
    virtual void OnBeginAnimationComplete() override;
    virtual void OnEndAnimationComplete() override;

    CYIString m_Title;
    bool m_bIsBackNavigationEnabled;
    bool m_bIsInboundActivityIndicatorEnabled;
    bool m_bIsLoaded;
    YIViewProperty::Orientation m_eScreenOrientation;
    NAVIGATION_HISTORY_RULE m_eNavigationHistoryRule;
    bool m_bShouldClearNavigationHistory;
    YIViewProperty::StatusBar m_eStatusBarVisibility;
    YIViewProperty::NavigationBar m_eNavigationBarVisibility;
    bool m_bIsInitialized;
};

#endif // _YI_ABSTRACT_SCREEN_VIEW_CONTROLLER_H_