JUCE  v6.1.6 (6.0.8-1114)
JUCE API
Looking for a senior C++ dev?
I'm looking for work. Hire me!
juce::WebView2Preferences Class Reference

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>

Collaboration diagram for juce::WebView2Preferences:

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
 

Detailed Description

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}

Member Function Documentation

◆ getBackgroundColour()

Colour juce::WebView2Preferences::getBackgroundColour ( ) const
inline

◆ getDLLLocation()

File juce::WebView2Preferences::getDLLLocation ( ) const
inline

◆ getIsBuiltInErrorPageDisabled()

bool juce::WebView2Preferences::getIsBuiltInErrorPageDisabled ( ) const
inlinenoexcept

◆ getIsStatusBarDisabled()

bool juce::WebView2Preferences::getIsStatusBarDisabled ( ) const
inlinenoexcept

◆ getUserDataFolder()

File juce::WebView2Preferences::getUserDataFolder ( ) const
inline

◆ with()

template<typename Member , typename Item >
WebView2Preferences juce::WebView2Preferences::with ( Member &&  member,
Item &&  item 
) const
inlineprivate

◆ withBackgroundColour()

JUCE_NODISCARD WebView2Preferences juce::WebView2Preferences::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 transparent. On Windows 7 this colour must be opaque.

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

◆ withBuiltInErrorPageDisabled()

JUCE_NODISCARD WebView2Preferences juce::WebView2Preferences::withBuiltInErrorPageDisabled ( ) const
inline

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

References disableBuiltInErrorPage.

◆ withDLLLocation()

JUCE_NODISCARD WebView2Preferences juce::WebView2Preferences::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 dllLocation, and juce::gl::location.

◆ withStatusBarDisabled()

JUCE_NODISCARD WebView2Preferences juce::WebView2Preferences::withStatusBarDisabled ( ) const
inline

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

References disableStatusBar.

◆ withUserDataFolder()

WebView2Preferences juce::WebView2Preferences::withUserDataFolder ( const File folder) const
inline

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

References userDataFolder.

Member Data Documentation

◆ backgroundColour

Colour juce::WebView2Preferences::backgroundColour = Colours::white
private

Referenced by withBackgroundColour().

◆ disableBuiltInErrorPage

bool juce::WebView2Preferences::disableBuiltInErrorPage = false
private

◆ disableStatusBar

bool juce::WebView2Preferences::disableStatusBar = false
private

Referenced by withStatusBarDisabled().

◆ dllLocation

File juce::WebView2Preferences::dllLocation
private

Referenced by withDLLLocation().

◆ userDataFolder

File juce::WebView2Preferences::userDataFolder
private

Referenced by withUserDataFolder().


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