1. Epic GamesDeveloper
  3. IWebBrowserWindow

IWebBrowserWindow

Interface for dealing with a Web Browser window

API > API/Runtime > API/Runtime/WebBrowser

Interface for dealing with a Web Browser window

   
Name IWebBrowserWindow
Type class
Header File /Engine/Source/Runtime/WebBrowser/Public/IWebBrowserWindow.h
Include Path #include "IWebBrowserWindow.h"

Syntax

class IWebBrowserWindow

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IWebBrowserWindow()

 Virtual Destructor. IWebBrowserWindow.h  

Classes

Name Remarks
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 Type Remarks Include Path
FOnBeforeBrowse TBaseDelegate_TwoParams< bool, const FString &, const FWebNavigationRequest & > A delegate that is invoked prior to browser navigation. IWebBrowserWindow.h
FOnBeforePopupDelegate TBaseDelegate_TwoParams< bool, FString, FString > A delegate that is invoked when a popup window is attempting to open. IWebBrowserWindow.h
FOnBeforeResourceLoadDelegate TBaseDelegate_FourParams< void, FString, FString, FRequestHeaders &, const bool >   IWebBrowserWindow.h
FOnCheckVisibility TBaseDelegate_NoParams< bool > A delegate that is invoked to check the visibility of the native browser IWebBrowserWindow.h
FOnCloseWindow TBaseDelegate_OneParam< bool, const TWeakPtr< IWebBrowserWindow > & > A delegate that is invoked when closing created popup windows. IWebBrowserWindow.h
FOnConsoleMessageDelegate TBaseDelegate_FourParams< void, const FString &, const FString &, int32, EWebBrowserConsoleLogSeverity > A delegate that is invoked for each console message IWebBrowserWindow.h
FOnCreateWindow TBaseDelegate_TwoParams< bool, const TWeakPtr< IWebBrowserWindow > &, const TWeakPtr< IWebBrowserPopupFeatures > & > A delegate that is invoked when an existing browser requests creation of a new browser window. IWebBrowserWindow.h
FOnDismissAllDialogs TBaseDelegate_NoParams< void > A delegate that is invoked when the browser needs to dismiss and reset all dialogs. IWebBrowserWindow.h
FOnDragWindow TBaseDelegate_OneParam< bool, const FPointerEvent & > A delegate that is invoked when drag is detected in an area specified as a drag region on the web page. IWebBrowserWindow.h
FOnFloatingCloseButtonPressed TBaseDelegate_NoParams< void > A delegate that is invoked when close is requested from the floating close button. IWebBrowserWindow.h
FOnLoadUrl TBaseDelegate_ThreeParams< bool, const FString &, const FString &, FString & > A delegate that is invoked to allow user code to override the contents of a Url. IWebBrowserWindow.h
FOnResourceLoadCompleteDelegate TBaseDelegate_FourParams< void, FString, FString, FString, int64 > A delegate that is invoked on completion of browser resource loads. IWebBrowserWindow.h
FOnShowDialog TBaseDelegate_OneParam< EWebBrowserDialogEventResponse, const TWeakPtr< IWebBrowserDialog > & > A delegate that is invoked when the browser needs to show a dialog. IWebBrowserWindow.h
FOnSuppressContextMenu TBaseDelegate_NoParams< bool > Should return true if this dialog wants to suppress the context menu IWebBrowserWindow.h
FOnUnhandledKeyChar TBaseDelegate_OneParam< bool, 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. IWebBrowserWindow.h
FOnUnhandledKeyDown TBaseDelegate_OneParam< bool, 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. IWebBrowserWindow.h
FOnUnhandledKeyUp TBaseDelegate_OneParam< bool, 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. IWebBrowserWindow.h
FRequestHeaders TMap< FString, FString > A delegate that is invoked before the browser loads a resource. IWebBrowserWindow.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
OnCheckVisibilityDelegate FOnCheckVisibility Delegate for veritying the window's visibility IWebBrowserWindow.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void BindInputMethodSystem ( ITextInputMethodSystem* TextInputMethodSystem
)

   IWebBrowserWindow.h  

void BindUObject ( const FString& Name,
UObject* Object,
bool bIsPermanent
)

 Expose a UObject instance to the browser runtime. IWebBrowserWindow.h  

bool CanGoBack()

 Returns true if the browser can navigate backwards. IWebBrowserWindow.h  

bool CanGoForward()

 Returns true if the browser can navigate forwards. IWebBrowserWindow.h  

virtual void CheckTickActivity()

   IWebBrowserWindow.h  

virtual bool CheckVisibility()

   IWebBrowserWindow.h  

void CloseBrowser ( bool bForce,
bool bBlockTillClosed
)

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

void ExecuteJavascript ( const FString& Script
)

 Execute Javascript on the page. IWebBrowserWindow.h  

EWebBrowserDocumentState GetDocumentLoadingState()

 Gets the loading state of the current document. IWebBrowserWindow.h  

int GetLoadError()

 Get current load error. IWebBrowserWindow.h  

TSharedPtr< class SWindow > GetParentWindow()

 Get parent SWindow for this window IWebBrowserWindow.h  

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

 Gets the source of the main frame as raw HTML. IWebBrowserWindow.h  

bool GetSupportsMouseWheel()

 Returns whether mouse wheel events should be handled by the window IWebBrowserWindow.h  

FSlateShaderResource * GetTexture ( bool bIsPopup
)

 Gets interface to the texture representation of the browser IWebBrowserWindow.h  

FString GetTitle()

 Gets the current title of the Browser page IWebBrowserWindow.h  

FString GetUrl()

 Gets the currently loaded URL. IWebBrowserWindow.h  

FIntPoint GetViewportSize()

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

void GoBack()

 Navigate backwards. IWebBrowserWindow.h  

void GoForward()

 Navigate forwards. IWebBrowserWindow.h  

bool IsClosing()

 Checks whether the web browser is currently being shut down IWebBrowserWindow.h  

bool IsInitialized()

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

bool IsLoading()

 Returns true if the browser is currently loading. IWebBrowserWindow.h  

bool IsValid()

 Checks whether the web browser is valid and ready for use IWebBrowserWindow.h  

void LoadString ( FString Contents,
FString DummyURL
)

 Load a string as data to create a web page IWebBrowserWindow.h  

void LoadURL ( FString NewURL
)

 Load the specified URL IWebBrowserWindow.h  

FOnBeforeBrowse & OnBeforeBrowse()

   IWebBrowserWindow.h  

FOnBeforePopupDelegate & OnBeforePopup()

   IWebBrowserWindow.h  

FOnBeforeResourceLoadDelegate & OnBeforeResourceLoad()

   IWebBrowserWindow.h  

void OnCaptureLost()

 Called when Capture lost IWebBrowserWindow.h  

virtual FOnCheckVisibility & OnCheckVisibility()

   IWebBrowserWindow.h  

FOnCloseWindow & OnCloseWindow()

   IWebBrowserWindow.h  

FOnConsoleMessageDelegate & OnConsoleMessage()

   IWebBrowserWindow.h  

FOnCreateWindow & OnCreateWindow()

   IWebBrowserWindow.h  

FCursorReply OnCursorQuery ( const FGeometry& MyGeometry,
const FPointerEvent& CursorEvent
)

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

FOnDismissAllDialogs & OnDismissAllDialogs()

   IWebBrowserWindow.h  

IWebBrowserWindow::FOnDismissPopup TBaseMulticastDelegate_NoParams OnDismissPopup()

   IWebBrowserWindow.h  

FOnDocumentStateChanged & OnDocumentStateChanged()

   IWebBrowserWindow.h  

FOnDragWindow & OnDragWindow()

   IWebBrowserWindow.h  

FOnFloatingCloseButtonPressed & OnFloatingCloseButtonPressed()

   IWebBrowserWindow.h  

void OnFocus ( bool SetFocus,
bool bIsPopup
)

 Called when browser receives/loses focus IWebBrowserWindow.h  

bool OnKeyChar ( const FCharacterEvent& InCharacterEvent
)

 Notify the browser of a character event IWebBrowserWindow.h  

bool OnKeyDown ( const FKeyEvent& InKeyEvent
)

 Notify the browser that a key has been pressed IWebBrowserWindow.h  

bool OnKeyUp ( const FKeyEvent& InKeyEvent
)

 Notify the browser that a key has been released IWebBrowserWindow.h  

FOnLoadUrl & OnLoadUrl()

   IWebBrowserWindow.h  

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

 Notify the browser of a double click event IWebBrowserWindow.h  

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

 Notify the browser that a mouse button was pressed within it IWebBrowserWindow.h  

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

 Notify the browser that a mouse button was released within it IWebBrowserWindow.h  

void OnMouseLeave ( const FPointerEvent& MouseEvent
)

 Notify the browser that a mouse has left the window IWebBrowserWindow.h  

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

 Notify the browser that a mouse moved within it IWebBrowserWindow.h  

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

 Called when the mouse wheel is spun IWebBrowserWindow.h  

IWebBrowserWindow::FOnNeedsRedraw TBaseMulticastDelegate_NoParams OnNeedsRedraw()

   IWebBrowserWindow.h  

FOnResourceLoadCompleteDelegate & OnResourceLoadComplete()

   IWebBrowserWindow.h  

FOnShowDialog & OnShowDialog()

   IWebBrowserWindow.h  

IWebBrowserWindow::FOnShowPopup TBaseMulticastDelegate_OneParam OnShowPopup()

   IWebBrowserWindow.h  

FOnSuppressContextMenu & OnSuppressContextMenu()

   IWebBrowserWindow.h  

FOnTitleChanged & OnTitleChanged()

   IWebBrowserWindow.h  

FOnToolTip & OnToolTip()

   IWebBrowserWindow.h  

FReply OnTouchGesture ( const FGeometry& MyGeometry,
const FPointerEvent& GestureEvent,
bool bIsPopup
)

 Called when a touch gesture is performed. IWebBrowserWindow.h  

FOnUnhandledKeyChar & OnUnhandledKeyChar()

   IWebBrowserWindow.h  

FOnUnhandledKeyDown & OnUnhandledKeyDown()

   IWebBrowserWindow.h  

FOnUnhandledKeyUp & OnUnhandledKeyUp()

   IWebBrowserWindow.h  

FOnUrlChanged & OnUrlChanged()

   IWebBrowserWindow.h  

void Reload()

 Reload the current page. IWebBrowserWindow.h  

void SetIsDisabled ( bool bValue
)

 Disable or enable web view. IWebBrowserWindow.h  

virtual void SetParentDockTab ( TSharedPtr< class SDockTab > DockTab
)

   IWebBrowserWindow.h  

void SetParentWindow ( TSharedPtr< class SWindow > Window
)

 Set parent SWindow for this window IWebBrowserWindow.h  

void SetSupportsMouseWheel ( bool bValue
)

 Sets whether mouse wheel events should be handled by the window IWebBrowserWindow.h  

void SetViewportSize ( FIntPoint WindowSize,
FIntPoint WindowPos
)

 Set the desired size of the web browser viewport IWebBrowserWindow.h  

void ShowFloatingCloseButton ( bool bShow,
bool bDraggable
)

 Shows floating button in the browser if supported by platform IWebBrowserWindow.h  

void StopLoad()

 Stop loading the page. IWebBrowserWindow.h  

virtual void UnbindInputMethodSystem()

   IWebBrowserWindow.h  

void UnbindUObject ( const FString& Name,
UObject* Object,
bool bIsPermanent
)

 Remove an existing script binding registered by BindUObject. IWebBrowserWindow.h  

Protected

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page