FArguments

Windows
MacOS
Linux

Inheritance Hierarchy

FSlateBaseNamedArgs

TSlateBaseNamedArgs

SWebBrowser::FArguments

References

Module

WebBrowser

Header

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

Include

#include "SWebBrowser.h"

Syntax

struct FArguments : public TSlateBaseNamedArgs< SWebBrowser >

Constructors

Name Description

Public function

FArguments()

Functions

Name Description

Public function

WidgetArgsTy...

 

BackgroundColor

(
    FColor InArg
)

Opaque background color used before a document is loaded and when no document color is specified.

Public function

WidgetArgsTy...

 

BrowserFrameRate

(
    int InArg
)

The frames per second rate that the browser will attempt to use.

Public function

WidgetArgsTy...

 

ContentsToLoad

(
    TOptional< FString > InArg
)

Optional string to load contents as a web page.

Public function

WidgetArgsTy...

 

InitialURL

(
    FString InArg
)

URL that the browser will initially navigate to.

Public function

WidgetArgsTy...

 

OnBeforeNavigation

(
    const FOnBeforeBrowse& InDelegate
)

Called before browser navigation.

Public function

WidgetArgsTy...

 

OnBeforePopup

(
    const FOnBeforePopupDelegate& InDe...
)

Called before a popup window happens

Public function

WidgetArgsTy...

 

OnCloseWindow

(
    const FOnCloseWindowDelegate& InDe...
)

Called when a browser window close event is detected

Public function

WidgetArgsTy...

 

OnCreateWindow

(
    const FOnCreateWindowDelegate& InD...
)

Called when the browser requests the creation of a new window

Public function

WidgetArgsTy...

 

OnDismissAllDialogs

(
    const FSimpleDelegate& InDelegate
)

Called to dismiss any dialogs shown via OnShowDialog.

Public function

WidgetArgsTy...

 

OnDragWindow

(
    const FOnDragWindow& InDelegate
)

Called when drag is detected in a web page area tagged as a drag region.

Public function

WidgetArgsTy...

 

OnLoadCompleted

(
    const FSimpleDelegate& InDelegate
)

Called when document loading completed.

Public function

WidgetArgsTy...

 

OnLoadError

(
    const FSimpleDelegate& InDelegate
)

Called when document loading failed.

Public function

WidgetArgsTy...

 

OnLoadStarted

(
    const FSimpleDelegate& InDelegate
)

Called when document loading started.

Public function

WidgetArgsTy...

 

OnLoadUrl

(
    const FOnLoadUrl& InDelegate
)

Called to allow bypassing page content on load.

Public function

WidgetArgsTy...

 

OnShowDialog

(
    const FOnShowDialog& InDelegate
)

Called when the browser needs to show a dialog to the user.

Public function

WidgetArgsTy...

 

OnSuppressContextMenu

(
    const FOnSuppressContextMenu& InDe...
)

Public function

WidgetArgsTy...

 

OnTitleChanged

(
    const FOnTextChanged& InDelegate
)

Called when document title changed.

Public function

WidgetArgsTy...

 

OnUrlChanged

(
    const FOnTextChanged& InDelegate
)

Called when the Url changes.

Public function

WidgetArgsTy...

 

ParentWindow

(
    TSharedPtr< SWindow > InArg
)

A reference to the parent window.

Public function

WidgetArgsTy...

 

PopupMenuMethod

(
    TOptional< EPopupMethod > InArg
)

Override the popup menu method used for popup menus.

Public function

WidgetArgsTy...

 

ShowAddressBar

(
    bool InArg
)

Whether to show an address bar.

Public function

WidgetArgsTy...

 

ShowControls

(
    bool InArg
)

Whether to show standard controls like Back, Forward, Reload etc.

Public function

WidgetArgsTy...

 

ShowErrorMessage

(
    bool InArg
)

Whether to show an error message in case of loading errors.

Public function

WidgetArgsTy...

 

ShowInitialThrobber

(
    bool InArg
)

Whether to show a throbber overlay during browser initialization.

Public function

WidgetArgsTy...

 

SupportsThumbMouseButtonNavigation

(
    bool InArg
)

Whether to allow forward and back navigation via the mouse thumb buttons.

Public function

WidgetArgsTy...

 

SupportsTransparency

(
    bool InArg
)

Should this browser window support transparency.

Public function

WidgetArgsTy...

 

ViewportSize

(
    const TAttribute< FVector2D >& InA...
)

Desired size of the web browser viewport.

Typedefs

Name

Description

WidgetArgsType

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