FNativeWebBrowserProxy Class Reference

#include <NativeWebBrowserProxy.h>

Inheritance diagram for FNativeWebBrowserProxy:

Public Member Functions
virtual	~FNativeWebBrowserProxy ()
virtual void	LoadURL (FString NewURL) override
virtual void	LoadString (FString Contents, FString DummyURL) override
virtual void	SetViewportSize (FIntPoint WindowSize, FIntPoint WindowPos) override
virtual FIntPoint	GetViewportSize () const override
virtual class FSlateShaderResource *	GetTexture (bool bIsPopup=false) override
virtual bool	IsValid () const override
virtual bool	IsInitialized () const override
virtual bool	IsClosing () const override
virtual EWebBrowserDocumentState	GetDocumentLoadingState () const override
virtual FString	GetTitle () const override
virtual FString	GetUrl () const override
virtual void	GetSource (TFunction< void(const FString &)> Callback) const override
virtual bool	OnKeyDown (const FKeyEvent &InKeyEvent) override
virtual bool	OnKeyUp (const FKeyEvent &InKeyEvent) override
virtual bool	OnKeyChar (const FCharacterEvent &InCharacterEvent) override
virtual void	SetSupportsMouseWheel (bool bValue) override
virtual bool	GetSupportsMouseWheel () const override
virtual FReply	OnMouseButtonDown (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent, bool bIsPopup) override
virtual FReply	OnMouseButtonUp (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent, bool bIsPopup) override
virtual FReply	OnMouseButtonDoubleClick (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent, bool bIsPopup) override
virtual FReply	OnMouseMove (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent, bool bIsPopup) override
virtual void	OnMouseLeave (const FPointerEvent &MouseEvent) override
virtual FReply	OnMouseWheel (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent, bool bIsPopup) override
virtual FOnDragWindow &	OnDragWindow () override
virtual void	OnFocus (bool SetFocus, bool bIsPopup) override
virtual void	OnCaptureLost () override
virtual bool	CanGoBack () const override
virtual void	GoBack () override
virtual bool	CanGoForward () const override
virtual void	GoForward () override
virtual bool	IsLoading () const override
virtual void	Reload () override
virtual void	StopLoad () override
virtual void	ExecuteJavascript (const FString &Script) override
virtual void	CloseBrowser (bool bForce, bool bBlockTillClosed) override
virtual void	BindUObject (const FString &Name, UObject *Object, bool bIsPermanent=true) override
virtual void	UnbindUObject (const FString &Name, UObject *Object=nullptr, bool bIsPermanent=true) override
virtual int	GetLoadError () override
virtual void	SetIsDisabled (bool bValue) override
virtual TSharedPtr< SWindow >	GetParentWindow () const override
virtual void	SetParentWindow (TSharedPtr< SWindow > Window) override
virtual void	ShowFloatingCloseButton (bool bShow, bool bDraggable) override
	DECLARE_DERIVED_EVENT (FNativeWebBrowserProxy, IWebBrowserWindow::FOnDocumentStateChanged, FOnDocumentStateChanged)
virtual FOnDocumentStateChanged &	OnDocumentStateChanged () override
	DECLARE_DERIVED_EVENT (FNativeWebBrowserProxy, IWebBrowserWindow::FOnTitleChanged, FOnTitleChanged)
virtual FOnTitleChanged &	OnTitleChanged () override
	DECLARE_DERIVED_EVENT (FNativeWebBrowserProxy, IWebBrowserWindow::FOnUrlChanged, FOnUrlChanged)
virtual FOnUrlChanged &	OnUrlChanged () override
	DECLARE_DERIVED_EVENT (FNativeWebBrowserProxy, IWebBrowserWindow::FOnToolTip, FOnToolTip)
virtual FOnToolTip &	OnToolTip () override
	DECLARE_DERIVED_EVENT (FNativeWebBrowserProxy, IWebBrowserWindow::FOnNeedsRedraw, FOnNeedsRedraw)
virtual FOnNeedsRedraw &	OnNeedsRedraw () override
virtual FOnBeforeBrowse &	OnBeforeBrowse () override
virtual FOnLoadUrl &	OnLoadUrl () override
virtual FOnCreateWindow &	OnCreateWindow () override
virtual FOnCloseWindow &	OnCloseWindow () override
virtual FCursorReply	OnCursorQuery (const FGeometry &MyGeometry, const FPointerEvent &CursorEvent) override
virtual FOnBeforePopupDelegate &	OnBeforePopup () override
virtual FOnBeforeResourceLoadDelegate &	OnBeforeResourceLoad () override
virtual FOnResourceLoadCompleteDelegate &	OnResourceLoadComplete () override
virtual FOnConsoleMessageDelegate &	OnConsoleMessage () override
	DECLARE_DERIVED_EVENT (FNativeWebBrowserProxy, IWebBrowserWindow::FOnShowPopup, FOnShowPopup)
