YiWebViewController.h

Go to the documentation of this file.

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

#include "platform/YiPlatformViewProxy.h"
#include "signal/YiSignal.h"

class CYIUrl;

class CYIWebViewController : public CYISignalHandler
{
public:
    static std::unique_ptr<CYIWebViewController> CreateIfSupported();

    enum RESOURCE_TYPE
    {
        WEB_VIEW_HTTP_URL, 
        WEB_VIEW_FILE_URL, 
        WEB_VIEW_HTML_DOC  
    };

    struct Resource
    {
        CYIString string; 
        RESOURCE_TYPE eType; 
    };
    
    virtual ~CYIWebViewController();

    void LoadUrl(const CYIUrl &url);

    void LoadFile(const CYIString &pathToDocument);

    void LoadHTML(const CYIString &htmlString);

    virtual void NavigateBack() = 0;

    virtual void NavigateForward() = 0;

    virtual bool CanNavigateBack() = 0;

    virtual bool CanNavigateForward() = 0;

    virtual void ClearCache() = 0;

    const Resource &GetLastLoadedResource() const;
    
    virtual void Authenticate(const CYIString &username, const CYIString &password) = 0;

    virtual void CancelAuthentication() = 0;

    virtual void SetOverpullEnabled(bool bEnabled) = 0;

    CYIPlatformViewProxy *GetPlatformViewProxy() const;

    CYISignal<CYIString /*host*/, CYIString /*realm*/> AuthenticationRequired;
    
    CYISignal<Resource> LoadingCancelled;
    
    CYISignal<Resource> LoadingStarted;

    CYISignal<Resource> LoadingFinished;

    CYISignal<Resource, CYIString /*errorMessage*/> LoadingErrorOccurred;
    
    CYISignal<Resource> RedirectOccurred;
    
protected:
    CYIWebViewController();
    
    void NotifyLoadingStarted(const CYIString &webRequest);

    void NotifyLoadingFinished();

    void NotifyLoadingErrorOccurred(const CYIString &errorMessage);
    
    void NotifyAuthenticationRequired(const CYIString &realm, const CYIString &host);
    
    void NotifyLoadingCancelled();
    
    virtual void Load(const Resource &webViewResource) = 0;

private:
    YI_DISALLOW_COPY_AND_ASSIGN(CYIWebViewController);

    std::unique_ptr<CYIPlatformViewProxy> m_pPlatformViewProxy;
    Resource m_lastLoadedResource;
    Resource m_lastRequestedResource;
    bool m_bLoadNewResource;
};


#endif