Class used to create a set of preferences to pass to the WindowsWebView2WebBrowserComponent wrapper constructor to modify aspects of its behaviour and settings. More...
#include <juce_WebBrowserComponent.h>
Public Member Functions | |
Colour | getBackgroundColour () const |
File | getDLLLocation () const |
bool | getIsBuiltInErrorPageDisabled () const noexcept |
bool | getIsStatusBarDisabled () const noexcept |
File | getUserDataFolder () const |
JUCE_NODISCARD WebView2Preferences | withBackgroundColour (const Colour &colour) const |
Sets the background colour that WebView2 renders underneath all web content. More... | |
JUCE_NODISCARD WebView2Preferences | withBuiltInErrorPageDisabled () const |
If this is set, a blank page will be displayed on error instead of the default built-in error page. More... | |
JUCE_NODISCARD WebView2Preferences | withDLLLocation (const File &location) const |
Sets a custom location for the WebView2Loader.dll that is not a part of the standard system DLL search paths. More... | |
JUCE_NODISCARD WebView2Preferences | withStatusBarDisabled () const |
If this is set, the status bar usually displayed in the lower-left of the webview will be disabled. More... | |
WebView2Preferences | withUserDataFolder (const File &folder) const |
Sets a non-default location for storing user data for the browser instance. More... | |
Private Member Functions | |
template<typename Member , typename Item > | |
WebView2Preferences | with (Member &&member, Item &&item) const |
Private Attributes | |
Colour | backgroundColour = Colours::white |
bool | disableBuiltInErrorPage = false |
bool | disableStatusBar = false |
File | dllLocation |
File | userDataFolder |
Class used to create a set of preferences to pass to the WindowsWebView2WebBrowserComponent wrapper constructor to modify aspects of its behaviour and settings.
You can chain together a series of calls to this class's methods to create a set of whatever preferences you want to specify.
@tags{GUI}
|
inline |
|
inline |
|
inlinenoexcept |
|
inlinenoexcept |
|
inline |
|
inlineprivate |
|
inline |
Sets the background colour that WebView2 renders underneath all web content.
This colour must either be fully opaque or transparent. On Windows 7 this colour must be opaque.
References backgroundColour, juce::Colour::isOpaque(), juce::Colour::isTransparent(), and jassert.
|
inline |
If this is set, a blank page will be displayed on error instead of the default built-in error page.
References disableBuiltInErrorPage.
|
inline |
Sets a custom location for the WebView2Loader.dll that is not a part of the standard system DLL search paths.
References dllLocation, and juce::gl::location.
|
inline |
If this is set, the status bar usually displayed in the lower-left of the webview will be disabled.
References disableStatusBar.
|
inline |
Sets a non-default location for storing user data for the browser instance.
References userDataFolder.
|
private |
Referenced by withBackgroundColour().
|
private |
Referenced by withBuiltInErrorPageDisabled().
|
private |
Referenced by withStatusBarDisabled().
|
private |
Referenced by withDLLLocation().
|
private |
Referenced by withUserDataFolder().