virtual FOnShowPopup &	OnShowPopup () override
	DECLARE_DERIVED_EVENT (FNativeWebBrowserProxy, IWebBrowserWindow::FOnDismissPopup, FOnDismissPopup)
virtual FOnDismissPopup &	OnDismissPopup () override
virtual FOnShowDialog &	OnShowDialog () override
virtual FOnDismissAllDialogs &	OnDismissAllDialogs () override
virtual FOnSuppressContextMenu &	OnSuppressContextMenu () override
virtual FOnUnhandledKeyDown &	OnUnhandledKeyDown () override
virtual FOnUnhandledKeyUp &	OnUnhandledKeyUp () override
virtual FOnUnhandledKeyChar &	OnUnhandledKeyChar () override
Public Member Functions inherited from IWebBrowserWindow
virtual FReply	OnTouchGesture (const FGeometry &MyGeometry, const FPointerEvent &GestureEvent, bool bIsPopup)=0
virtual void	BindInputMethodSystem (ITextInputMethodSystem *TextInputMethodSystem)
virtual void	UnbindInputMethodSystem ()
virtual void	CheckTickActivity ()
virtual void	SetParentDockTab (TSharedPtr< class SDockTab > DockTab)
	DECLARE_EVENT_OneParam (IWebBrowserWindow, FOnDocumentStateChanged, EWebBrowserDocumentState)
	DECLARE_EVENT_OneParam (IWebBrowserWindow, FOnTitleChanged, FString)
	DECLARE_EVENT_OneParam (IWebBrowserWindow, FOnUrlChanged, FString)
	DECLARE_EVENT_OneParam (IWebBrowserWindow, FOnToolTip, FString)
	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)
	DECLARE_DELEGATE_FourParams (FOnBeforeResourceLoadDelegate, FString, FString, FRequestHeaders &, const bool)
	DECLARE_DELEGATE_FourParams (FOnResourceLoadCompleteDelegate, FString, FString, FString, int64)
	DECLARE_DELEGATE_FourParams (FOnConsoleMessageDelegate, const FString &, const FString &, int32, EWebBrowserConsoleLogSeverity)
	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
	DECLARE_DELEGATE_RetVal_OneParam (EWebBrowserDialogEventResponse, FOnShowDialog, const TWeakPtr< IWebBrowserDialog > &) virtual FOnShowDialog &OnShowDialog()=0
	DECLARE_DELEGATE_RetVal (bool, FOnSuppressContextMenu)
	DECLARE_DELEGATE_RetVal_OneParam (bool, FOnUnhandledKeyDown, const FKeyEvent &)
	DECLARE_DELEGATE_RetVal_OneParam (bool, FOnUnhandledKeyUp, const FKeyEvent &)
	DECLARE_DELEGATE_RetVal_OneParam (bool, FOnUnhandledKeyChar, const FCharacterEvent &)
	DECLARE_DELEGATE_RetVal_OneParam (bool, FOnDragWindow, const FPointerEvent &) virtual FOnDragWindow &OnDragWindow()=0
	DECLARE_DELEGATE_RetVal (bool, FOnCheckVisibility)
virtual FOnCheckVisibility &	OnCheckVisibility ()
virtual bool	CheckVisibility ()
Public Member Functions inherited from TSharedFromThis< FNativeWebBrowserProxy >
TSharedRef< FNativeWebBrowserProxy, Mode >	AsShared ()
TSharedRef< FNativeWebBrowserProxy const, Mode >	AsShared () const
TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const
TWeakPtr< FNativeWebBrowserProxy, Mode >	AsWeak ()
TWeakPtr< FNativeWebBrowserProxy const, Mode >	AsWeak () const
TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const
void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Friends
class	FWebBrowserSingleton

Additional Inherited Members
Public Types inherited from IWebBrowserWindow
typedef TMap< FString, FString >	FRequestHeaders
Protected Member Functions inherited from IWebBrowserWindow
virtual	~IWebBrowserWindow ()
Protected Member Functions inherited from TSharedFromThis< FNativeWebBrowserProxy >
	TSharedFromThis ()
	TSharedFromThis (TSharedFromThis const &)
UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)
	~TSharedFromThis ()
Static Protected Member Functions inherited from TSharedFromThis< FNativeWebBrowserProxy >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Constructor & Destructor Documentation

~FNativeWebBrowserProxy()

FNativeWebBrowserProxy::~FNativeWebBrowserProxy ( )

virtual

Member Function Documentation

BindUObject()

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

overridevirtual

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

Name	The 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.
Object	The object instance.
bIsPermanent	If 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.

Implements IWebBrowserWindow.

CanGoBack()

bool FNativeWebBrowserProxy::CanGoBack ( ) const

overridevirtual

Returns true if the browser can navigate backwards.

Implements IWebBrowserWindow.

CanGoForward()

bool FNativeWebBrowserProxy::CanGoForward ( ) const

overridevirtual

Returns true if the browser can navigate forwards.

Implements IWebBrowserWindow.

CloseBrowser()

void FNativeWebBrowserProxy::CloseBrowser ( bool  bForce, bool  bBlockTillClosed  )

overridevirtual

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

Parameters

bForce	Designates whether the web browser close should be forced.
bBlockTillClosed	Don't return until this browser object is fully closed.

Implements IWebBrowserWindow.

DECLARE_DERIVED_EVENT() [1/7]

FNativeWebBrowserProxy::DECLARE_DERIVED_EVENT	(	FNativeWebBrowserProxy	,
		IWebBrowserWindow::FOnDismissPopup	,
		FOnDismissPopup
	)

DECLARE_DERIVED_EVENT() [2/7]

FNativeWebBrowserProxy::DECLARE_DERIVED_EVENT	(	FNativeWebBrowserProxy	,
		IWebBrowserWindow::FOnDocumentStateChanged	,
		FOnDocumentStateChanged
	)

DECLARE_DERIVED_EVENT() [3/7]

FNativeWebBrowserProxy::DECLARE_DERIVED_EVENT	(	FNativeWebBrowserProxy	,
		IWebBrowserWindow::FOnNeedsRedraw	,
		FOnNeedsRedraw
	)

DECLARE_DERIVED_EVENT() [4/7]

FNativeWebBrowserProxy::DECLARE_DERIVED_EVENT	(	FNativeWebBrowserProxy	,
		IWebBrowserWindow::FOnShowPopup	,
		FOnShowPopup
	)

DECLARE_DERIVED_EVENT() [5/7]

FNativeWebBrowserProxy::DECLARE_DERIVED_EVENT	(	FNativeWebBrowserProxy	,
		IWebBrowserWindow::FOnTitleChanged	,
		FOnTitleChanged
	)

DECLARE_DERIVED_EVENT() [6/7]

FNativeWebBrowserProxy::DECLARE_DERIVED_EVENT	(	FNativeWebBrowserProxy	,
		IWebBrowserWindow::FOnToolTip	,
		FOnToolTip
	)

DECLARE_DERIVED_EVENT() [7/7]

FNativeWebBrowserProxy::DECLARE_DERIVED_EVENT	(	FNativeWebBrowserProxy	,
		IWebBrowserWindow::FOnUrlChanged	,
		FOnUrlChanged
	)

ExecuteJavascript()

void FNativeWebBrowserProxy::ExecuteJavascript ( const FString &  Script )

overridevirtual

Execute Javascript on the page.

Implements IWebBrowserWindow.

GetDocumentLoadingState()

EWebBrowserDocumentState FNativeWebBrowserProxy::GetDocumentLoadingState ( ) const

overridevirtual

Gets the loading state of the current document.

Implements IWebBrowserWindow.

GetLoadError()

int FNativeWebBrowserProxy::GetLoadError ( )

overridevirtual

Get current load error.

Returns

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

Implements IWebBrowserWindow.

GetParentWindow()

TSharedPtr< SWindow > FNativeWebBrowserProxy::GetParentWindow ( ) const

overridevirtual

Get parent SWindow for this window

Implements IWebBrowserWindow.

GetSource()

void FNativeWebBrowserProxy::GetSource ( TFunction< void(const FString &)>  Callback ) const

overridevirtual

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

Callback

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

Implements IWebBrowserWindow.

GetSupportsMouseWheel()

bool FNativeWebBrowserProxy::GetSupportsMouseWheel ( ) const

overridevirtual

Returns whether mouse wheel events should be handled by the window

Implements IWebBrowserWindow.

GetTexture()

