#include <SWebBrowserView.h>

Inheritance diagram for SWebBrowserView:

Public Member Functions
	DECLARE_DELEGATE_RetVal_TwoParams (bool, FOnBeforeBrowse, const FString &, const FWebNavigationRequest &) DECLARE_DELEGATE_RetVal_ThreeParams(bool

const FString const FString FString &	DECLARE_DELEGATE_RetVal_OneParam (EWebBrowserDialogEventResponse, FOnShowDialog, const TWeakPtr< IWebBrowserDialog > &)

	DECLARE_DELEGATE_RetVal (bool, FOnSuppressContextMenu)

	DECLARE_DELEGATE_RetVal_OneParam (bool, FOnDragWindow, const FPointerEvent &)

	DECLARE_DELEGATE_RetVal_OneParam (bool, FOnUnhandledKeyDown, const FKeyEvent &)

	DECLARE_DELEGATE_RetVal_OneParam (bool, FOnUnhandledKeyUp, const FKeyEvent &)

	DECLARE_DELEGATE_RetVal_OneParam (bool, FOnUnhandledKeyChar, const FCharacterEvent &)

	SLATE_BEGIN_ARGS (SWebBrowserView)

	SLATE_ATTRIBUTE (FVector2D, ViewportSize)

	SLATE_EVENT (FOnSuppressContextMenu, OnSuppressContextMenu)

WEBBROWSER_API	SWebBrowserView ()

WEBBROWSER_API	~SWebBrowserView ()

virtual bool	SupportsKeyboardFocus () const override

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

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

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

WEBBROWSER_API void	LoadURL (FString NewURL)

WEBBROWSER_API void	LoadString (FString Contents, FString DummyURL)

WEBBROWSER_API void	Reload ()

WEBBROWSER_API void	StopLoad ()

WEBBROWSER_API FText	GetTitleText () const

WEBBROWSER_API FString	GetUrl () const

WEBBROWSER_API FText	GetAddressBarUrlText () const

WEBBROWSER_API bool	IsLoaded () const

WEBBROWSER_API bool	IsLoading () const

WEBBROWSER_API bool	IsInitialized () const

WEBBROWSER_API void	ExecuteJavascript (const FString &ScriptText)

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

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

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

WEBBROWSER_API void	BindAdapter (const TSharedRef< IWebBrowserAdapter > &Adapter)

WEBBROWSER_API void	UnbindAdapter (const TSharedRef< IWebBrowserAdapter > &Adapter)

WEBBROWSER_API void	BindInputMethodSystem (ITextInputMethodSystem *TextInputMethodSystem)

WEBBROWSER_API void	UnbindInputMethodSystem ()

WEBBROWSER_API bool	CanGoBack () const

WEBBROWSER_API void	GoBack ()

WEBBROWSER_API bool	CanGoForward () const

WEBBROWSER_API void	GoForward ()

WEBBROWSER_API void	SetParentWindow (TSharedPtr< SWindow > Window)

WEBBROWSER_API void	SetBrowserKeyboardFocus ()

WEBBROWSER_API void	CloseBrowser ()

WEBBROWSER_API void	ShowFloatingCloseButton (bool bShow, bool bDraggable)

WEBBROWSER_API TSharedPtr< IWebBrowserWindow >	GetBrowserWindow () const

Public Member Functions inherited from SCompoundWidget
const FVector2D	GetContentScale () const

void	SetContentScale (TAttribute< FVector2D > InContentScale)

FLinearColor	GetColorAndOpacity () const

void	SetColorAndOpacity (TAttribute< FLinearColor > InColorAndOpacity)

void	SetForegroundColor (TAttribute< FSlateColor > InForegroundColor)

virtual SLATECORE_API FChildren *	GetChildren () override

virtual SLATECORE_API void	OnArrangeChildren (const FGeometry &AllottedGeometry, FArrangedChildren &ArrangedChildren) const override

virtual SLATECORE_API FSlateColor	GetForegroundColor () const override

virtual SLATECORE_API void	SetVisibility (TAttribute< EVisibility > InVisibility) override final

Public Member Functions inherited from SWidget
SLATECORE_API int32	Paint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const

virtual SLATECORE_API void	Tick (const FGeometry &AllottedGeometry, const double InCurrentTime, const float InDeltaTime)

virtual SLATECORE_API void	OnFocusLost (const FFocusEvent &InFocusEvent)

virtual SLATECORE_API void	OnFocusChanging (const FWeakWidgetPath &PreviousFocusPath, const FWidgetPath &NewWidgetPath, const FFocusEvent &InFocusEvent)

virtual SLATECORE_API FReply	OnKeyChar (const FGeometry &MyGeometry, const FCharacterEvent &InCharacterEvent)

virtual SLATECORE_API FReply	OnPreviewKeyDown (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)

virtual SLATECORE_API FReply	OnKeyDown (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)

virtual SLATECORE_API FReply	OnKeyUp (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)

virtual SLATECORE_API FReply	OnAnalogValueChanged (const FGeometry &MyGeometry, const FAnalogInputEvent &InAnalogInputEvent)

virtual SLATECORE_API FReply	OnMouseButtonDown (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)

virtual SLATECORE_API FReply	OnPreviewMouseButtonDown (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)

virtual SLATECORE_API FReply	OnMouseButtonUp (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)

virtual SLATECORE_API FReply	OnMouseMove (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)

virtual SLATECORE_API void	OnMouseEnter (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)

virtual SLATECORE_API void	OnMouseLeave (const FPointerEvent &MouseEvent)

virtual SLATECORE_API FReply	OnMouseWheel (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)

virtual SLATECORE_API FCursorReply	OnCursorQuery (const FGeometry &MyGeometry, const FPointerEvent &CursorEvent) const

virtual SLATECORE_API TOptional< TSharedRef< SWidget > >	OnMapCursor (const FCursorReply &CursorReply) const

virtual SLATECORE_API FReply	OnMouseButtonDoubleClick (const FGeometry &InMyGeometry, const FPointerEvent &InMouseEvent)

virtual SLATECORE_API bool	OnVisualizeTooltip (const TSharedPtr< SWidget > &TooltipContent)

virtual SLATECORE_API TSharedPtr< FPopupLayer >	OnVisualizePopup (const TSharedRef< SWidget > &PopupContent)

virtual SLATECORE_API FReply	OnDragDetected (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)

virtual SLATECORE_API void	OnDragEnter (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)

virtual SLATECORE_API void	OnDragLeave (const FDragDropEvent &DragDropEvent)

virtual SLATECORE_API FReply	OnDragOver (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)

virtual SLATECORE_API FReply	OnDrop (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)

virtual SLATECORE_API FReply	OnTouchGesture (const FGeometry &MyGeometry, const FPointerEvent &GestureEvent)

virtual SLATECORE_API FReply	OnTouchStarted (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)

virtual SLATECORE_API FReply	OnTouchMoved (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)

virtual SLATECORE_API FReply	OnTouchEnded (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)

virtual SLATECORE_API FReply	OnTouchForceChanged (const FGeometry &MyGeometry, const FPointerEvent &TouchEvent)

virtual SLATECORE_API FReply	OnTouchFirstMove (const FGeometry &MyGeometry, const FPointerEvent &TouchEvent)

virtual SLATECORE_API FReply	OnMotionDetected (const FGeometry &MyGeometry, const FMotionEvent &InMotionEvent)

virtual SLATECORE_API TOptional< bool >	OnQueryShowFocus (const EFocusCause InFocusCause) const

virtual SLATECORE_API TOptional< FVirtualPointerPosition >	TranslateMouseCoordinateForCustomHitTestChild (const SWidget &ChildWidget, const FGeometry &MyGeometry, const FVector2D ScreenSpaceMouseCoordinate, const FVector2D LastScreenSpaceMouseCoordinate) const

virtual SLATECORE_API void	OnFinishedPointerInput ()

virtual SLATECORE_API void	OnFinishedKeyInput ()

virtual SLATECORE_API FNavigationReply	OnNavigation (const FGeometry &MyGeometry, const FNavigationEvent &InNavigationEvent)

virtual SLATECORE_API EWindowZone::Type	GetWindowZoneOverride () const

bool	NeedsPrepass () const

SLATECORE_API void	SlatePrepass ()

SLATECORE_API void	SlatePrepass (float InLayoutScaleMultiplier)

void	SetCanTick (bool bInCanTick)

bool	GetCanTick () const

bool	HasRegisteredSlateAttribute () const

bool	IsAttributesUpdatesEnabled () const

const FSlateWidgetPersistentState &	GetPersistentState () const

const FWidgetProxyHandle	GetProxyHandle () const

SLATECORE_API UE::Slate::FDeprecateVector2DResult	GetDesiredSize () const

SLATECORE_API void	AssignParentWidget (TSharedPtr< SWidget > InParent)

SLATECORE_API bool	ConditionallyDetatchParentWidget (SWidget *InExpectedParent)

virtual bool	ValidatePathToChild (SWidget *InChild)

bool	IsParentValid () const

TSharedPtr< SWidget >	GetParentWidget () const

TSharedPtr< SWidget >	Advanced_GetPaintParentWidget () const

SLATECORE_API FSlateRect	CalculateCullingAndClippingRules (const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, bool &bClipToBounds, bool &bAlwaysClip, bool &bIntersectClipBounds) const

bool	HasAnyUpdateFlags (EWidgetUpdateFlags FlagsToCheck) const

TStatId	GetStatID (bool bForDeferredUse=false) const

virtual SLATECORE_API float	GetRelativeLayoutScale (const int32 ChildIndex, float LayoutScaleMultiplier) const

SLATECORE_API void	ArrangeChildren (const FGeometry &AllottedGeometry, FArrangedChildren &ArrangedChildren, bool bUpdateAttributes=false) const

virtual FChildren *	GetAllChildren ()

virtual SLATECORE_API bool	HasKeyboardFocus () const

SLATECORE_API TOptional< EFocusCause >	HasUserFocus (int32 UserIndex) const

SLATECORE_API TOptional< EFocusCause >	HasAnyUserFocus () const

SLATECORE_API bool	HasUserFocusedDescendants (int32 UserIndex) const

SLATECORE_API bool	HasFocusedDescendants () const

SLATECORE_API bool	HasAnyUserFocusOrFocusedDescendants () const

SLATECORE_API bool	HasMouseCapture () const

SLATECORE_API bool	HasMouseCaptureByUser (int32 UserIndex, TOptional< int32 > PointerIndex=TOptional< int32 >()) const

virtual SLATECORE_API void	OnMouseCaptureLost (const FCaptureLostEvent &CaptureLostEvent)

void	SetEnabled (TAttribute< bool > InEnabledState)

bool	IsEnabled () const

virtual bool	IsInteractable () const

virtual SLATECORE_API TSharedPtr< IToolTip >	GetToolTip ()

virtual SLATECORE_API void	OnToolTipClosing ()

SLATECORE_API void	EnableToolTipForceField (const bool bEnableForceField)

bool	HasToolTipForceField () const

bool	IsHovered () const

SLATECORE_API bool	IsDirectlyHovered () const

EVisibility	GetVisibility () const

bool	IsVolatile () const

bool	IsVolatileIndirectly () const

void	ForceVolatile (bool bForce)

bool	ShouldInvalidatePrepassDueToVolatility ()

SLATECORE_API void	Invalidate (EInvalidateWidgetReason InvalidateReason)

void	CacheVolatility ()

void	MarkPrepassAsDirty ()

float	GetRenderOpacity () const

void	SetRenderOpacity (float InRenderOpacity)

void	SetTag (FName InTag)

const TOptional< FSlateRenderTransform > &	GetRenderTransform () const

TOptional< FSlateRenderTransform >	GetRenderTransformWithRespectToFlowDirection () const

UE::Slate::FDeprecateVector2DResult	GetRenderTransformPivotWithRespectToFlowDirection () const

void	SetRenderTransform (TAttribute< TOptional< FSlateRenderTransform > > InTransform)

UE::Slate::FDeprecateVector2DResult	GetRenderTransformPivot () const

void	SetRenderTransformPivot (TAttribute< FVector2D > InTransformPivot)

SLATECORE_API void	SetClipping (EWidgetClipping InClipping)

EWidgetClipping	GetClipping () const

SLATECORE_API void	SetPixelSnapping (EWidgetPixelSnapping InPixelSnappingMethod)

EWidgetPixelSnapping	GetPixelSnapping () const

void	SetCullingBoundsExtension (const FMargin &InCullingBoundsExtension)

FMargin	GetCullingBoundsExtension () const

void	SetFlowDirectionPreference (EFlowDirectionPreference InFlowDirectionPreference)

EFlowDirectionPreference	GetFlowDirectionPreference () const

SLATECORE_API void	SetToolTipText (const TAttribute< FText > &ToolTipText)

SLATECORE_API void	SetToolTipText (const FText &InToolTipText)

SLATECORE_API void	SetToolTip (const TAttribute< TSharedPtr< IToolTip > > &InToolTip)

SLATECORE_API void	SetCursor (const TAttribute< TOptional< EMouseCursor::Type > > &InCursor)

template<typename MetaDataType >
TSharedPtr< MetaDataType >	GetMetaData () const

template<typename MetaDataType >
TArray< TSharedRef< MetaDataType > >	GetAllMetaData () const

template<typename MetaDataType >
void	AddMetadata (const TSharedRef< MetaDataType > &AddMe)

template<typename MetaDataType >
int32	RemoveMetaData (const TSharedRef< MetaDataType > &RemoveMe)

SLATECORE_API void	SetOnMouseButtonDown (FPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseButtonUp (FPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseMove (FPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseDoubleClick (FPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseEnter (FNoReplyPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseLeave (FSimpleNoReplyPointerEventHandler EventHandler)

virtual SLATECORE_API FString	ToString () const

SLATECORE_API FString	GetTypeAsString () const

SLATECORE_API FName	GetType () const

virtual SLATECORE_API FString	GetReadableLocation () const

SLATECORE_API FName	GetCreatedInLocation () const

virtual SLATECORE_API FName	GetTag () const

virtual SLATECORE_API FSlateColor	GetDisabledForegroundColor () const

SLATECORE_API const FGeometry &	GetCachedGeometry () const

SLATECORE_API const FGeometry &	GetTickSpaceGeometry () const

SLATECORE_API const FGeometry &	GetPaintSpaceGeometry () const

const TOptional< FSlateClippingState > &	GetCurrentClippingState () const

virtual bool	Advanced_IsWindow () const

virtual bool	Advanced_IsInvalidationRoot () const

virtual const FSlateInvalidationRoot *	Advanced_AsInvalidationRoot () const

SLATECORE_API TSharedRef< FActiveTimerHandle >	RegisterActiveTimer (float TickPeriod, FWidgetActiveTimerDelegate TickFunction)

SLATECORE_API void	UnRegisterActiveTimer (const TSharedRef< FActiveTimerHandle > &ActiveTimerHandle)

bool	HasActiveTimers () const

Public Member Functions inherited from FSlateControlledConstruction
	FSlateControlledConstruction ()=default

virtual	~FSlateControlledConstruction ()=default

virtual const FSlateWidgetClassData &	GetWidgetClass () const =0

void	operator delete (void *mem)

Public Member Functions inherited from TSharedFromThis< SWidget >
TSharedRef< SWidget, Mode >	AsShared ()

TSharedRef< SWidget const, Mode >	AsShared () const

TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const

TWeakPtr< SWidget, Mode >	AsWeak ()

TWeakPtr< SWidget const, Mode >	AsWeak () const

TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const

void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const InSharedPtr, OtherType InObject) const

void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const InSharedRef, OtherType InObject) const

UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Public Attributes
	FOnLoadUrl

Protected Member Functions
WEBBROWSER_API bool	HandleSuppressContextMenu ()

Protected Member Functions inherited from SCompoundWidget
virtual SLATECORE_API FVector2D	ComputeDesiredSize (float) const override

TSlateAttributeRef< FVector2D >	GetContentScaleAttribute () const

TSlateAttributeRef< FLinearColor >	GetColorAndOpacityAttribute () const

TSlateAttributeRef< FSlateColor >	GetForegroundColorAttribute () const

SLATECORE_API	SCompoundWidget ()

virtual SLATECORE_API	~SCompoundWidget ()

Protected Member Functions inherited from SWidget
void	SetVolatilePrepass (bool bVolatile)

virtual bool	CustomPrepass (float LayoutScaleMultiplier)

virtual SLATECORE_API void	CacheDesiredSize (float InLayoutScaleMultiplier)

void	SetHover (TAttribute< bool > InHovered)

bool	IsChildWidgetCulled (const FSlateRect &, const FArrangedWidget &) const

SLATECORE_API void	InvalidateChildRemovedFromTree (SWidget &Child)

bool	Advanced_InvalidateVolatility ()

EFlowDirection	ComputeFlowDirection () const

SLATECORE_API void	SetDebugInfo (const ANSICHAR InType, const ANSICHAR InFile, int32 OnLine, size_t InAllocSize)

virtual SLATECORE_API TOptional< EMouseCursor::Type >	GetCursor () const

SLATECORE_API	SWidget ()

SLATECORE_API void	SWidgetConstruct (const FSlateBaseNamedArgs &Args)

bool	IsConstructed () const

SLATECORE_API bool	FindChildGeometries (const FGeometry &MyGeometry, const TSet< TSharedRef< SWidget > > &WidgetsToFind, TMap< TSharedRef< SWidget >, FArrangedWidget > &OutResult) const

SLATECORE_API void	FindChildGeometries_Helper (const FGeometry &MyGeometry, const TSet< TSharedRef< SWidget > > &WidgetsToFind, TMap< TSharedRef< SWidget >, FArrangedWidget > &OutResult) const

SLATECORE_API FGeometry	FindChildGeometry (const FGeometry &MyGeometry, TSharedRef< SWidget > WidgetToFind) const

bool	ShouldBeEnabled (bool InParentEnabled) const

virtual SLATECORE_API const FSlateBrush *	GetFocusBrush () const

virtual bool	ComputeVolatility () const

virtual SLATECORE_API void	OnClippingChanged ()

float	GetPrepassLayoutScaleMultiplier () const

SLATECORE_API void	Prepass_ChildLoop (float InLayoutScaleMultiplier, FChildren *MyChildren)

template<typename TargetValueType , typename SourceValueType >
bool	SetAttribute (TAttribute< TargetValueType > &TargetValue, const TAttribute< SourceValueType > &SourceValue, EInvalidateWidgetReason BaseInvalidationReason)

TSlateAttributeRef< bool >	GetEnabledStateAttribute () const

TSlateAttributeRef< bool >	GetHoveredAttribute () const

TSlateAttributeRef< EVisibility >	GetVisibilityAttribute () const

TSlateAttributeRef< TOptional< FSlateRenderTransform > >	GetRenderTransformAttribute () const

TSlateAttributeRef< FVector2D >	GetRenderTransformPivotAttribute () const

virtual SLATECORE_API	~SWidget ()

Protected Member Functions inherited from TSharedFromThis< SWidget >
	TSharedFromThis ()

	TSharedFromThis (TSharedFromThis const &)

UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)

	~TSharedFromThis ()

Additional Inherited Members
Static Public Member Functions inherited from FSlateControlledConstruction
static const FSlateWidgetClassData &	StaticWidgetClass ()

Static Protected Member Functions inherited from SWidget
static SLATECORE_API int32	FindChildUnderMouse (const FArrangedChildren &Children, const FPointerEvent &MouseEvent)

static SLATECORE_API int32	FindChildUnderPosition (const FArrangedChildren &Children, const UE::Slate::FDeprecateVector2DParameter &ArrangedSpacePosition)

static TAttribute< EVisibility >	AccessWidgetVisibilityAttribute (const TSharedRef< SWidget > &Widget)

Static Protected Member Functions inherited from TSharedFromThis< SWidget >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)

static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Protected Attributes inherited from SCompoundWidget
FCompoundWidgetOneChildSlot	ChildSlot

Protected Attributes inherited from SWidget
uint8	bCanSupportFocus: 1

uint8	bCanHaveChildren: 1

uint8	bClippingProxy: 1

uint8	bHasCustomPrepass: 1

uint8	bHasRelativeLayoutScale: 1

uint8	bVolatilityAlwaysInvalidatesPrepass: 1

EWidgetClipping	Clipping

EWidgetPixelSnapping	PixelSnappingMethod

FMargin	CullingBoundsExtension

float	RenderOpacity

Constructor & Destructor Documentation

◆ SWebBrowserView()

SWebBrowserView::SWebBrowserView ( )

Called to allow overriding of ToolTip widget construction. Called when drag is detected in a web page area tagged as a drag region. Called to allow the handling of any key down events not handled by the browser. Called to allow the handling of any key up events not handled by the browser. Called to allow the handling of any key char events not handled by the browser. Called for each console message Default constructor.

◆ ~SWebBrowserView()

SWebBrowserView::~SWebBrowserView ( )

Member Function Documentation

◆ BindAdapter()

void SWebBrowserView::BindAdapter ( const TSharedRef< IWebBrowserAdapter > & Adapter )

◆ BindInputMethodSystem()

void SWebBrowserView::BindInputMethodSystem ( ITextInputMethodSystem * TextInputMethodSystem )

◆ BindUObject()

void SWebBrowserView::BindUObject	(	const FString &	Name,
		UObject *	Object,
		bool	bIsPermanent = `true`
	)

Expose a UObject instance to the browser runtime. Properties and Functions will be accessible from JavaScript side. As all communication with the rendering procesis asynchronous, return values (both for properties and function results) are wrapped into JS Future objects.

Parameters

Name	The name of the object. The object will show up as window.ue.{Name} on the javascript side. If there is an existing object of the same name, this object will replace it. If bIsPermanent is false and there is an existing permanent binding, the permanent binding will be restored when the temporary one is removed.
Object	The object instance.
bIsPermanent	If true, the object will be visible to all pages loaded through this browser widget, otherwise, it will be deleted when navigating away from the current page. Non-permanent bindings should be registered from inside an OnLoadStarted event handler in order to be available before JS code starts loading.

◆ CanGoBack()

bool SWebBrowserView::CanGoBack ( ) const

Returns true if the browser can navigate backwards.

◆ CanGoForward()

bool SWebBrowserView::CanGoForward ( ) const

Returns true if the browser can navigate forwards.

◆ CloseBrowser()

void SWebBrowserView::CloseBrowser ( )

Close the underlying browser object before we destruct this view. This will block until that object is fully destroyed. Calling this is optional, CEF has object lifetime requirements that mean on shutdown you must destroy browsers before exit.

◆ Construct()

void SWebBrowserView::Construct	(	const FArguments &	InArgs,
		const TSharedPtr< IWebBrowserWindow > &	InWebBrowserWindow = `nullptr`
	)

Construct the widget.

Parameters

InArgs Declaration from which to construct the widget.

◆ DECLARE_DELEGATE_RetVal()

SWebBrowserView::DECLARE_DELEGATE_RetVal	(	bool	,
		FOnSuppressContextMenu
	)

◆ DECLARE_DELEGATE_RetVal_OneParam() [1/5]

SWebBrowserView::DECLARE_DELEGATE_RetVal_OneParam	(	bool	,
		FOnDragWindow	,
		const FPointerEvent &
	)

◆ DECLARE_DELEGATE_RetVal_OneParam() [2/5]

SWebBrowserView::DECLARE_DELEGATE_RetVal_OneParam	(	bool	,
		FOnUnhandledKeyChar	,
		const FCharacterEvent &
	)

◆ DECLARE_DELEGATE_RetVal_OneParam() [3/5]

SWebBrowserView::DECLARE_DELEGATE_RetVal_OneParam	(	bool	,
		FOnUnhandledKeyDown	,
		const FKeyEvent &
	)

◆ DECLARE_DELEGATE_RetVal_OneParam() [4/5]

SWebBrowserView::DECLARE_DELEGATE_RetVal_OneParam	(	bool	,
		FOnUnhandledKeyUp	,
		const FKeyEvent &
	)

◆ DECLARE_DELEGATE_RetVal_OneParam() [5/5]

const FString const FString FString & SWebBrowserView::DECLARE_DELEGATE_RetVal_OneParam	(	EWebBrowserDialogEventResponse	,
		FOnShowDialog	,
		const TWeakPtr< IWebBrowserDialog > &
	)

◆ DECLARE_DELEGATE_RetVal_TwoParams()

SWebBrowserView::DECLARE_DELEGATE_RetVal_TwoParams	(	bool	,
		FOnBeforeBrowse	,
		const FString &	,
		const FWebNavigationRequest &
	)

◆ ExecuteJavascript()

void SWebBrowserView::ExecuteJavascript ( const FString & ScriptText )

Execute javascript on the current window

◆ GetAddressBarUrlText()

FText SWebBrowserView::GetAddressBarUrlText ( ) const

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

Returns: The address bar URL.

◆ GetBrowserWindow()

TSharedPtr< IWebBrowserWindow > SWebBrowserView::GetBrowserWindow ( ) const

Gets the internal web browser window

◆ GetSource()

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

Gets the source of the main frame as raw HTML.

This method has to be called asynchronously by passing a callback function, which will be called at a later point when the result is ready.

Parameters

Callback A callable that takes a single string reference for handling the result.

◆ GetTitleText()

FText SWebBrowserView::GetTitleText ( ) const

Get the current title of the web page.

◆ GetUrl()

FString SWebBrowserView::GetUrl ( ) const

Gets the currently loaded URL.

Returns: The URL, or empty string if no document is loaded.

◆ GoBack()

void SWebBrowserView::GoBack ( )

Navigate backwards.

◆ GoForward()

void SWebBrowserView::GoForward ( )

Navigate forwards.

◆ HandleSuppressContextMenu()

bool SWebBrowserView::HandleSuppressContextMenu ( )

protected

◆ IsInitialized()

bool SWebBrowserView::IsInitialized ( ) const

Whether the browser widget is done initializing.

◆ IsLoaded()

bool SWebBrowserView::IsLoaded ( ) const

Whether the document finished loading.

◆ IsLoading()

bool SWebBrowserView::IsLoading ( ) const

Whether the document is currently being loaded.

◆ LoadString()

void SWebBrowserView::LoadString	(	FString	Contents,
		FString	DummyURL
	)

Load a string as data to create a web page.

Parameters

Contents	String to load.
DummyURL	Dummy URL for the page.

◆ LoadURL()

void SWebBrowserView::LoadURL ( FString NewURL )

Load the specified URL.

Parameters

NewURL New URL to load.

◆ OnFocusReceived()

FReply SWebBrowserView::OnFocusReceived	(	const FGeometry &	MyGeometry,
		const FFocusEvent &	InFocusEvent
	)

overridevirtual

Called when focus is given to this widget. This event does not bubble.

Parameters

MyGeometry	The Geometry of the widget receiving the event
InFocusEvent	The FocusEvent

Returns: Returns whether the event was handled, along with other possible actions

Reimplemented from SWidget.

◆ OnPaint()

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

overridevirtual

The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children. Called by the non-virtual OnPaint to enforce pre/post conditions during OnPaint.

Parameters

Args	All the arguments necessary to paint this widget (
AllottedGeometry	The FGeometry that describes an area in which the widget should appear.
MyCullingRect	The rectangle representing the bounds currently being used to completely cull widgets. Unless IsChildWidgetCulled(...) returns true, you should paint the widget.
OutDrawElements	A list of FDrawElements to populate with the output.
LayerId	The Layer onto which this widget should be rendered.
InColorAndOpacity	Color and Opacity to be applied to all the descendants of the widget being painted
bParentEnabled	True if the parent of this widget is enabled.

Returns: The maximum layer ID attained by this widget or any of its children.

Reimplemented from SCompoundWidget.

◆ Reload()

void SWebBrowserView::Reload ( )

Reload the current page.

◆ SetBrowserKeyboardFocus()

void SWebBrowserView::SetBrowserKeyboardFocus ( )

Update the underlying browser widget to match the KB focus in slate. This is used to work around a CEF bug that loses focus state on navigations

◆ SetParentWindow()

void SWebBrowserView::SetParentWindow ( TSharedPtr< SWindow > Window )

Set parent SWindow for this browser.

◆ ShowFloatingCloseButton()

void SWebBrowserView::ShowFloatingCloseButton	(	bool	bShow,
		bool	bDraggable
	)

Shows floating close button.

◆ SLATE_ATTRIBUTE()

SWebBrowserView::SLATE_ATTRIBUTE	(	FVector2D	,
		ViewportSize
	)

A reference to the parent window. URL that the browser will initially navigate to. Optional string to load contents as a web page. Whether to show an error message in case of loading errors. Should this browser window support transparency. Should this browser window intercept resource loading requests. If false the BrowserContext will instead. Defaults to True. Whether to allow forward and back navigation via the mouse thumb buttons. Opaque background color used before a document is loaded and when no document color is specified. The frames per second rate that the browser will attempt to use. Override the popup menu method used for popup menus. If not set, parent widgets will be queried instead. Override the default global context settings for this specific window. If not set, the global default will be used. Domains to retry if original domain cannot connect. Desired size of the web browser viewport.

◆ SLATE_BEGIN_ARGS()

SWebBrowserView::SLATE_BEGIN_ARGS ( SWebBrowserView )

inline

◆ SLATE_EVENT()

SWebBrowserView::SLATE_EVENT	(	FOnSuppressContextMenu	,
		OnSuppressContextMenu
	)

Called when document loading completed. Called when document loading failed. Called when document loading started. Called when document title changed. Called when the Url changes. Called before a popup window happens Called when the browser requests the creation of a new window Called when a browser window close event is detected Called when a browser window requests to close through the floating close button Called before browser navigation. Called to allow bypassing page content on load. Called when the browser needs to show a dialog to the user. Called to dismiss any dialogs shown via OnShowDialog. Called to allow suppression of the browser context menu.

◆ StopLoad()

void SWebBrowserView::StopLoad ( )

Stop loading the page.

◆ SupportsKeyboardFocus()

virtual bool SWebBrowserView::SupportsKeyboardFocus ( ) const

inlineoverridevirtual

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

Returns: True if this widget can take keyboard focus

Reimplemented from SWidget.

◆ UnbindAdapter()

void SWebBrowserView::UnbindAdapter ( const TSharedRef< IWebBrowserAdapter > & Adapter )

◆ UnbindInputMethodSystem()

void SWebBrowserView::UnbindInputMethodSystem ( )

◆ UnbindUObject()

void SWebBrowserView::UnbindUObject	(	const FString &	Name,
		UObject *	Object,
		bool	bIsPermanent = `true`
	)

Remove an existing script binding registered by BindUObject.

Parameters

Name	The name of the object to remove.
Object	The object will only be removed if it is the same object as the one passed in.
bIsPermanent	Must match the bIsPermanent argument passed to BindUObject.

Member Data Documentation

◆ FOnLoadUrl

SWebBrowserView::FOnLoadUrl

The documentation for this class was generated from the following files:

Engine/Source/Runtime/WebBrowser/Public/SWebBrowserView.h
Engine/Source/Runtime/WebBrowser/Private/SWebBrowserView.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ SWebBrowserView()

◆ ~SWebBrowserView()

Member Function Documentation

◆ BindAdapter()

◆ BindInputMethodSystem()

◆ BindUObject()

◆ CanGoBack()

◆ CanGoForward()

◆ CloseBrowser()

◆ Construct()

◆ DECLARE_DELEGATE_RetVal()

◆ DECLARE_DELEGATE_RetVal_OneParam() [1/5]

◆ DECLARE_DELEGATE_RetVal_OneParam() [2/5]

◆ DECLARE_DELEGATE_RetVal_OneParam() [3/5]

◆ DECLARE_DELEGATE_RetVal_OneParam() [4/5]

◆ DECLARE_DELEGATE_RetVal_OneParam() [5/5]

◆ DECLARE_DELEGATE_RetVal_TwoParams()

◆ ExecuteJavascript()

◆ GetAddressBarUrlText()

◆ GetBrowserWindow()

◆ GetSource()

◆ GetTitleText()

◆ GetUrl()

◆ GoBack()

◆ GoForward()

◆ HandleSuppressContextMenu()

◆ IsInitialized()

◆ IsLoaded()

◆ IsLoading()

◆ LoadString()

◆ LoadURL()

◆ OnFocusReceived()

◆ OnPaint()

◆ Reload()

◆ SetBrowserKeyboardFocus()

◆ SetParentWindow()

◆ ShowFloatingCloseButton()

◆ SLATE_ATTRIBUTE()

◆ SLATE_BEGIN_ARGS()

◆ SLATE_EVENT()

◆ StopLoad()

◆ SupportsKeyboardFocus()

◆ UnbindAdapter()

◆ UnbindInputMethodSystem()

◆ UnbindUObject()

Member Data Documentation

◆ FOnLoadUrl