UInternetBrowser

#include <InternetBrowserUMG/Public/InternetBrowser.h>

class UInternetBrowser

Defined in InternetBrowser.h:203

Inherits: UWidget

Inheritance diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UInternetBrowser["UInternetBrowser"]
  class UWidget["UWidget"]
  UWidget <|-- UInternetBrowser

Collaboration diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UInternetBrowser["UInternetBrowser"]
  class UInternetBrowserSaveGame["UInternetBrowserSaveGame"]
  UInternetBrowser *-- UInternetBrowserSaveGame
  class FBrowserBookmark["FBrowserBookmark"]
  UInternetBrowser *-- FBrowserBookmark
  class FBrowserCookie["FBrowserCookie"]
  UInternetBrowser *-- FBrowserCookie

Class detail

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UInternetBrowser {
    +OnAccessDenied : FOnAccessDenied
    +OnBeforePopup : FOnBeforePopup
    +OnUrlChanged : FOnUrlChanged
    +OnLoadStarted : FOnWebBrowserLoadStarted
    +OnLoadCompleted : FOnWebBrowserLoadCompleted
    +OnLoadError : FOnWebBrowserLoadError
    +OnLoadBrowserURL : FOnLoadBrowserURL
    +UInternetBrowser(const FObjectInitializer &ObjectInitializer
    +RebuildWidget() override TSharedRef< SWidget >
    +ReleaseSlateResources(bool bReleaseChildren) override
    +InitializeInternetBrowser(const FString InOverrideURL="")
    +LoadURL(const FText &URL) bool
    +LoadString(FString Contents, FString DummyURL)
    +ExecuteJavascript(const FString &ScriptText)
    +AddBookmark(const FBrowserBookmark &InBookmark)
    +RemoveBookmark(const FBrowserBookmark &InBookmark)
    +GetBookmarks() const TArray< FBrowserBookmark() >
    +SetCookie(const FString &URL, const FBrowserCookie &I
    +SetCookieForAll(const FBrowserCookie &InCookie, FOnCookieSe
    +DeleteCookie(const FString &URL, const FString &CookieNa
    +DeleteAllCookies(FOnCookieDeleteComplete Delegate)
    +GetCookieName(const FBrowserCookie &InCookie) const FString
    +GetTitleText() const FText
    +GetUrl() const FString
    +GetAddressbarUrl() const FText
    +GetBrowserProtocolLink() const FString
    +GetHistory() const TArray< FInternetBrowserHistory() >
    +IsHistoryValid(const FInternetBrowserHistory &InHistory) bool
    +GetCleanDomainName(const FText &InURL) FText
    +ReloadWebPage()
    +InitialURL : FString
    +bSupportsTransparency : uint8
    +bShowWhitelistOnly : uint8
    +bEnableHistory : uint8
    +bOnlyHTTPS : uint8
    +bSupportBrowserURLs : uint8
    +bSupportLocalhost : uint8
    +BrowserIdentifier : FName
    +InternetBrowserSaveGameClass : TSubclassOf< UInternetBrowserSaveGame() 
    +WhitelistWebsites : TArray< FString >
    +Bookmarks : TArray< FBrowserBookmark() >
    +BackButton : UButton *
    +ForwardButton : UButton *
    +ReloadButton : UButton *
    +Addressbar : UEditableTextBox *
    +WebBrowserWidget : TSharedPtr< SWebBrowser >
    +LastLoadedURL : FString
    +Cookie : FBrowserCookie()
    +SavedBookmarks : TMap< FString, FString >
  }

Represents a web browser widget that can be embedded in a UMG widget.

Public Attributes

Return	Name	Description
FOnAccessDenied	OnAccessDenied
FOnBeforePopup	OnBeforePopup
FOnUrlChanged	OnUrlChanged
FOnWebBrowserLoadStarted	OnLoadStarted
FOnWebBrowserLoadCompleted	OnLoadCompleted
FOnWebBrowserLoadError	OnLoadError
FOnLoadBrowserURL	OnLoadBrowserURL

---

OnAccessDenied

FOnAccessDenied OnAccessDenied

Defined in InternetBrowser.h:277

Referenced by

• LoadURL

---

OnBeforePopup

FOnBeforePopup OnBeforePopup

Defined in InternetBrowser.h:281

OnUrlChanged

FOnUrlChanged OnUrlChanged

Defined in InternetBrowser.h:285

OnLoadStarted

FOnWebBrowserLoadStarted OnLoadStarted

Defined in InternetBrowser.h:289

OnLoadCompleted

FOnWebBrowserLoadCompleted OnLoadCompleted

Defined in InternetBrowser.h:293

OnLoadError

FOnWebBrowserLoadError OnLoadError

Defined in InternetBrowser.h:297

OnLoadBrowserURL

FOnLoadBrowserURL OnLoadBrowserURL

Defined in InternetBrowser.h:301

Referenced by

• LoadURL

Public Methods

Return	Name	Description
	UInternetBrowser
TSharedRef< SWidget >	RebuildWidget virtual override
void	ReleaseSlateResources virtual override
void	InitializeInternetBrowser	public UInternetBrowser::InitializeInternetBrowser Assign delegates to back, forward, reload buttons and address bar. Make sure you assign them first. Load initial URL.
bool	LoadURL	public UInternetBrowser::LoadURL Loads the given URL with support for internal browser URLs. Automatically adds https:// protocol if not present. So if you pass google.com to URL, it will be converted to https://google.com
void	LoadString	public UInternetBrowser::LoadString Load a string as data to create a web page.
void	ExecuteJavascript	public UInternetBrowser::ExecuteJavascript Execute javascript on the current window
void	AddBookmark	public UInternetBrowser::AddBookmark Adds the given bookmark to bookmarks array.
void	RemoveBookmark	public UInternetBrowser::RemoveBookmark Removes the given bookmark.
TArray< FBrowserBookmark >	GetBookmarks const inline	public UInternetBrowser::GetBookmarks const Returns all the bookmarks.
void	SetCookie	public UInternetBrowser::SetCookie Sets a cookie for given URL. This function expects each attribute to be well-formed. It will check for disallowed characters (e.g. the ’;’ character is disallowed within the cookie Value field) and fail without setting the cookie if such characters are found.
void	SetCookieForAll	public UInternetBrowser::SetCookieForAll Sets a cookie for all URLs. This function expects each attribute to be well-formed. It will check for disallowed characters (e.g. the ’;’ character is disallowed within the cookie Value field) and fail without setting the cookie if such characters are found.
void	DeleteCookie	public UInternetBrowser::DeleteCookie Deletes the given cookie for the given URL.
void	DeleteAllCookies	public UInternetBrowser::DeleteAllCookies Delete the entire cookie database.
FString	GetCookieName const inline	public UInternetBrowser::GetCookieName const Gets the name of the given cookie.
FText	GetTitleText const	public UInternetBrowser::GetTitleText const Gets the title of the loaded URL.
FString	GetUrl const	public UInternetBrowser::GetUrl const Returns the currently loaded URL.
FText	GetAddressbarUrl const	public UInternetBrowser::GetAddressbarUrl const Gets the URL that appears in the address bar, this may not be the URL that is currently loaded in the frame.
FString	GetBrowserProtocolLink const	public UInternetBrowser::GetBrowserProtocolLink const Gets the protocol link for this browser. Similar to chrome:// @See BrowserIdentifier variable.
TArray< FInternetBrowserHistory >	GetHistory const	public UInternetBrowser::GetHistory const Returns array of FWebHistory. This array contains all the web pages the user has visited if History is enabled.

---

UInternetBrowser

UInternetBrowser(const FObjectInitializer & ObjectInitializer)

Defined in InternetBrowser.h:303

References

• bEnableHistory
• bOnlyHTTPS
• BrowserIdentifier
• bShowWhitelistOnly
• bSupportBrowserURLs
• bSupportLocalhost
• bSupportsTransparency
• InitialURL
• InternetBrowserSaveGameClass

---

RebuildWidget

virtual override

virtual TSharedRef< SWidget > RebuildWidget() override

Defined in InternetBrowser.h:305

References

• Bookmarks
• bSupportsTransparency
• GetSavedBookmarks
• LoadBrowser
• WebBrowserWidget

---

ReleaseSlateResources

virtual override

virtual void ReleaseSlateResources(bool bReleaseChildren) override

Defined in InternetBrowser.h:306

References

• WebBrowserWidget

---

InitializeInternetBrowser

void InitializeInternetBrowser(const FString InOverrideURL = "")

Defined in InternetBrowser.h:327 public UInternetBrowser::InitializeInternetBrowser Assign delegates to back, forward, reload buttons and address bar. Make sure you assign them first. Load initial URL.

Parameters

• InOverrideURL [const FText]

References

• Addressbar
• BackButton
• ForwardButton
• IBROWSER_ERR
• IBROWSER_LOG
• InitialURL
• LoadURL
• ReloadButton
• ReloadWebPage

---

LoadURL

bool LoadURL(const FText & URL)

Defined in InternetBrowser.h:337 public UInternetBrowser::LoadURL Loads the given URL with support for internal browser URLs. Automatically adds https:// protocol if not present. So if you pass google.com to URL, it will be converted to https://google.com

Parameters

• URL [const FText &] URL to load. Adds https:// protocol if not present.

Returns

[bool] True if URL is loaded.

Referenced by

• InitializeInternetBrowser

References

• Addressbar
• bOnlyHTTPS
• bShowWhitelistOnly
• LastLoadedURL
• OnAccessDenied
• OnLoadBrowserURL
• WebBrowserWidget
• WhitelistWebsites

---

LoadString

void LoadString(FString Contents, FString DummyURL)

Defined in InternetBrowser.h:346 public UInternetBrowser::LoadString Load a string as data to create a web page.

Parameters

• Contents [FString] HTML string to load.

• DummyURL [FString] Dummy URL for the page.

References

• WebBrowserWidget

---

ExecuteJavascript

void ExecuteJavascript(const FString & ScriptText)

Defined in InternetBrowser.h:354 public UInternetBrowser::ExecuteJavascript Execute javascript on the current window

Parameters

• ScriptText [const FString&] Javascript to execute.

References

• WebBrowserWidget

---

AddBookmark

void AddBookmark(const FBrowserBookmark & InBookmark)

Defined in InternetBrowser.h:362 public UInternetBrowser::AddBookmark Adds the given bookmark to bookmarks array.

Parameters

• InBookmark [const FBrowserBookmark&] Bookmark struct.

References

• Bookmarks
• SaveBrowser

---

RemoveBookmark

void RemoveBookmark(const FBrowserBookmark & InBookmark)

Defined in InternetBrowser.h:370 public UInternetBrowser::RemoveBookmark Removes the given bookmark.

Parameters

• InBookmark [const FBrowserBookmark&] Bookmark struct.

References

• Bookmarks
• SaveBrowser

---

GetBookmarks

const inline

inline TArray< FBrowserBookmark > GetBookmarks() const

Defined in InternetBrowser.h:378 public UInternetBrowser::GetBookmarks const Returns all the bookmarks.

Returns

[TArray<FBrowserBookmark>] Bookmarks array.

Referenced by

• SaveBrowser

---

SetCookie

void SetCookie(const FString & URL, const FBrowserCookie & InCookie, FOnCookieSetComplete Delegate)

Defined in InternetBrowser.h:391 public UInternetBrowser::SetCookie Sets a cookie for given URL. This function expects each attribute to be well-formed. It will check for disallowed characters (e.g. the ’;’ character is disallowed within the cookie Value field) and fail without setting the cookie if such characters are found.

Parameters

• URL [const FString&] URL to match when searching for cookie to set.

• InCookie [const FBrowserCookie &] Cookie to set.

• Delegate [FOnCookieSetComplete] A callback delegate that will be invoked when the set is complete passing success bool.

Referenced by

• SetCookieForAll

References

• bExpires
• bHttpRequestOnly
• bHttpsRequestsOnly
• Domain
• ExpireTime
• Name
• Path
• Value

---

SetCookieForAll

void SetCookieForAll(const FBrowserCookie & InCookie, FOnCookieSetComplete Delegate)

Defined in InternetBrowser.h:403 public UInternetBrowser::SetCookieForAll Sets a cookie for all URLs. This function expects each attribute to be well-formed. It will check for disallowed characters (e.g. the ’;’ character is disallowed within the cookie Value field) and fail without setting the cookie if such characters are found.

Parameters

• InCookie [const FBrowserCookie&] Cookie to set.

• Delegate [FOnCookieSetComplete] A callback delegate that will be invoked when the set is complete passing success bool.

References

• SetCookie

---

DeleteCookie

void DeleteCookie(const FString & URL, const FString & CookieName, FOnCookieDeleteComplete Delegate)

Defined in InternetBrowser.h:413 public UInternetBrowser::DeleteCookie Deletes the given cookie for the given URL.

Parameters

• URL [const FString&] URL to match when searching for cookie to remove.

• CookieName [const FString&] The name of the cookie to delete. If left unspecified, all cookies will be removed.

• Delegate [FOnCookieDeleteComplete] A callback delegate that will be invoked when the deletion is complete passing number of deleted cookies.

Referenced by

• DeleteAllCookies

---

DeleteAllCookies

void DeleteAllCookies(FOnCookieDeleteComplete Delegate)

Defined in InternetBrowser.h:421 public UInternetBrowser::DeleteAllCookies Delete the entire cookie database.

Parameters

• Delegate [FOnCookieDeleteComplete] A callback delegate that will be invoked when the deletion is complete passing number of deleted cookies.

References

• DeleteCookie

---

GetCookieName

const inline

inline FString GetCookieName(const FBrowserCookie & InCookie) const

Defined in InternetBrowser.h:430 public UInternetBrowser::GetCookieName const Gets the name of the given cookie.

Parameters

• InCookie [const FBrowserCookie&] Cookie to get the name from.

Returns

[FString] Name of the cookie.

---

GetTitleText

const

FText GetTitleText() const

Defined in InternetBrowser.h:438 public UInternetBrowser::GetTitleText const Gets the title of the loaded URL.

Returns

[FText] Title for the loaded URL.

References

• WebBrowserWidget

---

GetUrl

const

FString GetUrl() const

Defined in InternetBrowser.h:446 public UInternetBrowser::GetUrl const Returns the currently loaded URL.

Returns

[FString] Currently loaded URL.

References

• WebBrowserWidget

---

GetAddressbarUrl

const

FText GetAddressbarUrl() const

Defined in InternetBrowser.h:454 public UInternetBrowser::GetAddressbarUrl const Gets the URL that appears in the address bar, this may not be the URL that is currently loaded in the frame.

Returns

[FText] URL that appears in the address bar

References

• WebBrowserWidget

---

GetBrowserProtocolLink

const

FString GetBrowserProtocolLink() const

Defined in InternetBrowser.h:472 public UInternetBrowser::GetBrowserProtocolLink const Gets the protocol link for this browser. Similar to chrome:// @See BrowserIdentifier variable.

Returns

[FString] Returns browser protocol link.

References

• BrowserIdentifier

---

GetHistory

const

TArray< FInternetBrowserHistory > GetHistory() const

Defined in InternetBrowser.h:480 public UInternetBrowser::GetHistory const Returns array of FWebHistory. This array contains all the web pages the user has visited if History is enabled.

Returns

[TArray<FWebHistory>] History array.

References

• GetHistoryManager
• History

Public Static Methods

Return	Name	Description
bool	IsHistoryValid static inline	public static UInternetBrowser::IsHistoryValid Checks if the given history is a valid entry.
FText	GetCleanDomainName static	public static UInternetBrowser::GetCleanDomainName Returns a clean domain name from given url. For example: www.google.com if you pass https://www.google.com/search?q=test

---

IsHistoryValid

static inline

static inline bool IsHistoryValid(const FInternetBrowserHistory & InHistory)

Defined in InternetBrowser.h:318 public static UInternetBrowser::IsHistoryValid Checks if the given history is a valid entry.

Parameters

• InHistory [const FInternetBrowserHistory&] History struct to check.

---

GetCleanDomainName

static

static FText GetCleanDomainName(const FText & InURL)

Defined in InternetBrowser.h:463 public static UInternetBrowser::GetCleanDomainName Returns a clean domain name from given url. For example: www.google.com if you pass https://www.google.com/search?q=test

Parameters

• InURL [const FText&] URL to get

Returns

[FText] Proper domain name.

Protected Methods

Return	Name	Description
void	ReloadWebPage	Reloads the current web page in the internet browser.

---

ReloadWebPage

void ReloadWebPage()

Defined in InternetBrowser.h:494 Reloads the current web page in the internet browser.

This method checks if the web browser widget is valid. If it is, it checks if the web browser widget is currently loading a page using the IsLoading() function. If the web browser widget is loading a page, the StopLoad() function is called to stop the loading. If the web browser widget is not loading a page, the Reload() function is called to reload the current web page.

Referenced by

• InitializeInternetBrowser

References

• WebBrowserWidget

Private Attributes

Return	Name	Description
FString	InitialURL	URL that the browser will initially navigate to. The URL should include the protocol, eg http://
uint8	bSupportsTransparency	Should the browser window support transparency.
uint8	bShowWhitelistOnly	If enabled, web browser widget will only load websites provided in WhitelistWebsites array.
uint8	bEnableHistory	If enabled, web browser will add visited websites to History.
uint8	bOnlyHTTPS	If enabled, web browser will convert http to https.
uint8	bSupportBrowserURLs	If enabled, then support browser protocol link similar to chrome://. @See BrowserIdentifier
uint8	bSupportLocalhost	Support localhost and 127.0.0.1
FName	BrowserIdentifier	[NOT YET IMPLEMENTED] An internal identifier used for browser urls. @See UInternetBrowser::GetBrowserProtocolLink()
TSubclassOf< UInternetBrowserSaveGame >	InternetBrowserSaveGameClass	Save game class for saving loading browser properties.
TArray< FString >	WhitelistWebsites	If “Show Whitelist Only” is enabled then Web Browser will only allow to load web pages defined in this array. Accessing any web page not defined in this array will show error page.
TArray< FBrowserBookmark >	Bookmarks	Browser bookmarks.
UButton *	BackButton
UButton *	ForwardButton
UButton *	ReloadButton
UEditableTextBox *	Addressbar
TSharedPtr< SWebBrowser >	WebBrowserWidget
FString	LastLoadedURL
FBrowserCookie	Cookie
TMap< FString, FString >	SavedBookmarks

---

InitialURL

FString InitialURL

Defined in InternetBrowser.h:209 URL that the browser will initially navigate to. The URL should include the protocol, eg http://

Referenced by

• InitializeInternetBrowser
• UInternetBrowser

---

bSupportsTransparency

uint8 bSupportsTransparency

Defined in InternetBrowser.h:213 Should the browser window support transparency.

Referenced by

• RebuildWidget
• UInternetBrowser

---

bShowWhitelistOnly

uint8 bShowWhitelistOnly

Defined in InternetBrowser.h:217 If enabled, web browser widget will only load websites provided in WhitelistWebsites array.

Referenced by

• LoadURL
• UInternetBrowser

---

bEnableHistory

uint8 bEnableHistory

Defined in InternetBrowser.h:221 If enabled, web browser will add visited websites to History.

Referenced by

• UInternetBrowser

---

bOnlyHTTPS

uint8 bOnlyHTTPS

Defined in InternetBrowser.h:225 If enabled, web browser will convert http to https.

Referenced by

• LoadURL
• UInternetBrowser

---

bSupportBrowserURLs

uint8 bSupportBrowserURLs

Defined in InternetBrowser.h:229 If enabled, then support browser protocol link similar to chrome://. @See BrowserIdentifier

Referenced by

• UInternetBrowser

---

bSupportLocalhost

uint8 bSupportLocalhost

Defined in InternetBrowser.h:233 Support localhost and 127.0.0.1

Referenced by

• UInternetBrowser

---

BrowserIdentifier

FName BrowserIdentifier

Defined in InternetBrowser.h:237 [NOT YET IMPLEMENTED] An internal identifier used for browser urls. @See UInternetBrowser::GetBrowserProtocolLink()

Referenced by

• GetBrowserProtocolLink
• UInternetBrowser

---

InternetBrowserSaveGameClass

TSubclassOf< UInternetBrowserSaveGame > InternetBrowserSaveGameClass

Defined in InternetBrowser.h:241 Save game class for saving loading browser properties.

Referenced by

• UInternetBrowser

---

WhitelistWebsites

TArray< FString > WhitelistWebsites

Defined in InternetBrowser.h:245 If “Show Whitelist Only” is enabled then Web Browser will only allow to load web pages defined in this array. Accessing any web page not defined in this array will show error page.

Referenced by

• LoadURL

---

Bookmarks

TArray< FBrowserBookmark > Bookmarks

Defined in InternetBrowser.h:249 Browser bookmarks.

Referenced by

• AddBookmark
• RebuildWidget
• RemoveBookmark

---

BackButton

UButton * BackButton

Defined in InternetBrowser.h:252

Referenced by

• InitializeInternetBrowser

---

ForwardButton

UButton * ForwardButton

Defined in InternetBrowser.h:255

Referenced by

• InitializeInternetBrowser

---

ReloadButton

UButton * ReloadButton

Defined in InternetBrowser.h:258

Referenced by

• InitializeInternetBrowser

---

Addressbar

UEditableTextBox * Addressbar

Defined in InternetBrowser.h:261

Referenced by

• InitializeInternetBrowser
• LoadURL

---

WebBrowserWidget

TSharedPtr< SWebBrowser > WebBrowserWidget

Defined in InternetBrowser.h:263

Referenced by

• ExecuteJavascript
• GetAddressbarUrl
• GetTitleText
• GetUrl
• LoadString
• LoadURL
• RebuildWidget
• ReleaseSlateResources
• ReloadWebPage

---

LastLoadedURL

FString LastLoadedURL

Defined in InternetBrowser.h:266

Referenced by

• LoadURL

---

Cookie

FBrowserCookie Cookie

Defined in InternetBrowser.h:269

SavedBookmarks

TMap< FString, FString > SavedBookmarks

Defined in InternetBrowser.h:272