FSlateShaderResource * FNativeWebBrowserProxy::GetTexture ( bool  bIsPopup = false )

overridevirtual

Gets interface to the texture representation of the browser

Parameters

bISpopup

Whether to return the popup menu texture instead of the main browser window.

Returns

A slate shader resource that can be rendered

Implements IWebBrowserWindow.

GetTitle()

FString FNativeWebBrowserProxy::GetTitle ( ) const

overridevirtual

Gets the current title of the Browser page

Implements IWebBrowserWindow.

GetUrl()

FString FNativeWebBrowserProxy::GetUrl ( ) const

overridevirtual

Gets the currently loaded URL.

Returns

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

Implements IWebBrowserWindow.

GetViewportSize()

FIntPoint FNativeWebBrowserProxy::GetViewportSize ( ) const

overridevirtual

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

Parameters

WindowSize

Desired viewport size

Implements IWebBrowserWindow.

GoBack()

void FNativeWebBrowserProxy::GoBack ( )

overridevirtual

Navigate backwards.

Implements IWebBrowserWindow.

GoForward()

void FNativeWebBrowserProxy::GoForward ( )

overridevirtual

Navigate forwards.

Implements IWebBrowserWindow.

IsClosing()

bool FNativeWebBrowserProxy::IsClosing ( ) const

overridevirtual

Checks whether the web browser is currently being shut down

Implements IWebBrowserWindow.

IsInitialized()

bool FNativeWebBrowserProxy::IsInitialized ( ) const

overridevirtual

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

Implements IWebBrowserWindow.

IsLoading()

bool FNativeWebBrowserProxy::IsLoading ( ) const

overridevirtual

Returns true if the browser is currently loading.

Implements IWebBrowserWindow.

IsValid()

bool FNativeWebBrowserProxy::IsValid ( ) const

overridevirtual

Checks whether the web browser is valid and ready for use

Implements IWebBrowserWindow.

LoadString()

void FNativeWebBrowserProxy::LoadString ( FString  Contents, FString  DummyURL  )

overridevirtual

Load a string as data to create a web page

Parameters

Contents	String to load
DummyURL	Dummy URL for the page

Implements IWebBrowserWindow.

LoadURL()

void FNativeWebBrowserProxy::LoadURL ( FString  NewURL )

overridevirtual

Load the specified URL

Parameters

NewURL

New URL to load

Implements IWebBrowserWindow.

OnBeforeBrowse()

virtual FOnBeforeBrowse & FNativeWebBrowserProxy::OnBeforeBrowse ( )

inlineoverridevirtual

OnBeforePopup()

virtual FOnBeforePopupDelegate & FNativeWebBrowserProxy::OnBeforePopup ( )

inlineoverridevirtual

Implements IWebBrowserWindow.

OnBeforeResourceLoad()

virtual FOnBeforeResourceLoadDelegate & FNativeWebBrowserProxy::OnBeforeResourceLoad ( )

inlineoverridevirtual

Implements IWebBrowserWindow.

OnCaptureLost()

void FNativeWebBrowserProxy::OnCaptureLost ( )

overridevirtual

Called when Capture lost

Implements IWebBrowserWindow.

OnCloseWindow()

virtual FOnCloseWindow & FNativeWebBrowserProxy::OnCloseWindow ( )

inlineoverridevirtual

OnConsoleMessage()

virtual FOnConsoleMessageDelegate & FNativeWebBrowserProxy::OnConsoleMessage ( )

inlineoverridevirtual

Implements IWebBrowserWindow.

OnCreateWindow()

virtual FOnCreateWindow & FNativeWebBrowserProxy::OnCreateWindow ( )

inlineoverridevirtual

OnCursorQuery()

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

inlineoverridevirtual

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.

Implements IWebBrowserWindow.

OnDismissAllDialogs()

virtual FOnDismissAllDialogs & FNativeWebBrowserProxy::OnDismissAllDialogs ( )

inlineoverridevirtual

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

Implements IWebBrowserWindow.

OnDismissPopup()

virtual FOnDismissPopup & FNativeWebBrowserProxy::OnDismissPopup ( )

inlineoverridevirtual

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

Implements IWebBrowserWindow.

OnDocumentStateChanged()

virtual FOnDocumentStateChanged & FNativeWebBrowserProxy::OnDocumentStateChanged ( )

inlineoverridevirtual

Implements IWebBrowserWindow.

OnDragWindow()

virtual FOnDragWindow & FNativeWebBrowserProxy::OnDragWindow ( )

