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 > IWebBrowserWindow

Light Theme

Dark Theme

IWebBrowserWindow

Interface for dealing with a Web Browser window

Windows

MacOS

Linux

References

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

Syntax

class IWebBrowserWindow

Remarks

Interface for dealing with a Web Browser window

Destructors

	Name	Description
	~IWebBrowserWindow()	Virtual Destructor.

Functions

	Name	Description
void	BindInputMethodSystem ( ITextInputMethodSystem* TextIn... )
void	BindUObject ( const FString& Name, UObject* Object, bool bIsPermanent )	Expose a UObject instance to the browser runtime.
bool	CanGoBack()	Returns true if the browser can navigate backwards.
bool	CanGoForward()	Returns true if the browser can navigate forwards.
void	CheckTickActivity()
bool	CheckVisibility()
void	CloseBrowser ( bool bForce )	Close this window so that it can no longer be used.
void	ExecuteJavascript ( const FString& Script )	Execute Javascript on the page.
EWebBrowserD...	GetDocumentLoadingState()	Gets the loading state of the current document.
int	GetLoadError()	Get current load error.
TSharedPtr< ...	GetParentWindow()	Get parent SWindow for this window
void	GetSource ( TFunction< void&)> C... )	Gets the source of the main frame as raw HTML.
bool	GetSupportsMouseWheel()	Returns whether mouse wheel events should be handled by the window
FSlateShader...	GetTexture ( bool bIsPopup )	Gets interface to the texture representation of the browser
FString	GetTitle()	Gets the current title of the Browser page
FString	GetUrl()	Gets the currently loaded URL.
FIntPoint	GetViewportSize()	Gets the current size of the web browser viewport if available, FIntPoint::NoneValue otherwise
void	GoBack()	Navigate backwards.
void	GoForward()	Navigate forwards.
bool	IsClosing()	Checks whether the web browser is currently being shut down
bool	IsInitialized()	Checks whether the web browser has finished loaded the initial page.
bool	IsLoading()	Returns true if the browser is currently loading.
bool	IsValid()	Checks whether the web browser is valid and ready for use
void	LoadString ( FString Contents, FString DummyURL )	Load a string as data to create a web page
void	LoadURL ( FString NewURL )	Load the specified URL
FOnBeforeBro...	OnBeforeBrowse()
FOnBeforePop...	OnBeforePopup()
FOnBeforeRes...	OnBeforeResourceLoad()
void	OnCaptureLost()	Called when Capture lost
FOnCheckVisi...	OnCheckVisibility()
FOnCloseWind...	OnCloseWindow()
FOnConsoleMe...	OnConsoleMessage()
FOnCreateWin...	OnCreateWindow()
FCursorReply	OnCursorQuery ( const FGeometry& MyGeometry, const FPointerEvent& CursorEvent )	The system asks each widget under the mouse to provide a cursor. This event is bubbled.
FOnDismissAl...	OnDismissAllDialogs()
IWebBrowserW...	OnDismissPopup()
FOnDocumentS...	OnDocumentStateChanged()
FOnDragWindo...	OnDragWindow()
void	OnFocus ( bool SetFocus, bool bIsPopup )	Called when browser receives/loses focus
bool	OnKeyChar ( const FCharacterEvent& InCharacter... )	Notify the browser of a character event
bool	OnKeyDown ( const FKeyEvent& InKeyEvent )	Notify the browser that a key has been pressed
bool	OnKeyUp ( const FKeyEvent& InKeyEvent )	Notify the browser that a key has been released
FOnLoadUrl &	OnLoadUrl()
FReply	OnMouseButtonDoubleClick ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent, bool bIsPopup )	Notify the browser of a double click event
FReply	OnMouseButtonDown ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent, bool bIsPopup )	Notify the browser that a mouse button was pressed within it
FReply	OnMouseButtonUp ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent, bool bIsPopup )	Notify the browser that a mouse button was released within it
void	OnMouseLeave ( const FPointerEvent& MouseEvent )	Notify the browser that a mouse has left the window
FReply	OnMouseMove ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent, bool bIsPopup )	Notify the browser that a mouse moved within it
FReply	OnMouseWheel ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent, bool bIsPopup )	Called when the mouse wheel is spun
IWebBrowserW...	OnNeedsRedraw()
FOnResourceL...	OnResourceLoadComplete()
FOnShowDialo...	OnShowDialog()
IWebBrowserW...	OnShowPopup()
FOnSuppressC...	OnSuppressContextMenu()
FOnTitleChan...	OnTitleChanged()
FOnToolTip &	OnToolTip()
FOnUnhandled...	OnUnhandledKeyChar()
FOnUnhandled...	OnUnhandledKeyDown()
FOnUnhandled...	OnUnhandledKeyUp()
FOnUrlChange...	OnUrlChanged()
void	Reload()	Reload the current page.
void	SetIsDisabled ( bool bValue )	Disable or enable web view.
void	SetParentWindow ( TSharedPtr< class SWindow > Window )	Set parent SWindow for this window
void	SetSupportsMouseWheel ( bool bValue )	Sets whether mouse wheel events should be handled by the window
void	SetViewportSize ( FIntPoint WindowSize, FIntPoint WindowPos )	Set the desired size of the web browser viewport
void	StopLoad()	Stop loading the page.
void	UnbindInputMethodSystem()
void	UnbindUObject ( const FString& Name, UObject* Object, bool bIsPermanent )	Remove an existing script binding registered by BindUObject.

