SDK for / Overview

UXsollaWebBrowser Class Reference

Inheritance diagram for UXsollaWebBrowser:

Public Member Functions

 DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam (FOnUrlChanged, const FText &, Text)
 
 DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams (FOnBeforePopup, FString, URL, FString, Frame)
 
 DECLARE_DYNAMIC_MULTICAST_DELEGATE (FOnPageLoaded)
 
void LoadURL (FString NewURL)
 
void LoadHtml (FString Contents, FString DummyURL)
 
void ExecuteJavascript (FString ScriptText)
 
FString GetUrl () const
 
void ClearCache () const
 
void GoBack () const
 
void GoForward () const
 
virtual void ReleaseSlateResources (bool bReleaseChildren) override
 

Public Attributes

FOnUrlChanged OnUrlChanged
 
FOnBeforePopup OnBeforePopup
 
FOnPageLoaded OnPageLoaded
 

Protected Member Functions

virtual TSharedRef< SWidget > RebuildWidget () override
 
void HandleOnUrlChanged (const FText &Text)
 
bool HandleOnBeforePopup (FString URL, FString Frame)
 
void HandleOnPageLoaded ()
 

Protected Attributes

FString InitialURL
 
bool bSupportsTransparency
 
TSharedPtr< class SWebBrowser > WebBrowserWidget
 

Member Function Documentation

◆ ClearCache()

void UXsollaWebBrowser::ClearCache () const

Clear browser cache (cookies etc.).

◆ ExecuteJavascript()

void UXsollaWebBrowser::ExecuteJavascript (FString ScriptText)

Executes a JavaScript string in the context of the web page.

Parameters
ScriptTextJavaScript string to execute.

◆ GetUrl()

FString UXsollaWebBrowser::GetUrl () const

Returns the currently loaded URL.

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

◆ GoBack()

void UXsollaWebBrowser::GoBack () const

Return to previous page.

◆ GoForward()

void UXsollaWebBrowser::GoForward () const

Go to next page.

◆ LoadHtml()

void UXsollaWebBrowser::LoadHtml (FString Contents,
FString DummyURL 
)

Loads the specified HTML page content.

Parameters
ContentsHTMPL page content.

◆ LoadURL()

void UXsollaWebBrowser::LoadURL (FString NewURL)

Loads the specified URL.

Parameters
NewURLNew URL to load.

Member Data Documentation

◆ bSupportsTransparency

bool UXsollaWebBrowser::bSupportsTransparency
protected

Should the browser window support transparency.

◆ InitialURL

FString UXsollaWebBrowser::InitialURL
protected

URL that the browser will initially navigate to. The URL should include the protocol, eg http://

◆ OnBeforePopup

FOnBeforePopup UXsollaWebBrowser::OnBeforePopup

Called when a pop-up is about to spawn.

◆ OnPageLoaded

FOnPageLoaded UXsollaWebBrowser::OnPageLoaded

Called when page loaded.

◆ OnUrlChanged

FOnUrlChanged UXsollaWebBrowser::OnUrlChanged

Called when the URL changes.


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