1. Epic GamesDeveloper
  3. SWebBrowserView

SWebBrowserView

API > API/Runtime > API/Runtime/WebBrowser

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

Syntax

class SWebBrowserView : public SCompoundWidget

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

SWebBrowserView()

 Default constructor. SWebBrowserView.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~SWebBrowserView()

   SWebBrowserView.h  

Structs

Name Remarks
FArguments  

Typedefs

Name Type Remarks Include Path
FOnBeforeBrowse TBaseDelegate_TwoParams< bool, const FString &, const FWebNavigationRequest & >   SWebBrowserView.h
FOnDragWindow TBaseDelegate_OneParam< bool, const FPointerEvent & >   SWebBrowserView.h
FOnLoadUrl TBaseDelegate_ThreeParams< bool, const FString &, const FString &, FString & >   SWebBrowserView.h
FOnShowDialog TBaseDelegate_OneParam< EWebBrowserDialogEventResponse, const TWeakPtr< IWebBrowserDialog > & >   SWebBrowserView.h
FOnSuppressContextMenu TBaseDelegate_NoParams< bool >   SWebBrowserView.h
FOnUnhandledKeyChar TBaseDelegate_OneParam< bool, const FCharacterEvent & >   SWebBrowserView.h
FOnUnhandledKeyDown TBaseDelegate_OneParam< bool, const FKeyEvent & >   SWebBrowserView.h
FOnUnhandledKeyUp TBaseDelegate_OneParam< bool, const FKeyEvent & >   SWebBrowserView.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
Adapters TArray< TSharedRef< IWebBrowserAdapter > >   SWebBrowserView.h  
AddressBarUrl FText The url that appears in the address bar which can differ from the url of the loaded page SWebBrowserView.h  
BrowserViewport TSharedPtr< FWebBrowserViewport > Viewport interface for rendering the web page. SWebBrowserView.h  
BrowserWidget TSharedPtr< SWebBrowserWidget > The implementation dependent widget that renders the browser contents. SWebBrowserView.h  
BrowserWindow TSharedPtr< IWebBrowserWindow > Interface for dealing with a web browser window. SWebBrowserView.h  
MenuViewport TSharedPtr< FWebBrowserViewport > Viewport interface for rendering popup menus. SWebBrowserView.h  
OnBeforeNavigation FOnBeforeBrowse A delegate that is invoked prior to browser navigation SWebBrowserView.h  
OnBeforePopup FOnBeforePopupDelegate A delegate that is invoked when the browser attempts to pop up a new window SWebBrowserView.h  
OnCloseWindow FOnCloseWindowDelegate A delegate that is invoked when a window close event is detected SWebBrowserView.h  
OnConsoleMessage FOnConsoleMessageDelegate A delegate that is invoked for each console message SWebBrowserView.h  
OnCreateToolTip FOnCreateToolTip A delegate that is invoked when when the browser wishes to create a tooltip SWebBrowserView.h  
OnCreateWindow FOnCreateWindowDelegate A delegate that is invoked when the browser requests a UI window for another browser it spawned SWebBrowserView.h  
OnDismissAllDialogs FSimpleDelegate A delegate that is invoked when when the browser needs to dismiss all dialogs SWebBrowserView.h  
OnDragWindow FOnDragWindow A delegate that is invoked when the browser detects drag event in within drag region SWebBrowserView.h  
OnFloatingCloseButtonPressed FOnFloatingCloseButtonPressedDelegate A delegate that is invoked when the floating close button is pressed SWebBrowserView.h  
OnLoadCompleted FSimpleDelegate A delegate that is invoked when document loading completed. SWebBrowserView.h  
OnLoadError FSimpleDelegate A delegate that is invoked when document loading failed. SWebBrowserView.h  
OnLoadStarted FSimpleDelegate A delegate that is invoked when document loading started. SWebBrowserView.h  
OnLoadUrl FOnLoadUrl A delegate that is invoked when loading a resource, allowing the application to provide contents directly SWebBrowserView.h  
OnShowDialog FOnShowDialog A delegate that is invoked when when the browser needs to present a dialog to the user SWebBrowserView.h  
OnSuppressContextMenu FOnSuppressContextMenu   SWebBrowserView.h  
OnTitleChanged FOnTextChanged A delegate that is invoked when document title changed. SWebBrowserView.h  
OnUnhandledKeyChar FOnUnhandledKeyChar A delegate for handling key char events not handled by browser. SWebBrowserView.h  
OnUnhandledKeyDown FOnUnhandledKeyDown A delegate for handling key down events not handled by browser. SWebBrowserView.h  
OnUnhandledKeyUp FOnUnhandledKeyUp A delegate for handling key up events not handled by browser. SWebBrowserView.h  
OnUrlChanged FOnTextChanged A delegate that is invoked when document address changed. SWebBrowserView.h  
PopupMenuMethod TOptional< EPopupMethod > Can be set to override the popup menu method used for popup menus. SWebBrowserView.h  
PopupMenuPtr TWeakPtr< IMenu > An interface pointer to a menu object presenting a popup. SWebBrowserView.h  
SlateParentWindowPtr TWeakPtr< SWindow > The slate window that contains this widget. SWebBrowserView.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void BindAdapter ( const TSharedRef< IWebBrowserAdapter >& Adapter
)

   SWebBrowserView.h  

