diff options
Diffstat (limited to 'src/core/doc/src/qtwebengine-platform-notes.qdoc')
| -rw-r--r-- | src/core/doc/src/qtwebengine-platform-notes.qdoc | 97 |
1 files changed, 42 insertions, 55 deletions
diff --git a/src/core/doc/src/qtwebengine-platform-notes.qdoc b/src/core/doc/src/qtwebengine-platform-notes.qdoc index c94262950..33bac101a 100644 --- a/src/core/doc/src/qtwebengine-platform-notes.qdoc +++ b/src/core/doc/src/qtwebengine-platform-notes.qdoc @@ -1,29 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2020 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:FDL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: https://www.gnu.org/licenses/fdl-1.3.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2020 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \page qtwebengine-platform-notes.html @@ -35,7 +11,7 @@ Static builds are not supported. - The requirements for building Qt 5 modules from source are listed separately for each supported + The requirements for building Qt modules from source are listed separately for each supported platform: \list @@ -53,19 +29,17 @@ \li \l {macOS} \endlist - The tests for skipping the \QWE build are located in the - \c qtwebengine repository, in the \c tools\qmake\mkspecs subdirectory. - They can be found by searching for \c skipBuild. - \section2 All Platforms On all platforms, the following tools are required at build time: \list - \li \l Python 2.7.5 or later. Python 3 is not supported. + \li C++20 compiler support + \li CMake 3.19 or newer + \li \l Python 3 with html5lib library \li Bison, Flex \li GPerf - \li Node.js version 8 or later (version 12 or later is recommended) + \li Node.js version 14 or later \endlist \section2 Windows @@ -73,22 +47,17 @@ On Windows, the following additional tools are required: \list - \li Visual Studio 2017 version 15.8 or later, or clang-cl version 8 or later + \li Visual Studio 2019 or later, or clang-cl version 10 or later \li Active Template Library (ATL), usually included in the Visual Studio installation - \li Windows 10 SDK version 10.0.19041 or later + \li Windows 11 SDK version 10.0.22621.0 or later \endlist - \QWE can only be built on 64-bit Windows, with a x64-bit toolchain. - For building \QWE for x86 applications, you need to configure - and compile Qt with the Visual Studio 2017 x64 to x86 cross-compile - toolchain. This toolchain can be set up on the command line by running - \c{vcvarsall.bat amd64_x86}. + \note It is not recommended to use tools from \c msys2 or \c cygwin to build \QWE as it may result in build errors. \section2 Linux - On Linux, Clang or GCC version 5 or later is required. - Supported configurations are \c linux-g++, \c{linux-clang} and \c{linux-clang-libc++} + On Linux, Clang or GCC version 9 or later is required. \QWE requires \c pkg-config to detect most of its dependencies. The following \c pkg-config files are required: @@ -111,16 +80,14 @@ \li \c xtst \endlist - Further, development packages for \c khr and \c libcap need to be installed. - \section2 \macos On \macos, the following are required: \list - \li \macos 10.13 or later - \li Xcode 10.0 or later - \li \macos 10.13 SDK or later + \li \macos 10.14 or later + \li Xcode 12.0 or later + \li \macos 11 SDK or later \endlist \note \QWE cannot be built for the 32-bit mode of \macos (using the @@ -129,8 +96,8 @@ \section1 Using Earlier Qt Versions to Build \QWE Building \QWE with earlier Qt versions (down to the last LTS - version) is supported. It means that \QWE 5.15 can be built with - Qt 5.12.x, Qt 5.14.x, and Qt 5.15. + version) is supported. It means that \QWE 6.4 can be built with + Qt 6.2.x, Qt 6.3.x, and Qt 6.4. To use an earlier Qt version to build Qt Webengine: @@ -221,16 +188,36 @@ or VoiceOver on \macos. \endlist - Due to some limitations, the Linux QPA plugin almost always reports that accessibility should - be activated. On big HTML pages, this can cause a significant slowdown in rendering speed. + On some old Linux configurations, accessibility can cause a significant slowdown + on large HTML pages. - Because of that, from Qt 5.9 onwards, \QWE accessibility support is disabled by default - on Linux. - It can be re-enabled by setting the \c QTWEBENGINE_ENABLE_LINUX_ACCESSIBILITY environment - variable to a non-empty value. + Because of that, \QWE accessibility support can be disabled on Linux, by setting the + \c QTWEBENGINE_ENABLE_LINUX_ACCESSIBILITY environment variable to 0. \section1 Popups in Fullscreen Applications on Windows Because of a limitation in the Windows compositor, applications that show a fullscreen web engine view will not properly display popups or other top-level windows. The reason and workaround is described in \l {Fullscreen OpenGL Based Windows}. + + \target windows_manifest + \section1 Windows Application Manifest + A manifest is an XML file that is read when the program starts and informs Windows how to run the program. + Some \QWE features may require adding a manifest file for the user application to work correctly on Windows. + + The following snippets show the manifest file's structure and how to embed it into the program. + + \note These code snippets are taken from the \l {WebEngine Quick Nano Browser} example. + + The manifest file defines which Windows versions the application supports. + \l {QWebEngineProfile::} {httpUserAgent} needs this information to report the correct Windows version. + \quotefile ../../../../examples/webenginequick/quicknanobrowser/quicknanobrowser.exe.manifest + + To embed the file into the executable, add it to the sources: + \quotefromfile ../../../../examples/webenginequick/quicknanobrowser/CMakeLists.txt + \skipto qt_add_executable + \dots + \printuntil endif + \dots + + For more information, see the \l {https://learn.microsoft.com/en-us/windows/win32/sbscs/application-manifests} {Application manifest documentation page}. */ |