Files
UnrealEngineUWP/Engine/Source/Runtime/WebBrowser/Public/IWebBrowserSingleton.h
Keli Hlodversson 82074ffed1 [INTEGRATE] SWebBrowser refactor and cleanups:
* Untangle mutual dependencies between objects and constructor order (OPP-3858):
	* FWebBrowserWindow no longer keeps a reference to FWebBrowserHandler.
	* CefBrowserWindow is created before creating FWebBrowserWindow and passed to its constructor.
	* FWebBrowserViewport no longer has a reference back to the viewport widget.
* Cleaned how some platform specific paths were defined during module initialization.
* Sets current thread name (back) to GameThread after initializing CEF (UE-5165)
* Adopted changes from UT (with some modifications):
	* Enable on-disk caching and persisting cookies when requested by server.
	* Added product name and engine version to user agent request header.
* Ensure UStruct parameters passed by value to FWebJSFunctions are copied when constructing the argument list and not just their address.
*SWebBrowser scripting: Add support for passing TMap<FString, T> to FWebJSFunction objects.
	Note: since the struct serializer does not yet support maps, this only works for arguments passed directly to the function object and not UStruct members nor function return values. OPP-3861
* Add support for passing a reference to the JS promise object implicitly created when calling UFunctions to provide for a way to report runtime errors back to it instead of just passing the return value.
	* This also allows for implementing async functionality as the promise object can be saved and used after the UFunction has returned.

Merging CL#2633955, CL#2634077, CL#2634226, CL#2635540, CL#2636167, and CL#2636262 using UE4-To-UE4-LauncherDev

[CL 2636308 by Keli Hlodversson in Main branch]
2015-07-28 18:59:27 -04:00

54 lines
1.8 KiB
C++

// Copyright 1998-2015 Epic Games, Inc. All Rights Reserved.
#pragma once
// Forward Declarations
class FSlateRenderer;
class IWebBrowserWindow;
class FWebBrowserWindow;
struct FWebBrowserWindowInfo;
/**
* A singleton class that takes care of general web browser tasks
*/
class WEBBROWSER_API IWebBrowserSingleton
{
public:
/**
* Virtual Destructor
*/
virtual ~IWebBrowserSingleton() {};
/**
* Create a new web browser window
*
* @param BrowserWindowParent The parent browser window
* @param BrowserWindowInfo Info for setting up the new browser window
* @return New Web Browser Window Interface (may be null if not supported)
*/
virtual TSharedPtr<IWebBrowserWindow> CreateBrowserWindow(
TSharedPtr<FWebBrowserWindow>& BrowserWindowParent,
TSharedPtr<FWebBrowserWindowInfo>& BrowserWindowInfo
) = 0;
/**
* Create a new web browser window
*
* @param OSWindowHandle Handle of OS Window that the browser will be displayed in (can be null)
* @param InitialURL URL that the browser should initially navigate to
* @param bUseTransparency Whether to allow transparent rendering of pages
* @param ContentsToLoad Optional string to load as a web page
* @param ShowErrorMessage Whether to show an error message in case of loading errors.
* @param BackgroundColor Opaque background color used before a document is loaded and when no document color is specified.
* @return New Web Browser Window Interface (may be null if not supported)
*/
virtual TSharedPtr<IWebBrowserWindow> CreateBrowserWindow(
void* OSWindowHandle,
FString InitialURL,
bool bUseTransparency,
bool bThumbMouseButtonNavigation,
TOptional<FString> ContentsToLoad = TOptional<FString>(),
bool ShowErrorMessage = true,
FColor BackgroundColor = FColor(255, 255, 255, 255)) = 0;
};