void BindInputMethodSystem ( ITextInputMethodSystem* TextInputMethodSystem
)

   SWebBrowserView.h  

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

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

bool CanGoBack()

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

bool CanGoForward()

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

void CloseBrowser ()

 Close the underlying browser object before we destruct this view. SWebBrowserView.h  

void Construct ( const FArguments& InArgs,
const TSharedPtr< IWebBrowserWindow >& InWebBrowserWindow
)

 Construct the widget. SWebBrowserView.h  

void ExecuteJavascript ( const FString& ScriptText
)

 Execute javascript on the current window SWebBrowserView.h  

FText GetAddressBarUrlText()

 Gets the URL that appears in the address bar, this may not be the URL that is currently loaded in the frame. SWebBrowserView.h  

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

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

FText GetTitleText()

 Get the current title of the web page. SWebBrowserView.h  

FString GetUrl()

 Gets the currently loaded URL. SWebBrowserView.h  

void GoBack()

 Navigate backwards. SWebBrowserView.h  

void GoForward()

 Navigate forwards. SWebBrowserView.h  

bool IsInitialized()

 Whether the browser widget is done initializing. SWebBrowserView.h  

bool IsLoaded()

 Whether the document finished loading. SWebBrowserView.h  

bool IsLoading()

 Whether the document is currently being loaded. SWebBrowserView.h  

void LoadString ( FString Contents,
FString DummyURL
)

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

void LoadURL ( FString NewURL
)

 Load the specified URL. SWebBrowserView.h  

void Reload()

 Reload the current page. SWebBrowserView.h  
Update the underlying browser widget to match the KB focus in slate. SWebBrowserView.h  

void SetParentWindow ( TSharedPtr< SWindow > Window
)

 Set parent SWindow for this browser. SWebBrowserView.h  

void ShowFloatingCloseButton ( bool bShow,
bool bDraggable
)

 Shows floating close button. SWebBrowserView.h  

void StopLoad()

 Stop loading the page. SWebBrowserView.h  

void UnbindAdapter ( const TSharedRef< IWebBrowserAdapter >& Adapter
)

   SWebBrowserView.h  

void UnbindInputMethodSystem()

   SWebBrowserView.h  

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

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

Overridden from SWidget

Name Remarks Include Path Unreal Specifiers

virtual FReply OnFocusReceived ( const FGeometry& MyGeometry,
const FFocusEvent& InFocusEvent
)

   SWebBrowserView.h  

virtual int32 OnPaint ( const FPaintArgs& Args,
const FGeometry& AllottedGeometry,
const FSlateRect& MyCullingRect,
FSlateWindowElementList& OutDrawElements,
int32 LayerId,
const FWidgetStyle& InWidgetStyle,
bool bParentEnabled
) const

   SWebBrowserView.h  

virtual bool SupportsKeyboardFocus()

   SWebBrowserView.h  

Protected

Name Remarks Include Path Unreal Specifiers

bool HandleSuppressContextMenu()

   SWebBrowserView.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page