Qt WebEngine Reference Documentation

Global Qt WebEngine Core Declarations

@puppeteer/replay

@vscode/web-custom-data

AXE-CORE Accessibility Audit

Abseil

Acorn, a tiny, fast JavaScript parser written in JavaScript.

Akamai HTTP/2 Demo

Alliance for Open Media Video Codec

Almost Native Graphics Layer Engine

Autoplay Policy Changes

Bitmovin Player

Blackmagic DeckLink SDK - Mac

BoringSSL

Brotli

C++ Signal/Slot Library

CRC32C

CSP Evaluator Core Library, a tool that allows developers to check if a Content Security Policy (CSP) serves as mitigation against XSS attacks

Changes to Qt WebEngine

Moved Classes

The Qt WebEngine module

Classes moved from Qt WebEngineWidgets to Qt WebEngineCore

Classes moved with minimal changes

QWebEngineCertificateError

QWebEngineContextMenuData

QWebEngineDownloadItem

QWebEnginePage

Classes moved from Qt WebEngineQuick to Qt WebEngineCore

WebEngineNavigationRequest

WebEngineNewViewRequest

Changed API

C++

QWebEnginePage::certificateError()

QWebEnginePage::print()

QWebEnginePage::view()

QWebEngineProfile::defaultProfile()

QML

WebEngineNavigationRequest

WebEngineNewViewRequest

Changed Behavior

Default Profile

QRC Scheme

OCSP Certificate Revocation Checking

Chrome DevTools

Chrome console API

Chromium License

Chromium Project

CodeMirror 5

CodeMirror 6

Compact Encoding Detection

Compact Language Detector v3

Crashpad

Dawn

Deploying Qt WebEngine Applications

Target Platforms

Deploying Applications Manually

Deploying Libraries

Deploying QML Imports

Deploying Qt WebEngine Processes

Deploying Resources

Translations

JavaScript Files in Qt Resource Files

macOS Specific Deployment Steps

Devtools-Frontend

Emoji Segmenter

Expat XML Parser

FFmpeg

FP16

FXDiv

Fiat-Crypto: Synthesizing Correct-by-Construction Code for Cryptographic Primitives

FlatBuffers

FreeType

General Purpose FFT (Fast Fourier/Cosine/Sine Transform) Package

Google Double Conversion

Greasemonkey

HTML5 Demos - Drag and Drop

HTML5 Demos - Drag and Drop, Automatic Upload

HTML5 Demos - File API

HTML5 Demos - Simple Drag and Drop

HTTP/2

Headers for the Windows 10 WebAuthn API (webauthn.dll)

Highway: C++ library for SIMD

Hunspell Project

LevelDB: A Fast Persistent Key-Value Store

Lighthouse

Lighthouse i18n.js

Lit

Lit

Markdown.css (WebEngine Recipe Browser example), version 188530e4b5d020d7e237fc6b26be13ebf4a8def3

Marked

Marked (WebEngine Recipe Browser example), version 0.4.0

Material color utilities

Metadata Block

Metrics Protos

NA

OTS (OpenType Sanitizer)

One Euro Filter

OpenH264 Project Homepage

PDFium

PFFFT: a pretty fast FFT.

Perfetto

Polymer

Porting from Qt WebKit to Qt WebEngine

Architecture

Class Names

Qt Module Name

In qmake Project Files

Including the Module in Source Files

QWebFrame Has Been Merged into QWebEnginePage

Some Methods Now Return Their Result Asynchronously

Qt WebEngine Does Not Interact with QNetworkAccessManager

Notes About Individual Methods

evaluateJavaScript

setHtml and setContent

setContentEditable

Unavailable Qt WebKit API

Protocol Buffers

Puppeteer Core

QUICHE

Qt WebEngine

Articles and Guides

Module Evolution

Examples

API References

Qt WebEngine C++ Classes and Namespaces

Namespaces

Classes

Qt WebEngine Core Module

Qt WebEngine Widgets Module

Qt WebEngine Quick Module

Qt WebEngine Core

Getting Started

Articles and Guides

API Reference

License Information

Qt WebEngine Debugging and Profiling

Console Logging

Qt WebEngine Developer Tools

Using Command-Line Arguments

Dump WebEngineContext Information

Qt WebEngine Features

webrtc_feature

Audio and Video Codecs

WebEngineDriver

Chromium DevTools

Client Certificates

Custom Schemes

Drag and Drop

Favicon

QML Favicon Handling

C++ Favicon Handling

Fullscreen

Hardware Acceleration

HTML5 DRM

HTML5 Geolocation

HTML5 WebSockets

HTTP/2 Protocol

Local Storage

Native Dialogs

PDF File Viewing

Page Lifecycle API

Overview of Lifecycle States

The lifecycleState and recommendedState Properties

The DOM Extensions

Print to PDF

Process Models

Process per Site Instance

Process per Site

Single Process

Spellchecker

Touch

View Source

Web Notifications

WebGL

WebRTC

Qt WebEngine Overview

Qt WebEngine Architecture

Qt WebEngine Widgets Module

Qt WebEngine Module

Qt WebEngine Core Module

Qt WebEngine Process

Embedding Web Content into Widget Based Applications

Embedding Web Content into Qt Quick Applications

Script Injection

Managing Certificates

Proxy Support

High DPI Support

Using WebEngine Core

Platform Notes

Related Modules

Qt WebEngine Platform Notes

windows_manifest

Building Qt WebEngine from Source

All Platforms

Windows

Linux

macOS

Using Earlier Qt Versions to Build Qt WebEngine

Mac App Store Compatibility

macOS Airplay Support on MacBooks with Dual GPUs

Default QSurfaceFormat OpenGL Profile Support

Sandboxing Support

Memory Requirements in Docker Environment

Accessibility and Performance

Popups in Fullscreen Applications on Windows

Windows Application Manifest

Qt WebEngine Widgets

Getting Started

Articles and Guides

Examples

API Reference

License Information

QtWebEngine Namespace

RFC 2616 section 19.5.1

Recipe Browser

Running the Example

Exposing Document Text

Creating the Main Window

Working With Stylesheets

Creating a recipe file

Files and Attributions

Recurrent neural network for audio noise reduction

Snappy: A fast compressor/decompressor

Sudden Motion Sensor library

Swank Motion Pictures, Inc.

Tango Icon Library, version 0.8.90

Tango Icon Library, version 0.8.90

Tango Icon Library, version 0.8.90

Tango Icon Library, version 0.8.90

The Chromium Project

The Diff Match and Patch libraries offer robust algorithms to perform the operations required for synchronizing plain text.

The Incremental Distributed Point Functions library

This is the canonical public repository

URL Pattern Library

User Scripts

V8 fork of fdlibm

Vulkan Deps

VulkanMemoryAllocator

Wasmparser

Web Notifications API

WebEngine Content Manipulation Example

Running the Example

MainWindow Class Definition

MainWindow Class Implementation

WebEngine Cookie Browser Example

Running the Example

Files and Attributions

WebEngine Lifecycle Example

Running the Example

UI Elements of the Example

Lifecycle States in the Example

Manual Lifecycle Control

Automatic Lifecycle Control

WebEngine Notifications Example

Running the Example

HTML Page

Main Function

Requesting Feature Permissions

Handling New Notifications

Presenting Notifications to Users

Presenting Notifications

Closing Active Notification

Implementing User Interaction

WebEngine Push Notifications Example

WebEngine Quick Nano Browser

Running the Example

Creating the Main Browser Window

Handling Certificate Errors

Handling Permission Requests

Entering and Leaving Fullscreen Mode

Handling WebAuth/FIDO UX Requests

Signing Requirement for macOS

Files and Attributions

WebEngine Widgets Client Certificate Example

Creating Certificates

Implementing the Client

Implementing the Server

WebEngine Widgets Html2Pdf Example

Running the Example

The Conversion Process

The Main Function

