WebInterfaceBrowserModule.h
1.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
// Engine/Source/Runtime/WebBrowser/Public/WebBrowserModule.h
#pragma once
#include "CoreMinimal.h"
#include "Modules/ModuleInterface.h"
#include "Modules/ModuleManager.h"
class IWebInterfaceBrowserSingleton;
/**
* WebBrowser initialization settings, can be used to override default init behaviors.
*/
struct WEBBROWSERUI_API FWebInterfaceBrowserInitSettings
{
public:
/**
* Default constructor. Initializes all members with default behavior values.
*/
FWebInterfaceBrowserInitSettings();
// The string which is appended to the browser's user-agent value.
FString ProductVersion;
};
/**
* WebBrowserModule interface
*/
class IWebInterfaceBrowserModule : public IModuleInterface
{
public:
/**
* Get or load the Web Browser Module
*
* @return The loaded module
*/
static inline IWebInterfaceBrowserModule& Get()
{
return FModuleManager::LoadModuleChecked< IWebInterfaceBrowserModule >("WebBrowserUI");
}
/**
* Check whether the module has already been loaded
*
* @return True if the module is loaded
*/
static inline bool IsAvailable()
{
return FModuleManager::Get().IsModuleLoaded("WebBrowserUI");
}
/**
* Customize initialization settings. You must call this before the first GetSingleton call, in order to override init settings.
*
* @param WebBrowserInitSettings The custom settings.
* @return true if the settings were used to initialize the singleton. False if the call was ignored due to singleton already existing.
*/
virtual bool CustomInitialize(const FWebInterfaceBrowserInitSettings& WebBrowserInitSettings) = 0;
/**
* Get the Web Browser Singleton
*
* @return The Web Browser Singleton
*/
virtual IWebInterfaceBrowserSingleton* GetSingleton() = 0;
};