UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Types | Public Member Functions | Protected Member Functions | List of all members
IWebBrowserWindow Class Referenceabstract

#include <IWebBrowserWindow.h>

+ Inheritance diagram for IWebBrowserWindow:

Public Types

typedef TMap< FString, FString > FRequestHeaders
 

Public Member Functions

virtual void LoadURL (FString NewURL)=0
 
virtual void LoadString (FString Contents, FString DummyURL)=0
 
virtual void SetViewportSize (FIntPoint WindowSize, FIntPoint WindowPos=FIntPoint::NoneValue)=0
 
virtual FIntPoint GetViewportSize () const =0
 
virtual FSlateShaderResource * GetTexture (bool bIsPopup=false)=0
 
virtual bool IsValid () const =0
 
virtual bool IsInitialized () const =0
 
virtual bool IsClosing () const =0
 
virtual EWebBrowserDocumentState GetDocumentLoadingState () const =0
 
virtual FString GetTitle () const =0
 
virtual FString GetUrl () const =0
 
virtual void GetSource (TFunction< void(const FString &)> Callback) const =0
 
virtual bool OnKeyDown (const FKeyEvent &InKeyEvent)=0
 
virtual bool OnKeyUp (const FKeyEvent &InKeyEvent)=0
 
virtual bool OnKeyChar (const FCharacterEvent &InCharacterEvent)=0
 
virtual FReply OnMouseButtonDown (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent, bool bIsPopup)=0
 
virtual FReply OnMouseButtonUp (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent, bool bIsPopup)=0
 
virtual FReply OnMouseButtonDoubleClick (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent, bool bIsPopup)=0
 
virtual FReply OnMouseMove (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent, bool bIsPopup)=0
 
virtual void OnMouseLeave (const FPointerEvent &MouseEvent)=0
 
virtual void SetSupportsMouseWheel (bool bValue)=0
 
virtual bool GetSupportsMouseWheel () const =0
 
virtual FReply OnMouseWheel (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent, bool bIsPopup)=0
 
virtual FReply OnTouchGesture (const FGeometry &MyGeometry, const FPointerEvent &GestureEvent, bool bIsPopup)=0
 
virtual FCursorReply OnCursorQuery (const FGeometry &MyGeometry, const FPointerEvent &CursorEvent)=0
 
virtual void OnFocus (bool SetFocus, bool bIsPopup)=0
 
virtual void OnCaptureLost ()=0
 
virtual bool CanGoBack () const =0
 
virtual void GoBack ()=0
 
virtual bool CanGoForward () const =0
 
virtual void GoForward ()=0
 
virtual bool IsLoading () const =0
 
virtual void Reload ()=0
 
virtual void StopLoad ()=0
 
virtual void ExecuteJavascript (const FString &Script)=0
 
virtual void CloseBrowser (bool bForce, bool bBlockTillClosed=false)=0
 
virtual void BindUObject (const FString &Name, UObject *Object, bool bIsPermanent=true)=0
 
virtual void UnbindUObject (const FString &Name, UObject *Object, bool bIsPermanent=true)=0
 
virtual void BindInputMethodSystem (ITextInputMethodSystem *TextInputMethodSystem)
 
virtual void UnbindInputMethodSystem ()
 
virtual int GetLoadError ()=0
 
virtual void SetIsDisabled (bool bValue)=0
 
virtual TSharedPtr< class SWindow > GetParentWindow () const =0
 
virtual void SetParentWindow (TSharedPtr< class SWindow > Window)=0
 
virtual void ShowFloatingCloseButton (bool bShow, bool bDraggable)=0
 
virtual void CheckTickActivity ()
 
virtual void SetParentDockTab (TSharedPtr< class SDockTab > DockTab)
 
 DECLARE_EVENT_OneParam (IWebBrowserWindow, FOnDocumentStateChanged, EWebBrowserDocumentState)
 
virtual FOnDocumentStateChanged & OnDocumentStateChanged ()=0
 
 DECLARE_EVENT_OneParam (IWebBrowserWindow, FOnTitleChanged, FString)
 
virtual FOnTitleChanged & OnTitleChanged ()=0
 
 DECLARE_EVENT_OneParam (IWebBrowserWindow, FOnUrlChanged, FString)
 
