SWebBrowser

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

WebBrowser

Header

/Engine/Source/Runtime/WebBrowser/Public/SWebBrowser.h

Include

#include "SWebBrowser.h"

Syntax

class SWebBrowser : public SCompoundWidget

Constructors

Name Description

Public function

SWebBrowser()

Default constructor.

Destructors

Name Description

Public function

~SWebBrowser()

Functions

Name Description

Public function

void

 

BindAdapter

(
    const TSharedRef< IWebBrowserAdapte...
)

Public function

void

 

BindInputMethodSystem

(
    ITextInputMethodSystem* TextIn...
)

Public function

void

 

BindUObject

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

Expose a UObject instance to the browser runtime.

Public function Const

bool

 

CanGoBack()

Returns true if the browser can navigate backwards.

Public function Const

bool

 

CanGoForward()

Returns true if the browser can navigate forwards.

Public function

void

 

Construct

(
    const FArguments& InArgs,
    const TSharedPtr< IWebBrowserWindow...
)

Construct the widget.

Public function

void

 

ExecuteJavascript

(
    const FString& ScriptText
)

Execute javascript on the current window

Public function Const

FText

 

GetAddressBarUrlText()

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

Public function Const

void

 

GetSource

(
    TFunction< void&)> C...
)

Gets the source of the main frame as raw HTML.

Public function Const

FText

 

GetTitleText()

Get the current title of the web page.

Public function Const

FString

 

GetUrl()

Gets the currently loaded URL.

Public function

void

 

GoBack()

Navigate backwards.

Public function

void

 

GoForward()

Navigate forwards.

Public function Const

bool

 

IsLoaded()

Whether the document finished loading.

Public function Const

bool

 

IsLoading()

Whether the document is currently being loaded.

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

void

 

Reload()

Reload the current page.

Public function

void

 

StopLoad()

Stop loading the page.

Public function

void

 

UnbindAdapter

(
    const TSharedRef< IWebBrowserAdapte...
)

Public function

void

 

UnbindInputMethodSystem()

Public function

void

 

UnbindUObject

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

Remove an existing script binding registered by BindUObject.

Overridden from SWidget

Name Description

Public function Virtual Const

bool

 

SupportsKeyboardFocus()

Checks to see if this widget supports keyboard focus. Override this in derived classes.

Classes

Name

Description

Public struct

FArguments

Typedefs

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss