1. Epic GamesDeveloper
  3. SWebBrowser

SWebBrowser

API > API/Runtime > API/Runtime/WebBrowser

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

Syntax

class SWebBrowser : public SCompoundWidget

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

SWebBrowser()

 Default constructor. SWebBrowser.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~SWebBrowser()

   SWebBrowser.h  

Structs

Name Remarks
FArguments  

Typedefs

Name Type Remarks Include Path
FOnBeforeBrowse TBaseDelegate_TwoParams< bool, const FString &, const FWebNavigationRequest & >   SWebBrowser.h
FOnDragWindow TBaseDelegate_OneParam< bool, const FPointerEvent & >   SWebBrowser.h
FOnLoadUrl TBaseDelegate_ThreeParams< bool, const FString &, const FString &, FString & >   SWebBrowser.h
FOnShowDialog TBaseDelegate_OneParam< EWebBrowserDialogEventResponse, const TWeakPtr< IWebBrowserDialog > & >   SWebBrowser.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
BrowserView TSharedPtr< SWebBrowserView > The actual web browser view SWebBrowser.h  
bShowInitialThrobber bool The initial throbber setting SWebBrowser.h  
InputText TSharedPtr< SEditableTextBox > Editable text widget used for an address bar SWebBrowser.h  
OnBeforeNavigation FOnBeforeBrowse A delegate that is invoked prior to browser navigation SWebBrowser.h  
OnBeforePopup FOnBeforePopupDelegate A delegate that is invoked when the browser attempts to pop up a new window SWebBrowser.h  
OnCloseWindow FOnCloseWindowDelegate A delegate that is invoked when a window close event is detected SWebBrowser.h  
OnConsoleMessage FOnConsoleMessageDelegate A delegate that is invoked when the browser writes console output SWebBrowser.h  
OnCreateWindow FOnCreateWindowDelegate A delegate that is invoked when the browser requests a UI window for another browser it spawned SWebBrowser.h  
OnDismissAllDialogs FSimpleDelegate A delegate that is invoked when when the browser needs to dismiss all dialogs SWebBrowser.h  
OnLoadCompleted FSimpleDelegate A delegate that is invoked when document loading completed. SWebBrowser.h  
OnLoadError FSimpleDelegate A delegate that is invoked when document loading failed. SWebBrowser.h  
OnLoadStarted FSimpleDelegate A delegate that is invoked when document loading started. SWebBrowser.h  
OnLoadUrl FOnLoadUrl A delegate that is invoked when loading a resource, allowing the application to provide contents directly SWebBrowser.h  
OnShowDialog FOnShowDialog A delegate that is invoked when when the browser needs to present a dialog to the user SWebBrowser.h  
OnTitleChanged FOnTextChanged A delegate that is invoked when document title changed. SWebBrowser.h  
OnUrlChanged FOnTextChanged A delegate that is invoked when document address changed. SWebBrowser.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void BindAdapter ( const TSharedRef< IWebBrowserAdapter >& Adapter
)

   SWebBrowser.h  

void BindInputMethodSystem ( ITextInputMethodSystem* TextInputMethodSystem
)

   SWebBrowser.h  

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

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

bool CanGoBack()

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

bool CanGoForward()

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

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

 Construct the widget. SWebBrowser.h  

void ExecuteJavascript ( const FString& ScriptText
)

 Execute javascript on the current window SWebBrowser.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. SWebBrowser.h  

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

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

FText GetTitleText()

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

FString GetUrl()

 Gets the currently loaded URL. SWebBrowser.h  

void GoBack()

 Navigate backwards. SWebBrowser.h  

void GoForward()

 Navigate forwards. SWebBrowser.h  

bool IsLoaded()

 Whether the document finished loading. SWebBrowser.h  

bool IsLoading()

 Whether the document is currently being loaded. SWebBrowser.h  

void LoadString ( FString Contents,
FString DummyURL
)

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

void LoadURL ( FString NewURL
)

 Load the specified URL. SWebBrowser.h  

void Reload()

 Reload the current page. SWebBrowser.h  

void SetParentWindow ( TSharedPtr< SWindow > Window
)

 Set parent SWindow for this browser. SWebBrowser.h  

void StopLoad()

 Stop loading the page. SWebBrowser.h  

void UnbindAdapter ( const TSharedRef< IWebBrowserAdapter >& Adapter
)

   SWebBrowser.h  

void UnbindInputMethodSystem()

   SWebBrowser.h  

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

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

Overridden from SWidget

Name Remarks Include Path Unreal Specifiers

virtual bool SupportsKeyboardFocus()

   SWebBrowser.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page