PySide6.QtWebEngineCore.QWebEngineSettings

class QWebEngineSettings

The QWebEngineSettings class provides an object to store the settings used by QWebEnginePage . More…

Synopsis

Methods

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

QWebEngineSettings allows configuration of browser properties, such as font sizes and families, and generic attributes, such as JavaScript support. Individual attributes are set using the setAttribute() function. The WebAttribute enum further describes each attribute.

Each QWebEnginePage object has its own QWebEngineSettings object, which configures the settings for that page. If a setting is not configured for a web engine page, it is looked up in the settings of the profile the page belongs to.

class FontFamily

This enum describes the generic font families defined by CSS 2. For more information see the CSS standard .

Constant

Description

QWebEngineSettings.StandardFont

QWebEngineSettings.FixedFont

QWebEngineSettings.SerifFont

QWebEngineSettings.SansSerifFont

QWebEngineSettings.CursiveFont

QWebEngineSettings.FantasyFont

QWebEngineSettings.PictographFont

(added in Qt 5.7, deprecated Qt 6.4)
class WebAttribute

This enum type specifies settings for web pages:

Constant

Description

QWebEngineSettings.AutoLoadImages

Automatically dowloads images for web pages. When this setting is disabled, images are loaded from the cache. Enabled by default.

QWebEngineSettings.JavascriptEnabled

Enables the running of JavaScript programs in the MainWorld . Enabled by default.

QWebEngineSettings.JavascriptCanOpenWindows

Allows JavaScript programs to open popup windows without user interaction. Enabled by default.

QWebEngineSettings.JavascriptCanAccessClipboard

Allows JavaScript programs to write (copy) sanitized content to the clipboard. A sanitized write is done with the write and writeText JavaScript Clipboard API calls and must be accompanied by user action. Unsanitized writes, and reading from the clipboard, are enabled by JavascriptCanPaste. Prior to Chromium version 81, this setting enabled all clipboard writes. Since unrestricted clipboard access is a potential security concern, it is recommended that applications leave this disabled and instead respond to ClipboardReadWrite feature permission requests. Disabled by default.

QWebEngineSettings.LinksIncludedInFocusChain

Includes hyperlinks in the keyboard focus chain. Enabled by default.

QWebEngineSettings.LocalStorageEnabled

Enables support for the HTML 5 local storage feature. Enabled by default.

QWebEngineSettings.LocalContentCanAccessRemoteUrls

Allows local origin documents to access remote resources that would normally be blocked. Disabled by default. Note DnsPrefetchEnabled below operates independently of this setting, and can if enabled, cause remote accesses from local content.

QWebEngineSettings.XSSAuditingEnabled

Obsolete and has no effect.

QWebEngineSettings.SpatialNavigationEnabled

Enables the Spatial Navigation feature, which means the ability to navigate between focusable elements, such as hyperlinks and form controls, on a web page by using the Left, Right, Up and Down arrow keys. For example, if a user presses the Right key, heuristics determine whether there is an element they might be trying to reach towards the right and which element they probably want. Disabled by default.

QWebEngineSettings.LocalContentCanAccessFileUrls

Allows locally loaded documents to access other local URLs. Disabling this makes QtWebEngine behave more like Chrome and Firefox does by default. Enabled by default.

QWebEngineSettings.HyperlinkAuditingEnabled

Enables support for the ping attribute for hyperlinks. Disabled by default.

QWebEngineSettings.ScrollAnimatorEnabled

Enables animated scrolling. Disabled by default.

QWebEngineSettings.ErrorPageEnabled

Enables displaying the built-in error pages of Chromium. Enabled by default.

QWebEngineSettings.PluginsEnabled

Enables support for Pepper plugins, such as the Flash player. Disabled by default.

QWebEngineSettings.FullScreenSupportEnabled

Enables fullscreen support in an application. Disabled by default. (Added in Qt 5.6)

QWebEngineSettings.ScreenCaptureEnabled

Enables screen capture in an application. Disabled by default. (Added in Qt 5.7)

QWebEngineSettings.WebGLEnabled

