IWebBrowserSingleton.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Rendering/SlateRenderer.h"
#include "IWebBrowserResourceLoader.h"
class FCEFWebBrowserWindow;
class IWebBrowserCookieManager;
class IWebBrowserWindow;
class IWebBrowserSchemeHandlerFactory;
class UMaterialInterface;
struct FWebBrowserWindowInfo;
 
class IWebBrowserWindowFactory
{
public:
 
    virtual TSharedPtr<IWebBrowserWindow> Create(
        TSharedPtr<FCEFWebBrowserWindow>& BrowserWindowParent,
        TSharedPtr<FWebBrowserWindowInfo>& BrowserWindowInfo) = 0;
 
    virtual TSharedPtr<IWebBrowserWindow> Create(
        void* OSWindowHandle,
        FString InitialURL,
        bool bUseTransparency,
        bool bThumbMouseButtonNavigation,
        bool InterceptLoadRequests = true,
        TOptional<FString> ContentsToLoad = TOptional<FString>(),
        bool ShowErrorMessage = true,
        FColor BackgroundColor = FColor(255, 255, 255, 255),
        bool bMobileJSReturnInDict = true) = 0;
};
 
struct FBrowserContextSettings
{
    FBrowserContextSettings(const FString& InId)
        : Id(InId)
        , AcceptLanguageList()
        , CookieStorageLocation()
        , bPersistSessionCookies(false)
        , bIgnoreCertificateErrors(false)
        , bEnableNetSecurityExpiration(true)
    { }
 
    FString Id;
    FString AcceptLanguageList;
    FString CookieStorageLocation;
    bool bPersistSessionCookies;
    bool bIgnoreCertificateErrors;
    bool bEnableNetSecurityExpiration;
    FOnBeforeContextResourceLoadDelegate OnBeforeContextResourceLoad;
};
 
 
struct FCreateBrowserWindowSettings
{
 
    FCreateBrowserWindowSettings()
        : OSWindowHandle(nullptr)
        , InitialURL()
        , bUseTransparency(false)
        , bInterceptLoadRequests(true)
        , bThumbMouseButtonNavigation(false)
        , ContentsToLoad()
        , bShowErrorMessage(true)
        , BackgroundColor(FColor(255, 255, 255, 255))
        , BrowserFrameRate(24)
        , Context()
        , AltRetryDomains()
        , bMobileJSReturnInDict(true)
    { }
 
    void* OSWindowHandle;
    FString InitialURL;
    bool bUseTransparency;
    bool bInterceptLoadRequests;
    bool bThumbMouseButtonNavigation;
    TOptional<FString> ContentsToLoad;
    bool bShowErrorMessage;
    FColor BackgroundColor;
    int BrowserFrameRate;
    TOptional<FBrowserContextSettings> Context;
    TArray<FString> AltRetryDomains;
    bool bMobileJSReturnInDict;
};
 
class IWebBrowserSingleton
{
public:
    virtual ~IWebBrowserSingleton() {};
 
    virtual bool IsShuttingDown() const = 0;
 
    virtual TSharedRef<IWebBrowserWindowFactory> GetWebBrowserWindowFactory() const = 0;
 
 
    virtual TSharedPtr<IWebBrowserWindow> CreateBrowserWindow(
        TSharedPtr<FCEFWebBrowserWindow>& BrowserWindowParent,
        TSharedPtr<FWebBrowserWindowInfo>& BrowserWindowInfo
        ) = 0;
 
    virtual TSharedPtr<IWebBrowserWindow> CreateBrowserWindow(const FCreateBrowserWindowSettings& Settings) = 0;
 
#if BUILD_EMBEDDED_APP
    virtual TSharedPtr<IWebBrowserWindow> CreateNativeBrowserProxy() = 0;
#endif
 
    virtual TSharedPtr<class IWebBrowserCookieManager> GetCookieManager() const = 0;
 
    virtual TSharedPtr<class IWebBrowserCookieManager> GetCookieManager(TOptional<FString> ContextId) const = 0;
 
    virtual bool RegisterContext(const FBrowserContextSettings& Settings) = 0;
 
    virtual bool UnregisterContext(const FString& ContextId) = 0;
 
    // @return the application cache dir where the cookies are stored
    virtual FString ApplicationCacheDir() const = 0;
    virtual bool RegisterSchemeHandlerFactory(FString Scheme, FString Domain, IWebBrowserSchemeHandlerFactory* WebBrowserSchemeHandlerFactory) = 0;
 
    virtual bool UnregisterSchemeHandlerFactory(IWebBrowserSchemeHandlerFactory* WebBrowserSchemeHandlerFactory) = 0;
 
    virtual void SetDevToolsShortcutEnabled(bool Value) = 0;
 
 
    virtual bool IsDevToolsShortcutEnabled() = 0;
 
 
    virtual void SetJSBindingToLoweringEnabled(bool bEnabled) = 0;
 
 
    virtual void ClearOldCacheFolders(const FString &CachePathRoot, const FString &CachePrefix) = 0;
 
 
    virtual void SetDefaultMaterial(UMaterialInterface* InDefaultMaterial) = 0;
    virtual void SetDefaultTranslucentMaterial(UMaterialInterface* InDefaultMaterial) = 0;
 
    virtual UMaterialInterface* GetDefaultMaterial() = 0;
    virtual UMaterialInterface* GetDefaultTranslucentMaterial() = 0;
};