virtual FOnUrlChanged & OnUrlChanged ()=0
 
 DECLARE_EVENT_OneParam (IWebBrowserWindow, FOnToolTip, FString)
 
virtual FOnToolTip & OnToolTip ()=0
 
virtual FOnNeedsRedraw & OnNeedsRedraw ()=0
 
 DECLARE_DELEGATE_RetVal_TwoParams (bool, FOnBeforeBrowse, const FString &, const FWebNavigationRequest &) virtual FOnBeforeBrowse &OnBeforeBrowse()=0
 
 DECLARE_DELEGATE_RetVal_ThreeParams (bool, FOnLoadUrl, const FString &, const FString &, FString &) virtual FOnLoadUrl &OnLoadUrl()=0
 
 DECLARE_DELEGATE_RetVal_TwoParams (bool, FOnBeforePopupDelegate, FString, FString)
 
virtual FOnBeforePopupDelegate & OnBeforePopup ()=0
 
 DECLARE_DELEGATE_FourParams (FOnBeforeResourceLoadDelegate, FString, FString, FRequestHeaders &, const bool)
 
virtual FOnBeforeResourceLoadDelegate & OnBeforeResourceLoad ()=0
 
 DECLARE_DELEGATE_FourParams (FOnResourceLoadCompleteDelegate, FString, FString, FString, int64)
 
virtual FOnResourceLoadCompleteDelegate & OnResourceLoadComplete ()=0
 
 DECLARE_DELEGATE_FourParams (FOnConsoleMessageDelegate, const FString &, const FString &, int32, EWebBrowserConsoleLogSeverity)
 
virtual FOnConsoleMessageDelegate & OnConsoleMessage ()=0
 
 DECLARE_DELEGATE_RetVal_TwoParams (bool, FOnCreateWindow, const TWeakPtr< IWebBrowserWindow > &, const TWeakPtr< IWebBrowserPopupFeatures > &) virtual FOnCreateWindow &OnCreateWindow()=0
 
 DECLARE_DELEGATE_RetVal_OneParam (bool, FOnCloseWindow, const TWeakPtr< IWebBrowserWindow > &) virtual FOnCloseWindow &OnCloseWindow()=0
 
virtual FOnFloatingCloseButtonPressed & OnFloatingCloseButtonPressed ()=0
 
 DECLARE_EVENT_OneParam (IWebBrowserWindow, FOnShowPopup, const FIntRect &) virtual FOnShowPopup &OnShowPopup()=0
 
virtual FOnDismissPopup & OnDismissPopup ()=0
 
 DECLARE_DELEGATE_RetVal_OneParam (EWebBrowserDialogEventResponse, FOnShowDialog, const TWeakPtr< IWebBrowserDialog > &) virtual FOnShowDialog &OnShowDialog()=0
 
virtual FOnDismissAllDialogs & OnDismissAllDialogs ()=0
 
 DECLARE_DELEGATE_RetVal (bool, FOnSuppressContextMenu)
 
virtual FOnSuppressContextMenu & OnSuppressContextMenu ()=0
 
 DECLARE_DELEGATE_RetVal_OneParam (bool, FOnUnhandledKeyDown, const FKeyEvent &)
 
virtual FOnUnhandledKeyDown & OnUnhandledKeyDown ()=0
 
 DECLARE_DELEGATE_RetVal_OneParam (bool, FOnUnhandledKeyUp, const FKeyEvent &)
 
virtual FOnUnhandledKeyUp & OnUnhandledKeyUp ()=0
 
 DECLARE_DELEGATE_RetVal_OneParam (bool, FOnUnhandledKeyChar, const FCharacterEvent &)
 
virtual FOnUnhandledKeyChar & OnUnhandledKeyChar ()=0
 
 DECLARE_DELEGATE_RetVal_OneParam (bool, FOnDragWindow, const FPointerEvent &) virtual FOnDragWindow &OnDragWindow()=0
 
 DECLARE_DELEGATE_RetVal (bool, FOnCheckVisibility)
 
virtual FOnCheckVisibility & OnCheckVisibility ()
 
virtual bool CheckVisibility ()
 

Protected Member Functions