Enables support for HTML 5 WebGL. Enabled by default if available. (Added in Qt 5.7)

QWebEngineSettings.Accelerated2dCanvasEnabled

Specifies whether the HTML5 2D canvas should be a OpenGL framebuffer. This makes many painting operations faster, but slows down pixel access. Enabled by default if available. (Added in Qt 5.7)

QWebEngineSettings.AutoLoadIconsForPage

Automatically downloads icons for web pages. Enabled by default. (Added in Qt 5.7)

QWebEngineSettings.TouchIconsEnabled

Enables support for touch icons and precomposed touch icons Disabled by default. (Added in Qt 5.7)

QWebEngineSettings.FocusOnNavigationEnabled

Gives focus to the view associated with the page, whenever a navigation operation occurs (load, stop, reload, reload and bypass cache, forward, backward, set content, and so on). Disabled by default. (Added in Qt 5.8)

QWebEngineSettings.PrintElementBackgrounds

Turns on printing of CSS backgrounds when printing a web page. Enabled by default. (Added in Qt 5.8)

QWebEngineSettings.AllowRunningInsecureContent

By default, HTTPS pages cannot run JavaScript, CSS, plugins or web-sockets from HTTP URLs. This provides an override to get the old insecure behavior. Disabled by default. (Added in Qt 5.8)

QWebEngineSettings.AllowGeolocationOnInsecureOrigins

Since Qt 5.7, only secure origins such as HTTPS have been able to request Geolocation features. This provides an override to allow non secure origins to access Geolocation again. Disabled by default. (Added in Qt 5.9)

QWebEngineSettings.AllowWindowActivationFromJavaScript

Allows activating windows by using the window.focus() JavaScript method. Disabled by default. (Added in Qt 5.10)

QWebEngineSettings.ShowScrollBars

Shows scroll bars. Enabled by default. (Added in Qt 5.10)

QWebEngineSettings.PlaybackRequiresUserGesture

Inhibits playback of media content until the user interacts with the page. By default, WebEngine uses Chromium settings, as described in Autoplay Policy Changes . This is similar to how Chrome on Android behaves, while the default behavior when it is disabled is similar to Chrome on desktops. To overwrite the default behavior, disable this setting. (Added in Qt 5.11)

QWebEngineSettings.JavascriptCanPaste

Allows JavaScript programs to read (paste) from the clipboard and to write unsanitized content. A sanitized write is done with the write and writeText JavaScript Clipboard API calls and must be accompanied by user action; unsanitized writes are any writes which do not meet these criteria. For this setting to have any effect, JavascriptCanAccessClipboard must also be enabled. Since unrestricted clipboard access is a potential security concern, it is recommended that applications leave this disabled and instead respond to ClipboardReadWrite feature permission requests. Disabled by default. (Added in Qt 5.11)

QWebEngineSettings.WebRTCPublicInterfacesOnly

Limits WebRTC to public IP addresses only. When disabled WebRTC may also use local network IP addresses, but remote hosts can also see your local network IP address. Disabled by default. (Added in Qt 5.11)

QWebEngineSettings.DnsPrefetchEnabled

Specifies whether WebEngine will try to pre-fetch DNS entries to speed up browsing. Disabled by default. (Added in Qt 5.12)

QWebEngineSettings.PdfViewerEnabled

Specifies that PDF documents will be opened in the internal PDF viewer instead of being downloaded. Enabled by default. (Added in Qt 5.13)

QWebEngineSettings.NavigateOnDropEnabled

Specifies that navigations can be triggered by dropping URLs on the view. Enabled by default. (Added in Qt 6.4)

QWebEngineSettings.ReadingFromCanvasEnabled

Specifies that reading from all canvas elements is enabled. This setting will have impact on all HTML5 canvas elements irrespective of origin, and can be disabled to prevent canvas fingerprinting. Enabled by default. (Added in Qt 6.6)

QWebEngineSettings.ForceDarkMode

Specifies that all web contents will be rendered using a dark theme. For more information, see Auto dark theme . Disabled by default. (Added in Qt 6.7)
class FontSize

This enum describes the font sizes configurable through QWebEngineSettings :

