#include <IWebBrowserSingleton.h>

Inheritance diagram for IWebBrowserSingleton:

Public Member Functions
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

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

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

Detailed Description

A singleton class that takes care of general web browser tasks

Constructor & Destructor Documentation

◆ ~IWebBrowserSingleton()

virtual IWebBrowserSingleton::~IWebBrowserSingleton ( )

inlinevirtual

Virtual Destructor

Member Function Documentation

◆ ApplicationCacheDir()

virtual FString IWebBrowserSingleton::ApplicationCacheDir ( ) const

pure virtual

Implemented in FWebBrowserSingleton.

◆ ClearOldCacheFolders()

virtual void IWebBrowserSingleton::ClearOldCacheFolders	(	const FString &	CachePathRoot,
		const FString &	CachePrefix
	)

pure virtual

Delete old/unused web cache paths. Some Web implementations (i.e CEF) use version specific cache folders, this call lets you schedule a deletion of any now unused folders. Calling this may resulting in async disk I/O.

Parameters

CachePathRoot	the base path used for saving the webcache folder
CachePrefix	the filename prefix we use for the cache folder (i.e "webcache")

Implemented in FWebBrowserSingleton.

◆ CreateBrowserWindow() [1/2]

virtual TSharedPtr< IWebBrowserWindow > IWebBrowserSingleton::CreateBrowserWindow ( const FCreateBrowserWindowSettings & Settings )

pure virtual

Create a new web browser window

Parameters

Settings Struct containing browser window settings

Returns: New Web Browser Window Interface (may be null if not supported)

Implemented in FWebBrowserSingleton.

◆ CreateBrowserWindow() [2/2]

virtual TSharedPtr< IWebBrowserWindow > IWebBrowserSingleton::CreateBrowserWindow	(	TSharedPtr< FCEFWebBrowserWindow > &	BrowserWindowParent,
		TSharedPtr< FWebBrowserWindowInfo > &	BrowserWindowInfo
	)

pure virtual

Create a new web browser window

Parameters

BrowserWindowParent	The parent browser window
BrowserWindowInfo	Info for setting up the new browser window

Returns: New Web Browser Window Interface (may be null if not supported)

Implemented in FWebBrowserSingleton.

◆ GetCookieManager() [1/2]

virtual TSharedPtr< class IWebBrowserCookieManager > IWebBrowserSingleton::GetCookieManager ( ) const

pure virtual

Implemented in FWebBrowserSingleton.

◆ GetCookieManager() [2/2]

virtual TSharedPtr< class IWebBrowserCookieManager > IWebBrowserSingleton::GetCookieManager ( TOptional< FString > ContextId ) const

pure virtual

Implemented in FWebBrowserSingleton.

◆ GetDefaultMaterial()

virtual UMaterialInterface * IWebBrowserSingleton::GetDefaultMaterial ( )

pure virtual

Get a reference to UWebBrowser's default material

Implemented in FWebBrowserSingleton.

◆ GetDefaultTranslucentMaterial()

virtual UMaterialInterface * IWebBrowserSingleton::GetDefaultTranslucentMaterial ( )

pure virtual

Get a reference to UWebBrowser's transparent material

Implemented in FWebBrowserSingleton.

◆ GetWebBrowserWindowFactory()

virtual TSharedRef< IWebBrowserWindowFactory > IWebBrowserSingleton::GetWebBrowserWindowFactory ( ) const

pure virtual

Returns: A factory object that can be used to construct additional WebBrowserWindows on demand.

Implemented in FWebBrowserSingleton.

◆ IsDevToolsShortcutEnabled()

virtual bool IWebBrowserSingleton::IsDevToolsShortcutEnabled ( )

pure virtual

Returns whether the CTRL/CMD-SHIFT-I shortcut to show the Chromium Dev tools window is enabled.

The relevant handlers for spawning new browser windows have to be set up correctly in addition to this flag being true before anything is shown.

Returns: a boolean value indicating whether the keyboard shortcut is enabled or not.

Implemented in FWebBrowserSingleton.

◆ IsShuttingDown()

virtual bool IWebBrowserSingleton::IsShuttingDown ( ) const

pure virtual

Indicates whether the browser engine is in the shutdown phase.

Implemented in FWebBrowserSingleton.

◆ RegisterContext()