virtual ~IWebBrowserWindow ()
 

Detailed Description

Interface for dealing with a Web Browser window

Member Typedef Documentation

◆ FRequestHeaders

typedef TMap<FString, FString> IWebBrowserWindow::FRequestHeaders

A delegate that is invoked before the browser loads a resource. Its primary purpose is to inject headers into the request.

Constructor & Destructor Documentation

◆ ~IWebBrowserWindow()

virtual IWebBrowserWindow::~IWebBrowserWindow ( )
inlineprotectedvirtual

Virtual Destructor.

Member Function Documentation

◆ BindInputMethodSystem()

virtual void IWebBrowserWindow::BindInputMethodSystem ( ITextInputMethodSystem *  TextInputMethodSystem)
inlinevirtual

◆ BindUObject()

virtual void IWebBrowserWindow::BindUObject ( const FString &  Name,
UObject *  Object,
bool  bIsPermanent = true 
)
pure virtual

Expose a UObject instance to the browser runtime. Properties and Functions will be accessible from JavaScript side. As all communication with the rendering procesis asynchronous, return values (both for properties and function results) are wrapped into JS Future objects.

Parameters
NameThe name of the object. The object will show up as window.ue.{Name} on the javascript side. If there is an existing object of the same name, this object will replace it. If bIsPermanent is false and there is an existing permanent binding, the permanent binding will be restored when the temporary one is removed.
ObjectThe object instance.
bIsPermanentIf true, the object will be visible to all pages loaded through this browser widget, otherwise, it will be deleted when navigating away from the current page. Non-permanent bindings should be registered from inside an OnLoadStarted event handler in order to be available before JS code starts loading.

Implemented in FNativeWebBrowserProxy.

◆ CanGoBack()

virtual bool IWebBrowserWindow::CanGoBack ( ) const
pure virtual

Returns true if the browser can navigate backwards.

Implemented in FNativeWebBrowserProxy.

◆ CanGoForward()

virtual bool IWebBrowserWindow::CanGoForward ( ) const
pure virtual

Returns true if the browser can navigate forwards.

Implemented in FNativeWebBrowserProxy.

◆ CheckTickActivity()

virtual void IWebBrowserWindow::CheckTickActivity ( )
inlinevirtual

◆ CheckVisibility()

virtual bool IWebBrowserWindow::CheckVisibility ( )
inlinevirtual

◆ CloseBrowser()

virtual void IWebBrowserWindow::CloseBrowser ( bool  bForce,
bool  bBlockTillClosed = false 
)
pure virtual

Close this window so that it can no longer be used.

Parameters
bForceDesignates whether the web browser close should be forced.
bBlockTillClosedDon't return until this browser object is fully closed.

Implemented in FNativeWebBrowserProxy.

◆ DECLARE_DELEGATE_FourParams() [1/3]

IWebBrowserWindow::DECLARE_DELEGATE_FourParams ( FOnBeforeResourceLoadDelegate  ,
FString  ,
FString  ,
FRequestHeaders &  ,
const bool   
)

◆ DECLARE_DELEGATE_FourParams() [2/3]

IWebBrowserWindow::DECLARE_DELEGATE_FourParams ( FOnConsoleMessageDelegate  ,
const FString &  ,
const FString &  ,
int32  ,
EWebBrowserConsoleLogSeverity   
)

A delegate that is invoked for each console message

◆ DECLARE_DELEGATE_FourParams() [3/3]

IWebBrowserWindow::DECLARE_DELEGATE_FourParams ( FOnResourceLoadCompleteDelegate  ,
FString  ,
FString  ,
FString  ,
int64   
)

A delegate that is invoked on completion of browser resource loads. Its primary purpose is to allow response to failures.

◆ DECLARE_DELEGATE_RetVal() [1/2]

IWebBrowserWindow::DECLARE_DELEGATE_RetVal ( bool  ,
FOnCheckVisibility   
)

A delegate that is invoked to check the visibility of the native browser

◆ DECLARE_DELEGATE_RetVal() [2/2]

IWebBrowserWindow::DECLARE_DELEGATE_RetVal ( bool  ,
FOnSuppressContextMenu   
)

Should return true if this dialog wants to suppress the context menu