Constant

Description

QWebEngineSettings.MinimumFontSize

The hard minimum font size.

QWebEngineSettings.MinimumLogicalFontSize

The minimum logical font size that is applied when zooming out.

QWebEngineSettings.DefaultFontSize

The default font size for regular text.

QWebEngineSettings.DefaultFixedFontSize

The default font size for fixed-pitch text.
class UnknownUrlSchemePolicy

This enum describes how navigation requests to URLs with unknown schemes are handled.

Constant

Description

QWebEngineSettings.DisallowUnknownUrlSchemes

Disallows all navigation requests to URLs with unknown schemes.

QWebEngineSettings.AllowUnknownUrlSchemesFromUserInteraction

Allows navigation requests to URLs with unknown schemes that are issued from user-interaction (like a mouse-click), whereas other navigation requests (for example from JavaScript) are suppressed.

QWebEngineSettings.AllowAllUnknownUrlSchemes

Allows all navigation requests to URLs with unknown schemes.

See also

unknownUrlSchemePolicy setUnknownUrlSchemePolicy resetUnknownUrlSchemePolicy

class ImageAnimationPolicy

This enum describes how an image animation should be handled when the image frames are rendered for animation.

Constant

Description

QWebEngineSettings.ImageAnimationPolicy.Allow

Allows image animation when the image frames are rendered.

QWebEngineSettings.ImageAnimationPolicy.AnimateOnce

Animate the image once when the image frames are rendered.

QWebEngineSettings.ImageAnimationPolicy.Disallow

Disallows image animation when the image frames are rendered.

See also

imageAnimationPolicy setImageAnimationPolicy resetImageAnimationPolicy

Added in version 6.8.

defaultTextEncoding()
Return type:

str

Returns the default text encoding.

fontFamily(which)
Parameters:

which – FontFamily

Return type:

str

Returns the actual font family for the specified generic font family, which.

fontSize(type)
Parameters:

type – FontSize

Return type:

int

Returns the default font size for type in pixels.

See also

setFontSize()

imageAnimationPolicy()
Return type:

ImageAnimationPolicy

Returns the currently selected policy for handling image animation when the image frames are rendered. Default is Allow .

resetAttribute(attr)
Parameters:

attr – WebAttribute

Resets the setting of attribute to the value specified in the profile that the page belongs to.

resetFontFamily(which)
Parameters:

which – FontFamily

Resets the actual font family specified by which to the one specified in the profile that the page belongs to.

resetFontSize(type)
Parameters:

type – FontSize

Resets the font size for type to the size specified in the profile that the page belongs to.

resetImageAnimationPolicy()

Removes the policy for handling image animation.

resetUnknownUrlSchemePolicy()

Removes the policy for handling navigation requests to URLs with unknown schemes.

setAttribute(attr, on)
Parameters:

Enables or disables the specified attribute feature depending on the value of on.

setDefaultTextEncoding(encoding)
Parameters:

encoding – str

Specifies the default text encoding system.

The value of encoding must be a string describing an encoding such as “utf-8” or “iso-8859-1”. If left empty, a default value will be used. For a more extensive list of encoding names see QTextCodec.

setFontFamily(which, family)
Parameters:
setFontSize(type, size)
Parameters:

Sets the font size for type to size in pixels.

See also

fontSize()

setImageAnimationPolicy(policy)
Parameters:

policy – ImageAnimationPolicy

Sets the policy for handling image animation when the image frames are rendered to policy. Default is Allow .

setUnknownUrlSchemePolicy(policy)
Parameters:

policy – UnknownUrlSchemePolicy

Sets the policy for handling navigation requests to URLs with unknown schemes to policy. Default is AllowUnknownUrlSchemesFromUserInteraction .

testAttribute(attr)
Parameters:

attr – WebAttribute

Return type:

bool

Returns true if attribute is enabled; otherwise returns false.

unknownUrlSchemePolicy()
Return type:

UnknownUrlSchemePolicy

Returns the currently selected policy for handling navigation requests to URLs with unknown schemes. Default is AllowUnknownUrlSchemesFromUserInteraction .