diff options
Diffstat (limited to 'src/webengine/doc/src')
| -rw-r--r-- | src/webengine/doc/src/qtwebengine-features.qdoc | 67 | ||||
| -rw-r--r-- | src/webengine/doc/src/qtwebengine-overview.qdoc | 2 | ||||
| -rw-r--r-- | src/webengine/doc/src/webengineview_lgpl.qdoc | 61 |
3 files changed, 103 insertions, 27 deletions
diff --git a/src/webengine/doc/src/qtwebengine-features.qdoc b/src/webengine/doc/src/qtwebengine-features.qdoc index 9e1979429..07d9269db 100644 --- a/src/webengine/doc/src/qtwebengine-features.qdoc +++ b/src/webengine/doc/src/qtwebengine-features.qdoc @@ -78,8 +78,8 @@ This feature can be tested by launching a Qt WebEngine application with the command line option \c {--remote-debugging-port=[your-port]} or by setting the environment variable \c QTWEBENGINE_REMOTE_DEBUGGING, and then using a - Chromium based browser (such as \l{WebEngine Demo Browser Example} - {Demo Browser} or \l{WebEngine Quick Nano Browser}{Nano Browser}) to connect + Chromium based browser (such as \l{WebEngine Widgets Simple Browser Example} + {Simple Browser} or \l{WebEngine Quick Nano Browser}{Nano Browser}) to connect to \c {http://localhost:[your-port]}. For more information, see \l {Qt WebEngine Debugging and Profiling}. @@ -90,8 +90,8 @@ This feature can be tested by opening an HTML5 drag and drop demo, such as \l{HTML5 Demos - Drag and Drop}, \l{HTML5 Demos - Simple Drag and Drop}, or - \l{HTML5 Demos - Drag and Drop, Automatic Upload}, in \l{WebEngine Demo - Browser Example}{Demo Browser} or \l{WebEngine Quick Nano Browser} + \l{HTML5 Demos - Drag and Drop, Automatic Upload}, in \l{WebEngine Widgets + Simple Browser Example}{Simple Browser} or \l{WebEngine Quick Nano Browser} {Nano Browser}. Dragging files into the browser is not actually part of HTML5, but it is @@ -109,7 +109,7 @@ QWebEnginePage::fullScreenRequested. This feature can be tested by playing a video from YouTube in \l{WebEngine - Demo Browser Example}{Demo Browser} or \l{WebEngine Quick Nano Browser} + Widgets Video Player Example}{Video Player} or \l{WebEngine Quick Nano Browser} {Nano Browser}, and clicking the full screen icon to go into fullscreen mode. @@ -124,8 +124,8 @@ proprietary audio and video codecs. For more information about enabling the codecs, see \l{Audio and Video Codecs}. - This feature can be tested by playing a video in \l{WebEngine Demo Browser - Example}{Demo Browser} or \l{WebEngine Quick Nano Browser}{Nano Browser} + This feature can be tested by playing a video in \l{WebEngine Widgets Simple Browser + Example}{Simple Browser} or \l{WebEngine Quick Nano Browser}{Nano Browser} from \l{castLabs}, \l{Swank Motion Pictures, Inc.}, or \l{Shaka Player}. Support for this feature was added in Qt 5.7.0. @@ -137,11 +137,11 @@ QWebEnginePage::Geolocation or \l{WebEngineView::Feature} {WebEngineView.Feature}. - This feature can be tested if Qt Location has been built before Qt WebEngine. - The \c http://html5demos.com/geo page can be opened in the \l{WebEngine Demo - Browser Example}{Demo Browser} and allowed to find the current position of - the user. Note that on Windows an external GPS receiver must be connected to - the application. For more information, see \l{Qt Positioning}. + If Qt Location has been built before Qt WebEngine then this feature can be + tested by using \l{WebEngine Widgets Maps Example}{Maps} and allowing it to + find the current position of the user. Note that on Windows an external GPS + receiver must be connected to the application. For more information, see + \l{Qt Positioning}. Support for this feature was added in Qt 5.5.0. @@ -254,7 +254,7 @@ --ppapi-flash-version=16.0.0.235 \endcode - This feature can be tested in \l{WebEngine Demo Browser Example}{Demo Browser} + This feature can be tested in \l{WebEngine Widgets Simple Browser Example}{Simple Browser} or \l{WebEngine Quick Nano Browser}{Nano Browser} if the Adobe Flash PPAPI plugin is installed and plugins are enabled in the browser. To test the feature, the \c https://helpx.adobe.com/flash-player.html page can be opened @@ -266,8 +266,8 @@ information, see QWebEnginePage::printToPdf() and \l{WebEngineView::printToPdf}{WebEngineView.printToPdf}. - This feature can be tested in \l{WebEngine Demo Browser Example} - {Demo Browser} by selecting \uicontrol File > \uicontrol {Print to PDF}. + This feature can be tested using \l{WebEngine Widgets Html2Pdf Example} + {Html2Pdf}. Support for this feature was added in Qt 5.7.0. @@ -294,9 +294,40 @@ These two files can be converted into the \c bdic format by using the \c qwebengine_convert_dict tool that is shipped together with Qt. When the Qt WebEngine spellchecker initializes, it will try to load the - \c bdict dictionaries and to check them for consistency. First, it searches - \e qtwebengine_dictionaries directories relative to the executable, - then it will look in \c QT_INSTALL_PREFIX/qtwebengine_dictionaries. + \c bdict dictionaries and to check them for consistency. + + If \c QTWEBENGINE_DICTIONARIES_PATH is set, the spellchecker uses the + dictionaries in the specified directory without looking anywere else. + Otherwise, it uses the \e qtwebengine_dictionaries directory relative to the + executable if it exists. If it does not exist, it will look in \c + QT_INSTALL_PREFIX/qtwebengines_dictionaries. + + On macOS, depending on how Qt WebEngine is configured at build time, there + are two possibilities how spellchecking data is found: + + \list + \li Hunspell dictionaries (default) - .bdic dictionaries are used, just + like on other platforms + \li Native dictionaries - the macOS spellchecking APIs are used (which + means the results will depend on the installed OS dictionaries) + \endlist + + Thus, in the macOS Hunspell case, Qt WebEngine will look in the \e + qtwebengine_dictionaries subdirectory located inside the application bundle + \c Resources directory, and also in the \c Resources directory located + inside the Qt framework bundle. + + To summarize, in case of Hunspell usage, the following paths are considered: + + \list + \li \c QTWEBENGINE_DICTIONARIES_PATH, if set + \li QCoreApplication::applicationDirPath()/qtwebengine_dictionaries + or QCoreApplication::applicationDirPath()/../Contents/Resources/qtwebengine_dictionaries + (on macOS) + \li [QLibraryInfo::DataPath]/qtwebengine_dictionaries + or path/to/QtWebEngineCore.framework/Resources/qtwebengine_dictionaries (Qt framework + bundle on macOS) + \endlist Spellchecking is disabled by default and can be enabled per profile by using the QWebEngineProfile::setSpellCheckEnabled() method in widget-based diff --git a/src/webengine/doc/src/qtwebengine-overview.qdoc b/src/webengine/doc/src/qtwebengine-overview.qdoc index e9ca573b7..904e4a551 100644 --- a/src/webengine/doc/src/qtwebengine-overview.qdoc +++ b/src/webengine/doc/src/qtwebengine-overview.qdoc @@ -89,7 +89,7 @@ \l{https://chromium.googlesource.com/chromium/src/+/master/docs/chromium_browser_vs_google_chrome.md}{overview} that is part of the documentation in the \l {Chromium Project} upstream source tree. - This version of Qt WebEngine is based on Chromium version 56.0.2924.122, with + This version of Qt WebEngine is based on Chromium version 61.0.3163.99, with additional security fixes from newer versions. \section2 Qt WebEngine Process diff --git a/src/webengine/doc/src/webengineview_lgpl.qdoc b/src/webengine/doc/src/webengineview_lgpl.qdoc index 27c3d6920..9cd7e3f27 100644 --- a/src/webengine/doc/src/webengineview_lgpl.qdoc +++ b/src/webengine/doc/src/webengineview_lgpl.qdoc @@ -86,7 +86,7 @@ focus on press. This can be useful in a hybrid UI. The \l {WebEngineSettings::focusOnNavigationEnabled} {focusOnNavigationEnabled} setting can be - used to stop the view from automatically receiving focus when a navigation operation occurs + used to make the view automatically receive focus when a navigation operation occurs (like loading or reloading a page or navigating through history). The \l linkHovered() signal is emitted when a mouse pointer passes over a link and thus @@ -112,7 +112,7 @@ A web page can request through the JavaScript API to be loaded in fullscreen mode. The \l fullScreenRequested() signal is emitted when the web page issues the request. The - WebEngineFullScreenRequest utility type can be used to toggle fullscreen requests. The + FullScreenRequest utility type can be used to toggle fullscreen requests. The \l fullScreenCancelled method can be used to notify the browser engine when the windowing system forces the application to leave fullscreen mode. @@ -576,7 +576,7 @@ */ /*! - \qmlsignal WebEngineView::fullScreenRequested(WebEngineFullScreenRequest request) + \qmlsignal WebEngineView::fullScreenRequested(FullScreenRequest request) \since QtWebEngine 1.1 This signal is emitted when the web page requests fullscreen mode through the @@ -793,6 +793,46 @@ \value WebEngineView.ViewSource Show the source of the current page in a new tab. (Added in Qt 5.8) + \value WebEngineView.ToggleBold + Toggles boldness for the selection or at the cursor position. + Requires \c contenteditable="true". (Added in Qt 5.10) + \value WebEngineView.ToggleItalic + Toggles italics for the selection or at the cursor position. + Requires \c contenteditable="true". (Added in Qt 5.10) + \value WebEngineView.ToggleUnderline + Toggles underlining of the selection or at the cursor position. + Requires \c contenteditable="true". (Added in Qt 5.10) + \value WebEngineView.ToggleStrikethrough + Toggles striking through the selection or at the cursor position. + Requires \c contenteditable="true". (Added in Qt 5.10) + + \value WebEngineView.AlignLeft + Aligns the lines containing the selection or the cursor to the left. + Requires \c contenteditable="true". (Added in Qt 5.10) + \value WebEngineView.AlignCenter + Aligns the lines containing the selection or the cursor at the center. + Requires \c contenteditable="true". (Added in Qt 5.10) + \value WebEngineView.AlignRight + Aligns the lines containing the selection or the cursor to the right. + Requires \c contenteditable="true". (Added in Qt 5.10) + \value WebEngineView.AlignJustified + Stretches the lines containing the selection or the cursor so that each + line has equal width. + Requires \c contenteditable="true". (Added in Qt 5.10) + \value WebEngineView.Indent + Indents the lines containing the selection or the cursor. + Requires \c contenteditable="true". (Added in Qt 5.10) + \value WebEngineView.Outdent + Outdents the lines containing the selection or the cursor. + Requires \c contenteditable="true". (Added in Qt 5.10) + + \value WebEngineView.InsertOrderedList + Inserts an ordered list at the current cursor position, deleting the current selection. + Requires \c contenteditable="true". (Added in Qt 5.10) + \value WebEngineView.InsertUnorderedList + Inserts an unordered list at the current cursor position, + deleting the current selection. + Requires \c contenteditable="true". (Added in Qt 5.10) \omitvalue WebActionCount */ @@ -810,6 +850,11 @@ Video devices, such as cameras. \value WebEngineView.MediaAudioVideoCapture Both audio and video capture devices. + \value DesktopVideoCapture + Video output capture, that is, the capture of the user's display. + (Added in Qt 5.10) + \value DesktopAudioVideoCapture + Both audio and video output capture. (Added in Qt 5.10) \sa featurePermissionRequested(), grantFeaturePermission() */ @@ -994,7 +1039,7 @@ */ /*! - \qmltype WebEngineFullScreenRequest + \qmltype FullScreenRequest \instantiates QQuickWebEngineFullScreenRequest \inqmlmodule QtWebEngine \since QtWebEngine 1.1 @@ -1005,13 +1050,13 @@ */ /*! - \qmlproperty url WebEngineFullScreenRequest::origin + \qmlproperty url FullScreenRequest::origin \readonly The URL of the web page that issued the fullscreen request. */ /*! - \qmlproperty bool WebEngineFullScreenRequest::toggleOn + \qmlproperty bool FullScreenRequest::toggleOn \readonly Returns \c{true} if the application should toggle fullscreen mode on, \c{false} otherwise. @@ -1020,7 +1065,7 @@ */ /*! - \qmlmethod void WebEngineFullScreenRequest::accept() + \qmlmethod void FullScreenRequest::accept() Call this method to accept the fullscreen request. It sets the WebEngineView::isFullScreen property to be equal to toggleOn. @@ -1044,7 +1089,7 @@ */ /*! - \qmlmethod void WebEngineFullScreenRequest::reject() + \qmlmethod void FullScreenRequest::reject() Rejects a fullscreen request. */ |