Classes

	Name	Description
	FOnDismissPopup	A delegate that is invoked when the browser no longer wants to show the popup menu.
	FOnDocumentStateChanged	A delegate that is invoked when the loading state of a document changed.
	FOnNeedsRedraw	A delegate that is invoked when the off-screen window has been repainted and requires an update.
	FOnShowPopup	A delegate that is invoked when the browser needs to show a popup menu.
	FOnTitleChanged	A delegate to allow callbacks when a browser title changes.
	FOnToolTip	A delegate to allow callbacks when a frame url changes.
	FOnUrlChanged	A delegate to allow callbacks when a frame url changes.

Typedefs

Name	Description
FOnBeforeBrowse	A delegate that is invoked prior to browser navigation.
FOnBeforePopupDelegate	A delegate that is invoked when a popup window is attempting to open.
FOnBeforeResourceLoadDelegate
FOnCheckVisibility	A delegate that is invoked to check the visibility of the native browser
FOnCloseWindow	A delegate that is invoked when closing created popup windows.
FOnConsoleMessageDelegate	A delegate that is invoked for each console message
FOnCreateWindow	A delegate that is invoked when an existing browser requests creation of a new browser window.
FOnDismissAllDialogs	A delegate that is invoked when the browser needs to dismiss and reset all dialogs.
FOnDragWindow	A delegate that is invoked when drag is detected in an area specified as a drag region on the web page.
FOnLoadUrl	A delegate that is invoked to allow user code to override the contents of a Url.
FOnResourceLoadCompleteDelegate	A delegate that is invoked on completion of browser resource loads.
FOnShowDialog	A delegate that is invoked when the browser needs to show a dialog.
FOnSuppressContextMenu	Should return true if this dialog wants to suppress the context menu
FOnUnhandledKeyChar	A delegate that is invoked for each key char event not handled by the browser, return true if event is handled to prevent it from bubbling up.
FOnUnhandledKeyDown	A delegate that is invoked for each key down event not handled by the browser, return true if event is handled to prevent it from bubbling up.
FOnUnhandledKeyUp	A delegate that is invoked for each up down event not handled by the browser, return true if event is handled to prevent it from bubbling up.
FRequestHeaders	A delegate that is invoked before the browser loads a resource.

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

Take our survey

Dismiss