WebEngine Widgets Maps Example

Running the Example

The Code

WebEngine Widgets Permission Browser Example

PermissionWidgetConstructor

Running the Example

Class Definitions

MainWindow

PermissionWidget and PermissionDialog

Handling incoming permission requests

Modifying a permission and displaying it to the user

Displaying and modifying existing permissions

Pre-granting permissions

Changing the permission persistence policy

WebEngine Widgets PrintMe Example

Running the Example

Simple HTML Page

Main Function

Print Handler

WebEngine Widgets Simple Browser Example

Running the Example

Class Hierarchy

Creating the Browser Main Window

Creating Tabs

Closing Tabs

Implementing WebView Functionality

Displaying Error Messages

Managing WebWindows

Adding Context Menu Items

Implementing WebPage and WebView Functionality

Opening a Web Page

Implementing Private Browsing

Managing Downloads

Managing WebAuth/FIDO UX Requests

Signing Requirement for macOS

Files and Attributions

WebEngine Widgets Spellchecker Example

Running the Example

Dictionaries

Setting the Spellchecker

Switching the Spellchecking Language

WebEngine Widgets Video Player Example

Running the Example

Overview

MainWindow Class Declaration

MainWindow Class Definition

FullScreenWindow Class Declaration

FullScreenWindow Class Definition

FullScreenNotification Class Declaration

FullScreenWindow Class Definition

WebKit

WebM container parser and writer.

WebP image encoder/decoder

WebRTC

Widevine CDM

Wuffs (Wrangling Untrusted File Formats Safely)

XNNPACK

Zstandard

castLabs

cpuinfo

d3

dav1d is an AV1 decoder :)

dynamic annotations

ffmpeg

flac

google-jstemplate

harfbuzz-ng

hunspell

icu

inspector protocol

inspector protocol

intl-messageformat

ipcz

jsoncpp

libaddressinput

libavif - Library for encoding and decoding .avif files

libavif - Library for extracting metadata from .avif files

libgav1

libjpeg-turbo

libpng

libsrtp

libusbx

libvpx

libxml

libxslt

libyuv

mesa_headers

modp base64 decoder

opus

pthreadpool

qt_add_webengine_dictionary

qt6_add_webengine_dictionary

Synopsis

Description

Arguments

re2 - an efficient, principled regular expression library

registerProtocolHandler

source.chromium.org/chromium/chromium/src/+/master:v8/src/base/ieee754.cc

sql sqrt floor

sqlite

view-source URI scheme

woff2

zlib

AuthenticationDialogRequest

ColorDialogRequest

ContextMenuRequest

FileDialogRequest

FindTextResult

FullScreenRequest

JavaScriptDialogRequest

QuotaRequest

RegisterProtocolHandlerRequest

TooltipRequest

TouchSelectionMenuRequest

WebEngine

WebEngineAction

WebEngineCertificateError

WebEngineClientCertificateOption

WebEngineClientCertificateSelection

WebEngineDesktopMediaRequest

WebEngineDownloadRequest

Object Life Cycle

Web Page Downloads

WebEngineHistory

WebEngineHistoryModel

WebEngineLoadingInfo

WebEngineNavigationRequest

WebEngineNewWindowRequest

WebEngineNotification

WebEngineProfile

WebEngineScript

WebEngineScriptCollection

WebEngineSettings

WebEngineView

Initializing Web Engine

Loading Web Pages

Interaction

User Scripts

Fullscreen Mode

Profiles

Platform Features

Rendering to OpenGL Surface

WebEngineWebAuthUxRequest

webEngineFrame

webEnginePermission

webEngineWebAuthPinRequest

Qt WebEngine Licensing

Complying with LGPL 2.1

Third-Party Licenses

Qt WebEngine Quick Examples

Qt WebEngine Widgets Examples

Qt WebEngine Core C++ Classes

Qt WebEngine Quick C++ Classes

Qt WebEngine Widgets C++ Classes

Qt WebEngine QML Types

QML object types

QML value types