inlineoverridevirtual

OnFocus()

void FNativeWebBrowserProxy::OnFocus ( bool  SetFocus, bool  bIsPopup  )

overridevirtual

Called when browser receives/loses focus

Parameters

SetFocus	Whether the window gained or lost focus.
bIsPopup	True if the coordinates are relative to a popup menu window, otherwise false.

Implements IWebBrowserWindow.

OnKeyChar()

bool FNativeWebBrowserProxy::OnKeyChar ( const FCharacterEvent &  InCharacterEvent )

overridevirtual

Notify the browser of a character event

Parameters

InCharacterEvent

Character event

Implements IWebBrowserWindow.

OnKeyDown()

bool FNativeWebBrowserProxy::OnKeyDown ( const FKeyEvent &  InKeyEvent )

overridevirtual

Notify the browser that a key has been pressed

Parameters

InKeyEvent

Key event

Implements IWebBrowserWindow.

OnKeyUp()

bool FNativeWebBrowserProxy::OnKeyUp ( const FKeyEvent &  InKeyEvent )

overridevirtual

Notify the browser that a key has been released

Parameters

InKeyEvent

Key event

Implements IWebBrowserWindow.

OnLoadUrl()

virtual FOnLoadUrl & FNativeWebBrowserProxy::OnLoadUrl ( )

inlineoverridevirtual

OnMouseButtonDoubleClick()

FReply FNativeWebBrowserProxy::OnMouseButtonDoubleClick ( const FGeometry &  MyGeometry, const FPointerEvent &  MouseEvent, bool  bIsPopup  )

overridevirtual

Notify the browser of a double click event

Parameters

MyGeometry	The Geometry of the browser
MouseEvent	Information about the input event
bIsPopup	True if the coordinates are relative to a popup menu window, otherwise false.

Returns

FReply::Handled() if the mouse event was handled, FReply::Unhandled() oterwise

Implements IWebBrowserWindow.

OnMouseButtonDown()

FReply FNativeWebBrowserProxy::OnMouseButtonDown ( const FGeometry &  MyGeometry, const FPointerEvent &  MouseEvent, bool  bIsPopup  )

overridevirtual

Notify the browser that a mouse button was pressed within it

Parameters

MyGeometry	The Geometry of the browser
MouseEvent	Information about the input event
bIsPopup	True if the coordinates are relative to a popup menu window, otherwise false.

Returns

FReply::Handled() if the mouse event was handled, FReply::Unhandled() oterwise

Implements IWebBrowserWindow.

OnMouseButtonUp()

FReply FNativeWebBrowserProxy::OnMouseButtonUp ( const FGeometry &  MyGeometry, const FPointerEvent &  MouseEvent, bool  bIsPopup  )

overridevirtual

Notify the browser that a mouse button was released within it

Parameters

MyGeometry	The Geometry of the browser
MouseEvent	Information about the input event
bIsPopup	True if the coordinates are relative to a popup menu window, otherwise false.

Returns

FReply::Handled() if the mouse event was handled, FReply::Unhandled() oterwise

Implements IWebBrowserWindow.

OnMouseLeave()

void FNativeWebBrowserProxy::OnMouseLeave ( const FPointerEvent &  MouseEvent )

overridevirtual

Notify the browser that a mouse has left the window

Parameters

MouseEvent

Information about the input event

Implements IWebBrowserWindow.

OnMouseMove()

FReply FNativeWebBrowserProxy::OnMouseMove ( const FGeometry &  MyGeometry, const FPointerEvent &  MouseEvent, bool  bIsPopup  )

overridevirtual

Notify the browser that a mouse moved within it

Parameters

MyGeometry	The Geometry of the browser
MouseEvent	Information about the input event
bIsPopup	True if the coordinates are relative to a popup menu window, otherwise false.

Returns

FReply::Handled() if the mouse event was handled, FReply::Unhandled() oterwise

Implements IWebBrowserWindow.

OnMouseWheel()

FReply FNativeWebBrowserProxy::OnMouseWheel ( const FGeometry &  MyGeometry, const FPointerEvent &  MouseEvent, bool  bIsPopup  )

overridevirtual

Called when the mouse wheel is spun

Parameters

MyGeometry	The Geometry of the browser
MouseEvent	Information about the input event
bIsPopup	True if the coordinates are relative to a popup menu window, otherwise false.

Returns

FReply::Handled() if the mouse event was handled, FReply::Unhandled() oterwise

