juce::WebBrowserComponent::Options::WinWebView2 Class Reference

Options specific to the WebView2 backend. More...

#include <juce_WebBrowserComponent.h>

Collaboration diagram for juce::WebBrowserComponent::Options::WinWebView2:

Public Member Functions
Colour	getBackgroundColour () const
File	getDLLLocation () const
bool	getIsBuiltInErrorPageDisabled () const noexcept
bool	getIsStatusBarDisabled () const noexcept
File	getUserDataFolder () const
WinWebView2	withBackgroundColour (const Colour &colour) const
	Sets the background colour that WebView2 renders underneath all web content.
WinWebView2	withBuiltInErrorPageDisabled () const
	If this is set, a blank page will be displayed on error instead of the default built-in error page.
WinWebView2	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.
WinWebView2	withStatusBarDisabled () const
	If this is set, the status bar usually displayed in the lower-left of the webview will be disabled.
WinWebView2	withUserDataFolder (const File &folder) const
	Sets a non-default location for storing user data for the browser instance.

Private Attributes
Colour	backgroundColour
bool	disableBuiltInErrorPage = false
bool	disableStatusBar = false
File	dllLocation
File	userDataFolder

Detailed Description

Options specific to the WebView2 backend.

These options will be ignored if another backend is used.

Member Function Documentation

getBackgroundColour()

Colour juce::WebBrowserComponent::Options::WinWebView2::getBackgroundColour ( ) const

inline

getDLLLocation()

File juce::WebBrowserComponent::Options::WinWebView2::getDLLLocation ( ) const

inline

getIsBuiltInErrorPageDisabled()

bool juce::WebBrowserComponent::Options::WinWebView2::getIsBuiltInErrorPageDisabled ( ) const

inlinenoexcept

getIsStatusBarDisabled()

bool juce::WebBrowserComponent::Options::WinWebView2::getIsStatusBarDisabled ( ) const

inlinenoexcept

getUserDataFolder()

File juce::WebBrowserComponent::Options::WinWebView2::getUserDataFolder ( ) const

inline

withBackgroundColour()

WinWebView2 juce::WebBrowserComponent::Options::WinWebView2::withBackgroundColour ( const Colour &  colour ) const

inline

Sets the background colour that WebView2 renders underneath all web content.

This colour must either be fully opaque or fully transparent.

References juce::Colour::isOpaque(), juce::Colour::isTransparent(), jassert, and juce::withMember().

withBuiltInErrorPageDisabled()

WinWebView2 juce::WebBrowserComponent::Options::WinWebView2::withBuiltInErrorPageDisabled ( ) const

inline

If this is set, a blank page will be displayed on error instead of the default built-in error page.

References juce::withMember().

withDLLLocation()

WinWebView2 juce::WebBrowserComponent::Options::WinWebView2::withDLLLocation ( const File &  location ) const

inline

Sets a custom location for the WebView2Loader.dll that is not a part of the standard system DLL search paths.

References juce::withMember().

withStatusBarDisabled()

WinWebView2 juce::WebBrowserComponent::Options::WinWebView2::withStatusBarDisabled ( ) const

inline

If this is set, the status bar usually displayed in the lower-left of the webview will be disabled.

References juce::withMember().

withUserDataFolder()

WinWebView2 juce::WebBrowserComponent::Options::WinWebView2::withUserDataFolder ( const File &  folder ) const

inline

Sets a non-default location for storing user data for the browser instance.

In plugin projects you may find it necessary to use this option and specify a location such as File::SpecialLocationType::tempDirectory. Otherwise WebView2 may function incorrectly due to being denied access to the default user data location.

References juce::withMember().

Member Data Documentation

backgroundColour

Colour juce::WebBrowserComponent::Options::WinWebView2::backgroundColour

private

disableBuiltInErrorPage

bool juce::WebBrowserComponent::Options::WinWebView2::disableBuiltInErrorPage = false

private

disableStatusBar

bool juce::WebBrowserComponent::Options::WinWebView2::disableStatusBar = false

private

dllLocation

File juce::WebBrowserComponent::Options::WinWebView2::dllLocation

private

userDataFolder

File juce::WebBrowserComponent::Options::WinWebView2::userDataFolder

private

---

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

• juce_WebBrowserComponent.h