Qt WebEngine QML Types

To link against the module using build with qmake, add the following QT variable to your qmake .pro file:

QT += webenginequick

For build with CMake use the find_package() command to locate the needed module components in the Qt6 package and target_link_libraries() to link against the module:

find_package(Qt6 REQUIRED COMPONENTS WebEngineQuick)
target_link_libraries(target PRIVATE Qt6::WebEngineQuick)

The minimal amount of code needed to load and display an HTML page using the QML engine requires a proper initialization:

#include <QGuiApplication>
#include <QQmlApplicationEngine>
#include <QtWebEngineQuick/qtwebenginequickglobal.h>

int main(int argc, char *argv[])
{
    QCoreApplication::setAttribute(Qt::AA_ShareOpenGLContexts);
    QtWebEngineQuick::initialize();
    QGuiApplication app(argc, argv);
    QQmlApplicationEngine engine;
    engine.load(QUrl(QStringLiteral("qrc:/main.qml")));
    return app.exec();
}

Where the content of main.qml is simply:

import QtQuick
import QtQuick.Window
import QtWebEngine

Window {
    width: 1024
    height: 750
    visible: true
    WebEngineView {
        anchors.fill: parent
        url: "https://www.qt.io"
    }
}

AuthenticationDialogRequest

A request for providing authentication credentials required by proxies or HTTP servers

ColorDialogRequest

A request for selecting a color by the user

ContextMenuRequest

A request for showing a context menu

FileDialogRequest

A request for letting the user choose a (new or existing) file or directory

FindTextResult

A utility type for encapsulating the result of a string search on a page

FullScreenRequest

A utility type for the WebEngineView::fullScreenRequested() signal

JavaScriptDialogRequest

A request for showing an alert, a confirmation, or a prompt dialog from within JavaScript to the user

RegisterProtocolHandlerRequest

Type enables accepting or rejecting requests from the registerProtocolHandler API

TooltipRequest

A request for showing a tooltip to the user

TouchSelectionMenuRequest

A request for showing a touch selection menu

WebEngine

Provides access to the default settings and profiles shared by all web engine views

WebEngineAction

An action that represents a WebEngineView::WebAction

WebEngineCertificateError

A utility type for ignoring certificate errors or rejecting erroneous certificates

WebEngineClientCertificateOption

Represents a client certificate option

WebEngineClientCertificateSelection

Provides a selection of client certificates

WebEngineDownloadRequest

Provides information about a download

WebEngineHistory

Provides data models that represent the history of a web engine page

WebEngineHistoryModel

A data model that represents the history of a web engine page

WebEngineLoadingInfo

A utility type for the WebEngineView::loadingChanged signal

WebEngineNavigationRequest

Represents a request for navigating to a web page as part of WebEngineView::navigationRequested()

WebEngineNewWindowRequest

A utility type for the WebEngineView::newWindowRequested signal

WebEngineNotification

Encapsulates the data of an HTML5 web notification

WebEngineProfile

Contains settings, scripts, and visited links common to multiple web engine views

WebEngineScript

Enables the programmatic injection of scripts in the JavaScript engine

WebEngineScriptCollection

Manages a collection of user scripts

WebEngineSettings

Allows configuration of browser properties and attributes

WebEngineView

A WebEngineView renders web content within a QML application

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.