◆ DECLARE_DELEGATE_RetVal_OneParam() [1/6]

IWebBrowserWindow::DECLARE_DELEGATE_RetVal_OneParam ( bool  ,
FOnCloseWindow  ,
const TWeakPtr< IWebBrowserWindow > &   
) &
pure virtual

A delegate that is invoked when closing created popup windows.

◆ DECLARE_DELEGATE_RetVal_OneParam() [2/6]

IWebBrowserWindow::DECLARE_DELEGATE_RetVal_OneParam ( bool  ,
FOnDragWindow  ,
const FPointerEvent &   
) &
pure virtual

A delegate that is invoked when drag is detected in an area specified as a drag region on the web page.

◆ DECLARE_DELEGATE_RetVal_OneParam() [3/6]

IWebBrowserWindow::DECLARE_DELEGATE_RetVal_OneParam ( bool  ,
FOnUnhandledKeyChar  ,
const FCharacterEvent &   
)

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.

◆ DECLARE_DELEGATE_RetVal_OneParam() [4/6]

IWebBrowserWindow::DECLARE_DELEGATE_RetVal_OneParam ( bool  ,
FOnUnhandledKeyDown  ,
const FKeyEvent &   
)

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.

◆ DECLARE_DELEGATE_RetVal_OneParam() [5/6]

IWebBrowserWindow::DECLARE_DELEGATE_RetVal_OneParam ( bool  ,
FOnUnhandledKeyUp  ,
const FKeyEvent &   
)

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.

◆ DECLARE_DELEGATE_RetVal_OneParam() [6/6]

IWebBrowserWindow::DECLARE_DELEGATE_RetVal_OneParam ( EWebBrowserDialogEventResponse  ,
FOnShowDialog  ,
const TWeakPtr< IWebBrowserDialog > &   
) &
pure virtual

A delegate that is invoked when the browser needs to show a dialog.

◆ DECLARE_DELEGATE_RetVal_ThreeParams()

IWebBrowserWindow::DECLARE_DELEGATE_RetVal_ThreeParams ( bool  ,
FOnLoadUrl  ,
const FString &  ,
const FString &  ,
FString &   
) &
pure virtual

A delegate that is invoked to allow user code to override the contents of a Url.

◆ DECLARE_DELEGATE_RetVal_TwoParams() [1/3]

IWebBrowserWindow::DECLARE_DELEGATE_RetVal_TwoParams ( bool  ,
FOnBeforeBrowse  ,
const FString &  ,
const FWebNavigationRequest &   
) &
pure virtual

A delegate that is invoked prior to browser navigation.

◆ DECLARE_DELEGATE_RetVal_TwoParams() [2/3]

IWebBrowserWindow::DECLARE_DELEGATE_RetVal_TwoParams ( bool  ,
FOnBeforePopupDelegate  ,
FString  ,
FString   
)

A delegate that is invoked when a popup window is attempting to open.

◆ DECLARE_DELEGATE_RetVal_TwoParams() [3/3]

IWebBrowserWindow::DECLARE_DELEGATE_RetVal_TwoParams ( bool  ,
FOnCreateWindow  ,
const TWeakPtr< IWebBrowserWindow > &  ,
const TWeakPtr< IWebBrowserPopupFeatures > &   
) &
pure virtual

A delegate that is invoked when an existing browser requests creation of a new browser window.

◆ DECLARE_EVENT_OneParam() [1/5]

IWebBrowserWindow::DECLARE_EVENT_OneParam ( IWebBrowserWindow  ,
FOnDocumentStateChanged  ,
EWebBrowserDocumentState   
)

A delegate that is invoked when the loading state of a document changed.

◆ DECLARE_EVENT_OneParam() [2/5]

IWebBrowserWindow::DECLARE_EVENT_OneParam ( IWebBrowserWindow  ,
FOnShowPopup  ,
const FIntRect &   
) &
pure virtual

A delegate that is invoked when the browser needs to show a popup menu.

◆ DECLARE_EVENT_OneParam() [3/5]

IWebBrowserWindow::DECLARE_EVENT_OneParam ( IWebBrowserWindow  ,
FOnTitleChanged  ,
FString   
)

A delegate to allow callbacks when a browser title changes.

