diff options
Diffstat (limited to 'src/core/doc')
| -rw-r--r-- | src/core/doc/about_credits_entry.tmpl | 3 | ||||
| -rw-r--r-- | src/core/doc/src/qt_webengine_add_convert_dictionary.qdoc | 2 | ||||
| -rw-r--r-- | src/core/doc/src/qtwebengine-debugging.qdoc | 11 | ||||
| -rw-r--r-- | src/core/doc/src/qtwebengine-deploying.qdoc | 43 | ||||
| -rw-r--r-- | src/core/doc/src/qtwebengine-features.qdoc | 7 | ||||
| -rw-r--r-- | src/core/doc/src/qtwebengine-overview.qdoc | 2 | ||||
| -rw-r--r-- | src/core/doc/src/qtwebengine-platform-notes.qdoc | 8 | ||||
| -rw-r--r-- | src/core/doc/src/qwebengine-licensing.qdoc | 7 |
8 files changed, 70 insertions, 13 deletions
diff --git a/src/core/doc/about_credits_entry.tmpl b/src/core/doc/about_credits_entry.tmpl index 2bb9cff4e..aa94f2945 100644 --- a/src/core/doc/about_credits_entry.tmpl +++ b/src/core/doc/about_credits_entry.tmpl @@ -1,5 +1,6 @@ /*! -\page qtwebengine-3rdparty-{{name-sanitized}}.html attribution +\page qtwebengine-3rdparty-{{name-sanitized}}.html +\attribution \ingroup qtwebengine-licensing \brief {{license-type}} \title {{name}} diff --git a/src/core/doc/src/qt_webengine_add_convert_dictionary.qdoc b/src/core/doc/src/qt_webengine_add_convert_dictionary.qdoc index 74a3ecb48..6af681cc5 100644 --- a/src/core/doc/src/qt_webengine_add_convert_dictionary.qdoc +++ b/src/core/doc/src/qt_webengine_add_convert_dictionary.qdoc @@ -2,7 +2,7 @@ // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! -\page qt_add_webengine_dictionary.html +\page qt-add-webengine-dictionary.html \ingroup cmake-commands-qtwebenginecore \title qt_add_webengine_dictionary diff --git a/src/core/doc/src/qtwebengine-debugging.qdoc b/src/core/doc/src/qtwebengine-debugging.qdoc index 3599ec55e..3bb6a7029 100644 --- a/src/core/doc/src/qtwebengine-debugging.qdoc +++ b/src/core/doc/src/qtwebengine-debugging.qdoc @@ -92,6 +92,15 @@ QTWEBENGINE_CHROMIUM_FLAGS="--disable-logging" mybrowser \endcode - QTWEBENGINE_CHROMIUM_FLAGS can also be set using {qputenv} from within the + QTWEBENGINE_CHROMIUM_FLAGS can also be set using \c qputenv from within the application if called before QtWebEngineQuick::initialize(). + + \section1 Dump WebEngineContext Information + + For dumping the WebEngineContext information, you can set the \c QT_LOGGING_RULES + environment variable to \c "qt.webenginecontext.debug=true". + + The output contains information about the graphical backend, and the way how \QWE + is initialized for the application. This is particularly useful for reproducing + issues. */ diff --git a/src/core/doc/src/qtwebengine-deploying.qdoc b/src/core/doc/src/qtwebengine-deploying.qdoc index 3fb46a672..7504965e3 100644 --- a/src/core/doc/src/qtwebengine-deploying.qdoc +++ b/src/core/doc/src/qtwebengine-deploying.qdoc @@ -138,4 +138,47 @@ QTQUICK_COMPILER_SKIPPED_RESOURCES += resources/my_resource.qrc \endcode + \section2 \macos Specific Deployment Steps + + To deploy a \QWE application that accesses the microphone or camera + on \macos, you will need to provide texts for the messages that will be shown to the user to + explain why the application asks for permission to access to the camera or microphone. + To do this, add the texts to the application's \c Info.plist file using the keys + described below. + + For the camera usage message, provide a text using the following key: + \code + <key>NSCameraUsageDescription</key> + <string>Your message text for camera usage.</string> + \endcode + + \sa \l{https://developer.apple.com/documentation/bundleresources/information_property_list/nscamerausagedescription} {Apple's property list file documentation} + + For the microphone usage message, provide a text using the following key: + \code + <key>NSMicrophoneUsageDescription</key> + <string>Your message text for microphone usage.</string> + \endcode + + \sa \l{https://developer.apple.com/documentation/bundleresources/information_property_list/nsmicrophoneusagedescription} {Apple's property list file documentation} + + To notarize an application that accesses the camera or the microphone, + you will need to add the corresponding keys to your application's entitlements file used for + deployment and notarization. + + To enable access to the camera, add: + \code + <key>com.apple.security.device.camera</key> + <true/> + \endcode + + \sa \l{https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_security_device_camera} {Apple's camera entitlement documentation}. + + To enable access to the microphone, add: + \code + <key>com.apple.security.device.microphone</key> + <true/> + \endcode + + /sa \l{https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_security_device_microphone} {Apple's microphone entitlement documentation}. */ diff --git a/src/core/doc/src/qtwebengine-features.qdoc b/src/core/doc/src/qtwebengine-features.qdoc index a564641a5..3d6d0fea8 100644 --- a/src/core/doc/src/qtwebengine-features.qdoc +++ b/src/core/doc/src/qtwebengine-features.qdoc @@ -298,6 +298,12 @@ tested by using \l{WebEngine Widgets Maps Example}{Maps} and allowing it to find the current position of the user. + \note On Windows 11, enable settings to grant the maps example access to + Windows location services. In the Settings App under + \uicontrol {Privacy & Security} > \uicontrol {Location}, enable \uicontrol + {Location services}, \uicontrol {Let apps access your location} and \uicontrol + {Let desktop apps access your location}. + See \l{Qt Positioning} for a possible backend setup like the GPS or IP based positioning. Support for this feature was added in Qt 5.5.0. @@ -383,7 +389,6 @@ WebEngineView::colorDialogRequested(), WebEngineView::fileDialogRequested(), and WebEngineView::formValidationMessageRequested() signals. For an example, - see \l{WebEngine Qt Quick Custom Dialogs Example}. \section1 Pepper Plugin API diff --git a/src/core/doc/src/qtwebengine-overview.qdoc b/src/core/doc/src/qtwebengine-overview.qdoc index 2e1272404..b1e8ee3da 100644 --- a/src/core/doc/src/qtwebengine-overview.qdoc +++ b/src/core/doc/src/qtwebengine-overview.qdoc @@ -162,7 +162,7 @@ The following sample QML application loads a web page using the \l{WebEngineView::}{url} property: - \quotefromfile webenginequick/minimal/main.qml + \quotefromfile minimal/main.qml \skipto import \printuntil /^\}/ diff --git a/src/core/doc/src/qtwebengine-platform-notes.qdoc b/src/core/doc/src/qtwebengine-platform-notes.qdoc index 76f5bbfda..98873a2aa 100644 --- a/src/core/doc/src/qtwebengine-platform-notes.qdoc +++ b/src/core/doc/src/qtwebengine-platform-notes.qdoc @@ -52,13 +52,7 @@ \li Windows 10 SDK version 10.0.20348.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 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 form \c msys2 or \c cygwin to build \QWE as it may result in build errors. + \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 diff --git a/src/core/doc/src/qwebengine-licensing.qdoc b/src/core/doc/src/qwebengine-licensing.qdoc index 2b1bd2845..796a9664d 100644 --- a/src/core/doc/src/qwebengine-licensing.qdoc +++ b/src/core/doc/src/qwebengine-licensing.qdoc @@ -14,11 +14,16 @@ respect the licenses of Chromium, and third-party code included in Chromium. The arguably most restrictive license to be respected by all users is LGPLv2.1. +\note Any GPL licenses listed below are only used to access Linux system +resources. \QWE does not link to nor distribute GPL binary code, and +it does not affect users of \QWE. + Third party licenses included in the sources are: */ /*! -\page qtwebengine-3rdparty-chromium-global.html attribution +\page qtwebengine-3rdparty-chromium-global.html +\attribution \ingroup qtwebengine-licensing \title Chromium License \brief BSD |