Implements IWebBrowserWindow.

OnNeedsRedraw()

virtual FOnNeedsRedraw & FNativeWebBrowserProxy::OnNeedsRedraw ( )

inlineoverridevirtual

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

Implements IWebBrowserWindow.

OnResourceLoadComplete()

virtual FOnResourceLoadCompleteDelegate & FNativeWebBrowserProxy::OnResourceLoadComplete ( )

inlineoverridevirtual

Implements IWebBrowserWindow.

OnShowDialog()

virtual FOnShowDialog & FNativeWebBrowserProxy::OnShowDialog ( )

inlineoverridevirtual

OnShowPopup()

virtual FOnShowPopup & FNativeWebBrowserProxy::OnShowPopup ( )

inlineoverridevirtual

OnSuppressContextMenu()

virtual FOnSuppressContextMenu & FNativeWebBrowserProxy::OnSuppressContextMenu ( )

inlineoverridevirtual

Implements IWebBrowserWindow.

OnTitleChanged()

virtual FOnTitleChanged & FNativeWebBrowserProxy::OnTitleChanged ( )

inlineoverridevirtual

Implements IWebBrowserWindow.

OnToolTip()

virtual FOnToolTip & FNativeWebBrowserProxy::OnToolTip ( )

inlineoverridevirtual

Implements IWebBrowserWindow.

OnUnhandledKeyChar()

virtual FOnUnhandledKeyChar & FNativeWebBrowserProxy::OnUnhandledKeyChar ( )

inlineoverridevirtual

Implements IWebBrowserWindow.

OnUnhandledKeyDown()

virtual FOnUnhandledKeyDown & FNativeWebBrowserProxy::OnUnhandledKeyDown ( )

inlineoverridevirtual

Implements IWebBrowserWindow.

OnUnhandledKeyUp()

virtual FOnUnhandledKeyUp & FNativeWebBrowserProxy::OnUnhandledKeyUp ( )

inlineoverridevirtual

Implements IWebBrowserWindow.

OnUrlChanged()

virtual FOnUrlChanged & FNativeWebBrowserProxy::OnUrlChanged ( )

inlineoverridevirtual

Implements IWebBrowserWindow.

Reload()

void FNativeWebBrowserProxy::Reload ( )

overridevirtual

Reload the current page.

Implements IWebBrowserWindow.

SetIsDisabled()

void FNativeWebBrowserProxy::SetIsDisabled ( bool  bValue )

overridevirtual

Disable or enable web view.

Parameters

bValue

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

Implements IWebBrowserWindow.

SetParentWindow()

void FNativeWebBrowserProxy::SetParentWindow ( TSharedPtr< SWindow >  Window )

overridevirtual

Set parent SWindow for this window

Implements IWebBrowserWindow.

SetSupportsMouseWheel()

void FNativeWebBrowserProxy::SetSupportsMouseWheel ( bool  bValue )

overridevirtual

Sets whether mouse wheel events should be handled by the window

Implements IWebBrowserWindow.

SetViewportSize()

void FNativeWebBrowserProxy::SetViewportSize ( FIntPoint  WindowSize, FIntPoint  WindowPos  )

overridevirtual

Set the desired size of the web browser viewport

Parameters

WindowSize

Desired viewport size

Implements IWebBrowserWindow.

ShowFloatingCloseButton()

virtual void FNativeWebBrowserProxy::ShowFloatingCloseButton ( bool  bShow, bool  bDraggable  )

inlineoverridevirtual

Shows floating button in the browser if supported by platform

Implements IWebBrowserWindow.

StopLoad()

void FNativeWebBrowserProxy::StopLoad ( )

overridevirtual

Stop loading the page.

Implements IWebBrowserWindow.

UnbindUObject()

void FNativeWebBrowserProxy::UnbindUObject ( const FString &  Name, UObject *  Object = nullptr, bool  bIsPermanent = true  )

overridevirtual

Remove an existing script binding registered by BindUObject.

Parameters

Name	The name of the object to remove.
Object	The object will only be removed if it is the same object as the one passed in.
bIsPermanent	Must match the bIsPermanent argument passed to BindUObject.

Implements IWebBrowserWindow.

Friends And Related Symbol Documentation

FWebBrowserSingleton

friend class FWebBrowserSingleton

friend

---

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

• Engine/Source/Runtime/WebBrowser/Private/Native/NativeWebBrowserProxy.h
• Engine/Source/Runtime/WebBrowser/Private/Native/NativeWebBrowserProxy.cpp