◆ DECLARE_EVENT_OneParam() [4/5]

IWebBrowserWindow::DECLARE_EVENT_OneParam ( IWebBrowserWindow  ,
FOnToolTip  ,
FString   
)

A delegate to allow callbacks when a frame url changes.

◆ DECLARE_EVENT_OneParam() [5/5]

IWebBrowserWindow::DECLARE_EVENT_OneParam ( IWebBrowserWindow  ,
FOnUrlChanged  ,
FString   
)

A delegate to allow callbacks when a frame url changes.

◆ ExecuteJavascript()

virtual void IWebBrowserWindow::ExecuteJavascript ( const FString &  Script)
pure virtual

Execute Javascript on the page.

Implemented in FNativeWebBrowserProxy.

◆ GetDocumentLoadingState()

virtual EWebBrowserDocumentState IWebBrowserWindow::GetDocumentLoadingState ( ) const
pure virtual

Gets the loading state of the current document.

Implemented in FNativeWebBrowserProxy.

◆ GetLoadError()

virtual int IWebBrowserWindow::GetLoadError ( )
pure virtual

Get current load error.

Returns
an error code if the last page load resulted in an error, otherwise 0.

Implemented in FNativeWebBrowserProxy.

◆ GetParentWindow()

virtual TSharedPtr< class SWindow > IWebBrowserWindow::GetParentWindow ( ) const
pure virtual

Get parent SWindow for this window

Implemented in FNativeWebBrowserProxy.

◆ GetSource()

virtual void IWebBrowserWindow::GetSource ( TFunction< void(const FString &)>  Callback) const
pure virtual

Gets the source of the main frame as raw HTML.

This method has to be called asynchronously by passing a callback function, which will be called at a later point when the result is ready.

Parameters
CallbackA callable that takes a single string reference for handling the result.

Implemented in FNativeWebBrowserProxy.

◆ GetSupportsMouseWheel()

virtual bool IWebBrowserWindow::GetSupportsMouseWheel ( ) const
pure virtual

Returns whether mouse wheel events should be handled by the window

Implemented in FNativeWebBrowserProxy.

◆ GetTexture()

virtual FSlateShaderResource * IWebBrowserWindow::GetTexture ( bool  bIsPopup = false)
pure virtual

Gets interface to the texture representation of the browser

Parameters
bISpopupWhether to return the popup menu texture instead of the main browser window.
Returns
A slate shader resource that can be rendered

Implemented in FNativeWebBrowserProxy.

◆ GetTitle()

virtual FString IWebBrowserWindow::GetTitle ( ) const
pure virtual

Gets the current title of the Browser page

Implemented in FNativeWebBrowserProxy.

◆ GetUrl()

virtual FString IWebBrowserWindow::GetUrl ( ) const
pure virtual

Gets the currently loaded URL.

Returns
The URL, or empty string if no document is loaded.

Implemented in FNativeWebBrowserProxy.

◆ GetViewportSize()

virtual FIntPoint IWebBrowserWindow::GetViewportSize ( ) const
pure virtual

Gets the current size of the web browser viewport if available, FIntPoint::NoneValue otherwise

Parameters
WindowSizeDesired viewport size

Implemented in FNativeWebBrowserProxy.

◆ GoBack()

virtual void IWebBrowserWindow::GoBack ( )
pure virtual

Navigate backwards.

Implemented in FNativeWebBrowserProxy.

◆ GoForward()

virtual void IWebBrowserWindow::GoForward ( )
pure virtual

Navigate forwards.

Implemented in FNativeWebBrowserProxy.

◆ IsClosing()

virtual bool IWebBrowserWindow::IsClosing ( ) const
pure virtual

Checks whether the web browser is currently being shut down

Implemented in FNativeWebBrowserProxy.

◆ IsInitialized()

virtual bool IWebBrowserWindow::IsInitialized ( ) const
pure virtual

Checks whether the web browser has finished loaded the initial page.

Implemented in FNativeWebBrowserProxy.

◆ IsLoading()

virtual bool IWebBrowserWindow::IsLoading ( ) const
pure virtual

Returns true if the browser is currently loading.

Implemented in FNativeWebBrowserProxy.

◆ IsValid()

