UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | List of all members
IWebBrowserModule Class Referenceabstract

#include <WebBrowserModule.h>

+ Inheritance diagram for IWebBrowserModule:

Public Member Functions

virtual bool CustomInitialize (const FWebBrowserInitSettings &WebBrowserInitSettings)=0
 
virtual IWebBrowserSingleton * GetSingleton ()=0
 
virtual bool IsWebModuleAvailable () const =0
 
- Public Member Functions inherited from IModuleInterface
virtual ~IModuleInterface ()
 
virtual void StartupModule ()
 
virtual void PreUnloadCallback ()
 
virtual void PostLoadCallback ()
 
virtual void ShutdownModule ()
 
virtual bool SupportsDynamicReloading ()
 
virtual bool SupportsAutomaticShutdown ()
 
virtual bool IsGameModule () const
 

Static Public Member Functions

static IWebBrowserModule & Get ()
 
static bool IsAvailable ()
 

Detailed Description

WebBrowserModule interface

Member Function Documentation

◆ CustomInitialize()

virtual bool IWebBrowserModule::CustomInitialize ( const FWebBrowserInitSettings &  WebBrowserInitSettings)
pure virtual

Customize initialization settings. You must call this before the first GetSingleton call, in order to override init settings.

Parameters
WebBrowserInitSettingsThe custom settings.
Returns
true if the settings were used to initialize the singleton. False if the call was ignored due to singleton already existing.

Implemented in FWebBrowserModule.

◆ Get()

static IWebBrowserModule & IWebBrowserModule::Get ( )
inlinestatic

Get or load the Web Browser Module

Returns
The loaded module

◆ GetSingleton()

virtual IWebBrowserSingleton * IWebBrowserModule::GetSingleton ( )
pure virtual

Get the Web Browser Singleton

Returns
The Web Browser Singleton

Implemented in FWebBrowserModule.

◆ IsAvailable()

static bool IWebBrowserModule::IsAvailable ( )
inlinestatic

Check whether the module has already been loaded

Returns
True if the module is loaded

◆ IsWebModuleAvailable()

virtual bool IWebBrowserModule::IsWebModuleAvailable ( ) const
pure virtual

Check whether the web module loaded its requirements successfully

Returns
True if the module load worked

Implemented in FWebBrowserModule.

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