YiWebViewBridge.h

Go to the documentation of this file.

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

#include "framework/YiPredef.h"
#include "signal/YiSignal.h"

namespace yi
{
    
namespace deprecated
{
    
class CYIWebViewBridge
{
public:
    CYIWebViewBridge() {}
    virtual ~CYIWebViewBridge() {}
    
    enum RESOURCE_TYPE 
    {
        WEB_VIEW_HTTP_URL, 
        WEB_VIEW_FILE_URL, 
        WEB_VIEW_HTML_DOC  
    };
    
    //Must be kept in sync with Java enum
    enum WEBVIEW_EVENT 
    {
        WEB_VIEW_LOAD_STARTED,  
        WEB_VIEW_LOAD_FINISHED, 
        WEB_VIEW_LOAD_ERROR,    
        WEB_VIEW_DISMISSED      
    };
    
    virtual bool StartWebView() = 0;

    virtual void StopWebView() = 0;

    virtual void ShowWebView() = 0;

    virtual void HideWebView() = 0;
    
    virtual void ClearCachedData() = 0;

    virtual void SetResource(const CYIString &rResource, RESOURCE_TYPE eResourceType) = 0;
    virtual const CYIString &GetResource() const = 0;
    virtual RESOURCE_TYPE GetResourceType() const = 0;
    
    virtual void SetTitle(const CYIString &rTitle) = 0;
    virtual const CYIString &GetTitle() const = 0;
    
    virtual const CYIString &GetLastRequestUrl() const = 0;

    virtual void SetDisplayWebView(bool bDisplayWebView) = 0;
    virtual bool ShouldDisplayWebView() const = 0;

    virtual void SetDisplayNavigationBar(bool bDisplayNavigationBar) = 0;
    virtual bool ShouldDisplayNavigationBar() const = 0;

    virtual void SetNavigationBarBackButtonText(const CYIString &text) = 0;
    virtual const CYIString &GetNavigationBarBackButtonText() const = 0;

    virtual void Authenticate(const CYIString &rUserName, const CYIString &rPassword) = 0;
    virtual void CancelAuthentication() = 0;
    CYISignal<const CYIString & /*host*/, const CYIString & /*realm*/> AuthenticationRequired;

    CYISignal<const CYIString & /*resource*/> WebViewLoadStarted;
    
    CYISignal<const CYIString & /*resource*/> WebViewLoadFinished;
    
    CYISignal<const CYIString & /*resource*/> WebViewLoadError;
    
    CYISignal<> WebViewDismissed;
};

} // namespace deprecated
    
} // namespace yi

#endif // _YI_WEB_VIEW_BRIDGE_H_