virtual bool IWebBrowserWindow::IsValid ( ) const
pure virtual

Checks whether the web browser is valid and ready for use

Implemented in FNativeWebBrowserProxy.

◆ LoadString()

virtual void IWebBrowserWindow::LoadString ( FString  Contents,
FString  DummyURL 
)
pure virtual

Load a string as data to create a web page

Parameters
ContentsString to load
DummyURLDummy URL for the page

Implemented in FNativeWebBrowserProxy.

◆ LoadURL()

virtual void IWebBrowserWindow::LoadURL ( FString  NewURL)
pure virtual

Load the specified URL

Parameters
NewURLNew URL to load

Implemented in FNativeWebBrowserProxy.

◆ OnBeforePopup()

virtual FOnBeforePopupDelegate & IWebBrowserWindow::OnBeforePopup ( )
pure virtual

Implemented in FNativeWebBrowserProxy.

◆ OnBeforeResourceLoad()

virtual FOnBeforeResourceLoadDelegate & IWebBrowserWindow::OnBeforeResourceLoad ( )
pure virtual

Implemented in FNativeWebBrowserProxy.

◆ OnCaptureLost()

virtual void IWebBrowserWindow::OnCaptureLost ( )
pure virtual

Called when Capture lost

Implemented in FNativeWebBrowserProxy.

◆ OnCheckVisibility()

virtual FOnCheckVisibility & IWebBrowserWindow::OnCheckVisibility ( )
inlinevirtual

◆ OnConsoleMessage()

virtual FOnConsoleMessageDelegate & IWebBrowserWindow::OnConsoleMessage ( )
pure virtual

Implemented in FNativeWebBrowserProxy.

◆ OnCursorQuery()

virtual FCursorReply IWebBrowserWindow::OnCursorQuery ( const FGeometry &  MyGeometry,
const FPointerEvent &  CursorEvent 
)
pure virtual

The system asks each widget under the mouse to provide a cursor. This event is bubbled.

Returns
FCursorReply::Unhandled() if the event is not handled; return FCursorReply::Cursor() otherwise.

Implemented in FNativeWebBrowserProxy.

◆ OnDismissAllDialogs()

virtual FOnDismissAllDialogs & IWebBrowserWindow::OnDismissAllDialogs ( )
pure virtual

A delegate that is invoked when the browser needs to dismiss and reset all dialogs.

Implemented in FNativeWebBrowserProxy.

◆ OnDismissPopup()

virtual FOnDismissPopup & IWebBrowserWindow::OnDismissPopup ( )
pure virtual

A delegate that is invoked when the browser no longer wants to show the popup menu.

Implemented in FNativeWebBrowserProxy.

◆ OnDocumentStateChanged()

virtual FOnDocumentStateChanged & IWebBrowserWindow::OnDocumentStateChanged ( )
pure virtual

Implemented in FNativeWebBrowserProxy.

◆ OnFloatingCloseButtonPressed()

virtual FOnFloatingCloseButtonPressed & IWebBrowserWindow::OnFloatingCloseButtonPressed ( )
pure virtual

A delegate that is invoked when close is requested from the floating close button.

◆ OnFocus()

virtual void IWebBrowserWindow::OnFocus ( bool  SetFocus,
bool  bIsPopup 
)
pure virtual

Called when browser receives/loses focus

Parameters
SetFocusWhether the window gained or lost focus.
bIsPopupTrue if the coordinates are relative to a popup menu window, otherwise false.

Implemented in FNativeWebBrowserProxy.

◆ OnKeyChar()

virtual bool IWebBrowserWindow::OnKeyChar ( const FCharacterEvent &  InCharacterEvent)
pure virtual

Notify the browser of a character event

Parameters
InCharacterEventCharacter event

Implemented in FNativeWebBrowserProxy.

◆ OnKeyDown()

virtual bool IWebBrowserWindow::OnKeyDown ( const FKeyEvent &  InKeyEvent)
pure virtual

Notify the browser that a key has been pressed

Parameters
InKeyEventKey event

Implemented in FNativeWebBrowserProxy.

◆ OnKeyUp()

virtual bool IWebBrowserWindow::OnKeyUp ( const FKeyEvent &  InKeyEvent)
pure virtual

