Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > WebBrowser > IWebBrowserSingleton

Light Theme

Dark Theme

IWebBrowserSingleton

A singleton class that takes care of general web browser tasks

Windows

MacOS

Linux

References

Module	WebBrowser
Header	/Engine/Source/Runtime/WebBrowser/Public/IWebBrowserSingleton.h
Include	#include "IWebBrowserSingleton.h"

Syntax

class IWebBrowserSingleton

Remarks

A singleton class that takes care of general web browser tasks

Destructors

	Name	Description
	~IWebBrowserSingleton()	Virtual Destructor

Functions

	Name	Description
FString	ApplicationCacheDir()
TSharedPtr< ...	CreateBrowserWindow ( TSharedPtr< FCEFWebBrowserWindow > ..., TSharedPtr< FWebBrowserWindowInfo >... )	Create a new web browser window
TSharedPtr< ...	CreateBrowserWindow ( const FCreateBrowserWindowSettings ... )
TSharedPtr< ...	GetCookieManager()
TSharedPtr< ...	GetCookieManager ( TOptional< FString > ContextId )
UMaterialInt...	GetDefaultMaterial()	Get a reference to UWebBrowser's default material
UMaterialInt...	GetDefaultTranslucentMaterial()	Get a reference to UWebBrowser's transparent material
TSharedRef< ...	GetWebBrowserWindowFactory()
bool	IsDevToolsShortcutEnabled()	Returns whether the CTRL/CMD-SHIFT-I shortcut to show the Chromium Dev tools window is enabled.
bool	RegisterContext ( const FBrowserContextSettings& Set... )
bool	RegisterSchemeHandlerFactory ( FString Scheme, FString Domain, IWebBrowserSchemeHandlerFactory... )	Registers a custom scheme handler factory, for a given scheme and domain.
void	SetDefaultMaterial ( UMaterialInterface* InDefaultM... )	Set a reference to UWebBrowser's default material
void	SetDefaultTranslucentMaterial ( UMaterialInterface* InDefaultM... )	Set a reference to UWebBrowser's translucent material
void	SetDevToolsShortcutEnabled ( bool Value )	Enable or disable CTRL/CMD-SHIFT-I shortcut to show the Chromium Dev tools window.
void	SetJSBindingToLoweringEnabled ( bool bEnabled )	Enable or disable to-lowering of JavaScript object member bindings.
bool	UnregisterContext ( const FString& ContextId )
bool	UnregisterSchemeHandlerFactory ( IWebBrowserSchemeHandlerFactory... )	Unregister a custom scheme handler factory.

Deprecated Functions

		Name	Description
	TSharedPtr< ...	CreateBrowserWindow ( void* OSWindowHandle, FString InitialURL, bool bUseTransparency, bool bThumbMouseButtonNavigation, TOptional< FString > ContentsToLoad, bool ShowErrorMessage, FColor BackgroundColor, int BrowserFrameRate, const TArray< FString >& AltRetryD... )	Please use the new overload that takes a settings struct.
	void	DeleteBrowserCookies ( FString URL, FString CookieName, TFunction< void> Completed )	Please use the CookieManager instead via GetCookieManager().

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss