1. Epic GamesDeveloper
  3. IWebBrowserWindow

IWebBrowserWindow

Interface for dealing with a Web Browser window

Unreal Engine C++ API Reference > Runtime > WebBrowser

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

  Type Name Description
Protected function Virtual   Virtual Destructor.

Functions

  Type Name Description
Public function Virtual void

BindInputMethodSystem ( ITextInputMethodSystem* TextInputMethodSystem
)

  
Public function void

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

 Expose a UObject instance to the browser runtime.
Public function Const bool Returns true if the browser can navigate backwards.
Public function Const bool Returns true if the browser can navigate forwards.
Public function Virtual void  
Public function Virtual bool  
Public function void

CloseBrowser ( bool bForce,
bool bBlockTillClosed
)

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

ExecuteJavascript ( const FString& Script
)

 Execute Javascript on the page.
Public function Const EWebBrowserDocumentState Gets the loading state of the current document.
Public function int Get current load error.
Public function Const TSharedPtr< class SWindow > Get parent SWindow for this window
Public function Const void

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

 Gets the source of the main frame as raw HTML.
Public function Const bool Returns whether mouse wheel events should be handled by the window
Public function FSlateShaderResource *

GetTexture ( bool bIsPopup
)

 Gets interface to the texture representation of the browser
Public function Const FString Gets the current title of the Browser page
Public function Const FString

GetUrl ()

 Gets the currently loaded URL.
Public function Const FIntPoint Gets the current size of the web browser viewport if available, FIntPoint::NoneValue otherwise
Public function void

GoBack ()

 Navigate backwards.
Public function void Navigate forwards.
Public function Const bool Checks whether the web browser is currently being shut down
Public function Const bool Checks whether the web browser has finished loaded the initial page.
Public function Const bool Returns true if the browser is currently loading.
Public function Const bool

IsValid ()

 Checks whether the web browser is valid and ready for use
Public function void

LoadString ( FString Contents,
FString DummyURL
)

 Load a string as data to create a web page
Public function void

LoadURL ( FString NewURL
)

 Load the specified URL
Public function FOnBeforeBrowse &  
Public function FOnBeforePopupDelegate &  
Public function FOnBeforeResourceLoadDelegate &  
Public function void Called when Capture lost
Public function Virtual FOnCheckVisibility &  
Public function FOnCloseWindow &  
Public function FOnConsoleMessageDelegate &  
Public function FOnCreateWindow &  
Public function FCursorReply

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

 The system asks each widget under the mouse to provide a cursor. This event is bubbled.
Public function FOnDismissAllDialogs &  
Public function IWebBrowserWindow::FOnDismissPopup TBaseMulticastDelegate_NoParams  
Public function FOnDocumentStateChanged &  
Public function FOnDragWindow &  
Public function void

OnFocus ( bool SetFocus,
bool bIsPopup
)

 Called when browser receives/loses focus
Public function bool

OnKeyChar ( const FCharacterEvent& InCharacterEvent
)

 Notify the browser of a character event
Public function bool

OnKeyDown ( const FKeyEvent& InKeyEvent
)

 Notify the browser that a key has been pressed
Public function bool

OnKeyUp ( const FKeyEvent& InKeyEvent
)

 Notify the browser that a key has been released
Public function FOnLoadUrl &  
Public function FReply

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

 Notify the browser of a double click event
Public function FReply

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

 Notify the browser that a mouse button was pressed within it
Public function FReply

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

 Notify the browser that a mouse button was released within it
Public function void

OnMouseLeave ( const FPointerEvent& MouseEvent
)

 Notify the browser that a mouse has left the window
Public function FReply

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

 Notify the browser that a mouse moved within it
Public function FReply

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

 Called when the mouse wheel is spun
Public function IWebBrowserWindow::FOnNeedsRedraw TBaseMulticastDelegate_NoParams  
Public function FOnResourceLoadCompleteDelegate &  
Public function FOnShowDialog &  
Public function IWebBrowserWindow::FOnShowPopup TBaseMulticastDelegate_OneParam  
Public function FOnSuppressContextMenu &  
Public function FOnTitleChanged &  
Public function FOnToolTip &  
Public function FReply

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

 Called when a touch gesture is performed.
Public function FOnUnhandledKeyChar &  
Public function FOnUnhandledKeyDown &  
Public function FOnUnhandledKeyUp &  
Public function FOnUrlChanged &  
Public function void

Reload ()

 Reload the current page.
Public function void

SetIsDisabled ( bool bValue
)

 Disable or enable web view.
Public function void

SetParentWindow ( TSharedPtr< class SWindow > Window
)

 Set parent SWindow for this window
Public function void

SetSupportsMouseWheel ( bool bValue
)

 Sets whether mouse wheel events should be handled by the window
Public function void

SetViewportSize ( FIntPoint WindowSize,
FIntPoint WindowPos
)

 Set the desired size of the web browser viewport
Public function void Stop loading the page.
Public function Virtual void  
Public function void

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

 Remove an existing script binding registered by BindUObject.

Classes

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page