Notify the browser that a key has been released

Parameters
InKeyEventKey event

Implemented in FNativeWebBrowserProxy.

◆ OnMouseButtonDoubleClick()

virtual FReply IWebBrowserWindow::OnMouseButtonDoubleClick ( const FGeometry &  MyGeometry,
const FPointerEvent &  MouseEvent,
bool  bIsPopup 
)
pure virtual

Notify the browser of a double click event

Parameters
MyGeometryThe Geometry of the browser
MouseEventInformation about the input event
bIsPopupTrue if the coordinates are relative to a popup menu window, otherwise false.
Returns
FReply::Handled() if the mouse event was handled, FReply::Unhandled() oterwise

Implemented in FNativeWebBrowserProxy.

◆ OnMouseButtonDown()

virtual FReply IWebBrowserWindow::OnMouseButtonDown ( const FGeometry &  MyGeometry,
const FPointerEvent &  MouseEvent,
bool  bIsPopup 
)
pure virtual

Notify the browser that a mouse button was pressed within it

Parameters
MyGeometryThe Geometry of the browser
MouseEventInformation about the input event
bIsPopupTrue if the coordinates are relative to a popup menu window, otherwise false.
Returns
FReply::Handled() if the mouse event was handled, FReply::Unhandled() oterwise

Implemented in FNativeWebBrowserProxy.

◆ OnMouseButtonUp()

virtual FReply IWebBrowserWindow::OnMouseButtonUp ( const FGeometry &  MyGeometry,
const FPointerEvent &  MouseEvent,
bool  bIsPopup 
)
pure virtual

Notify the browser that a mouse button was released within it

Parameters
MyGeometryThe Geometry of the browser
MouseEventInformation about the input event
bIsPopupTrue if the coordinates are relative to a popup menu window, otherwise false.
Returns
FReply::Handled() if the mouse event was handled, FReply::Unhandled() oterwise

Implemented in FNativeWebBrowserProxy.

◆ OnMouseLeave()

virtual void IWebBrowserWindow::OnMouseLeave ( const FPointerEvent &  MouseEvent)
pure virtual

Notify the browser that a mouse has left the window

Parameters
MouseEventInformation about the input event

Implemented in FNativeWebBrowserProxy.

◆ OnMouseMove()

virtual FReply IWebBrowserWindow::OnMouseMove ( const FGeometry &  MyGeometry,
const FPointerEvent &  MouseEvent,
bool  bIsPopup 
)
pure virtual

Notify the browser that a mouse moved within it

Parameters
MyGeometryThe Geometry of the browser
MouseEventInformation about the input event
bIsPopupTrue if the coordinates are relative to a popup menu window, otherwise false.
Returns
FReply::Handled() if the mouse event was handled, FReply::Unhandled() oterwise

Implemented in FNativeWebBrowserProxy.

◆ OnMouseWheel()

virtual FReply IWebBrowserWindow::OnMouseWheel ( const FGeometry &  MyGeometry,
const FPointerEvent &  MouseEvent,
bool  bIsPopup 
)
pure virtual

Called when the mouse wheel is spun

Parameters
MyGeometryThe Geometry of the browser
MouseEventInformation about the input event
bIsPopupTrue if the coordinates are relative to a popup menu window, otherwise false.
Returns
FReply::Handled() if the mouse event was handled, FReply::Unhandled() oterwise

Implemented in FNativeWebBrowserProxy.

◆ OnNeedsRedraw()

virtual FOnNeedsRedraw & IWebBrowserWindow::OnNeedsRedraw ( )
pure virtual

A delegate that is invoked when the off-screen window has been repainted and requires an update.

Implemented in FNativeWebBrowserProxy.

◆ OnResourceLoadComplete()

virtual FOnResourceLoadCompleteDelegate & IWebBrowserWindow::OnResourceLoadComplete ( )
pure virtual

Implemented in FNativeWebBrowserProxy.

◆ OnSuppressContextMenu()

virtual FOnSuppressContextMenu & IWebBrowserWindow::OnSuppressContextMenu ( )
pure virtual

Implemented in FNativeWebBrowserProxy.

◆ OnTitleChanged()