virtual bool IWebBrowserSingleton::RegisterContext ( const FBrowserContextSettings & Settings )

pure virtual

Implemented in FWebBrowserSingleton.

◆ RegisterSchemeHandlerFactory()

virtual bool IWebBrowserSingleton::RegisterSchemeHandlerFactory	(	FString	Scheme,
		FString	Domain,
		IWebBrowserSchemeHandlerFactory *	WebBrowserSchemeHandlerFactory
	)

pure virtual

Registers a custom scheme handler factory, for a given scheme and domain. The domain is ignored if the scheme is not a browser built in scheme and all requests will go through this factory.

Parameters

Scheme	The scheme name to handle.
Domain	The domain name to handle.
WebBrowserSchemeHandlerFactory	The factory implementation for creating request handlers for this scheme.

Implemented in FWebBrowserSingleton.

◆ SetDefaultMaterial()

virtual void IWebBrowserSingleton::SetDefaultMaterial ( UMaterialInterface * InDefaultMaterial )

pure virtual

Set a reference to UWebBrowser's default material

Implemented in FWebBrowserSingleton.

◆ SetDefaultTranslucentMaterial()

virtual void IWebBrowserSingleton::SetDefaultTranslucentMaterial ( UMaterialInterface * InDefaultMaterial )

pure virtual

Set a reference to UWebBrowser's translucent material

Implemented in FWebBrowserSingleton.

◆ SetDevToolsShortcutEnabled()

virtual void IWebBrowserSingleton::SetDevToolsShortcutEnabled ( bool Value )

pure virtual

Enable or disable CTRL/CMD-SHIFT-I shortcut to show the Chromium Dev tools window. The value defaults to true on debug builds, otherwise false.

The relevant handlers for spawning new browser windows have to be set up correctly in addition to this flag being true before anything is shown.

Parameters

Value a boolean value to enable or disable the keyboard shortcut.

Implemented in FWebBrowserSingleton.

◆ SetJSBindingToLoweringEnabled()

virtual void IWebBrowserSingleton::SetJSBindingToLoweringEnabled ( bool bEnabled )

pure virtual

Enable or disable to-lowering of JavaScript object member bindings.

Due to how JavaScript to UObject bridges require the use of FNames for building up the JS API objects, it is possible for case-sensitivity issues to develop if an FName has been previously created with differing case to your function or property names. To-lowering the member names allows a guaranteed casing for the web page's JS to reference.

Default behavior is enabled, so that all JS side objects have only lowercase members.

Parameters

bEnabled a boolean value to enable or disable the to-lowering.

Implemented in FWebBrowserSingleton.

◆ UnregisterContext()

virtual bool IWebBrowserSingleton::UnregisterContext ( const FString & ContextId )

pure virtual

Implemented in FWebBrowserSingleton.

◆ UnregisterSchemeHandlerFactory()

virtual bool IWebBrowserSingleton::UnregisterSchemeHandlerFactory ( IWebBrowserSchemeHandlerFactory * WebBrowserSchemeHandlerFactory )

pure virtual

Unregister a custom scheme handler factory. The factory may still be used by existing open browser windows, but will no longer be provided for new ones.

Parameters

WebBrowserSchemeHandlerFactory The factory implementation to remove.

Implemented in FWebBrowserSingleton.

The documentation for this class was generated from the following file:

Engine/Source/Runtime/WebBrowser/Public/IWebBrowserSingleton.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IWebBrowserSingleton()

Member Function Documentation

◆ ApplicationCacheDir()

◆ ClearOldCacheFolders()

◆ CreateBrowserWindow() [1/2]

◆ CreateBrowserWindow() [2/2]

◆ GetCookieManager() [1/2]

◆ GetCookieManager() [2/2]

◆ GetDefaultMaterial()

◆ GetDefaultTranslucentMaterial()

◆ GetWebBrowserWindowFactory()

◆ IsDevToolsShortcutEnabled()

◆ IsShuttingDown()

◆ RegisterContext()

◆ RegisterSchemeHandlerFactory()

◆ SetDefaultMaterial()

◆ SetDefaultTranslucentMaterial()

◆ SetDevToolsShortcutEnabled()

◆ SetJSBindingToLoweringEnabled()

◆ UnregisterContext()

◆ UnregisterSchemeHandlerFactory()