virtual FOnTitleChanged & IWebBrowserWindow::OnTitleChanged ( )
pure virtual

Implemented in FNativeWebBrowserProxy.

◆ OnToolTip()

virtual FOnToolTip & IWebBrowserWindow::OnToolTip ( )
pure virtual

Implemented in FNativeWebBrowserProxy.

◆ OnTouchGesture()

virtual FReply IWebBrowserWindow::OnTouchGesture ( const FGeometry &  MyGeometry,
const FPointerEvent &  GestureEvent,
bool  bIsPopup 
)
pure virtual

Called when a touch gesture is performed.

Parameters
MyGeometryThe Geometry of the browser
GestureEventInformation about the input event
bIsPopupTrue if the coordinates are relative to a popup menu window, otherwise false.
Returns
FReply::Handled() if the mouse event was handled, FReply::Unhandled() oterwise

◆ OnUnhandledKeyChar()

virtual FOnUnhandledKeyChar & IWebBrowserWindow::OnUnhandledKeyChar ( )
pure virtual

Implemented in FNativeWebBrowserProxy.

◆ OnUnhandledKeyDown()

virtual FOnUnhandledKeyDown & IWebBrowserWindow::OnUnhandledKeyDown ( )
pure virtual

Implemented in FNativeWebBrowserProxy.

◆ OnUnhandledKeyUp()

virtual FOnUnhandledKeyUp & IWebBrowserWindow::OnUnhandledKeyUp ( )
pure virtual

Implemented in FNativeWebBrowserProxy.

◆ OnUrlChanged()

virtual FOnUrlChanged & IWebBrowserWindow::OnUrlChanged ( )
pure virtual

Implemented in FNativeWebBrowserProxy.

◆ Reload()

virtual void IWebBrowserWindow::Reload ( )
pure virtual

Reload the current page.

Implemented in FNativeWebBrowserProxy.

◆ SetIsDisabled()

virtual void IWebBrowserWindow::SetIsDisabled ( bool  bValue)
pure virtual

Disable or enable web view.

Parameters
bValueSetting this to true will prevent any updates from the background web browser.

Implemented in FNativeWebBrowserProxy.

◆ SetParentDockTab()

virtual void IWebBrowserWindow::SetParentDockTab ( TSharedPtr< class SDockTab >  DockTab)
inlinevirtual

◆ SetParentWindow()

virtual void IWebBrowserWindow::SetParentWindow ( TSharedPtr< class SWindow >  Window)
pure virtual

Set parent SWindow for this window

Implemented in FNativeWebBrowserProxy.

◆ SetSupportsMouseWheel()

virtual void IWebBrowserWindow::SetSupportsMouseWheel ( bool  bValue)
pure virtual

Sets whether mouse wheel events should be handled by the window

Implemented in FNativeWebBrowserProxy.

◆ SetViewportSize()

virtual void IWebBrowserWindow::SetViewportSize ( FIntPoint  WindowSize,
FIntPoint  WindowPos = FIntPoint::NoneValue 
)
pure virtual

Set the desired size of the web browser viewport

Parameters
WindowSizeDesired viewport size

Implemented in FNativeWebBrowserProxy.

◆ ShowFloatingCloseButton()

virtual void IWebBrowserWindow::ShowFloatingCloseButton ( bool  bShow,
bool  bDraggable 
)
pure virtual

Shows floating button in the browser if supported by platform

Implemented in FNativeWebBrowserProxy.

◆ StopLoad()

virtual void IWebBrowserWindow::StopLoad ( )
pure virtual

Stop loading the page.

Implemented in FNativeWebBrowserProxy.

◆ UnbindInputMethodSystem()

virtual void IWebBrowserWindow::UnbindInputMethodSystem ( )
inlinevirtual

◆ UnbindUObject()

virtual void IWebBrowserWindow::UnbindUObject ( const FString &  Name,
UObject *  Object,
bool  bIsPermanent = true 
)
pure virtual

Remove an existing script binding registered by BindUObject.

Parameters
NameThe name of the object to remove.
ObjectThe object will only be removed if it is the same object as the one passed in.
bIsPermanentMust match the bIsPermanent argument passed to BindUObject.

Implemented in FNativeWebBrowserProxy.

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