diff options
Diffstat (limited to 'src/core/doc/src/qwebenginepage_lgpl.qdoc')
| -rw-r--r-- | src/core/doc/src/qwebenginepage_lgpl.qdoc | 186 |
1 files changed, 98 insertions, 88 deletions
diff --git a/src/core/doc/src/qwebenginepage_lgpl.qdoc b/src/core/doc/src/qwebenginepage_lgpl.qdoc index 43195deb2..c2515cd13 100644 --- a/src/core/doc/src/qwebenginepage_lgpl.qdoc +++ b/src/core/doc/src/qwebenginepage_lgpl.qdoc @@ -1,24 +1,8 @@ -/* - Copyright (C) 2019 The Qt Company Ltd. - Copyright (C) 2008, 2009, 2012 Nokia Corporation and/or its subsidiary(-ies) - Copyright (C) 2007 Staikos Computing Services Inc. - Copyright (C) 2007 Apple Inc. - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Library General Public - License as published by the Free Software Foundation; either - version 2 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Library General Public License for more details. - - You should have received a copy of the GNU Library General Public License - along with this library; see the file COPYING.LIB. If not, write to - the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, - Boston, MA 02110-1301, USA. -*/ +// Copyright (C) 2019 The Qt Company Ltd. +// Copyright (C) 2008, 2009, 2012 Nokia Corporation and/or its subsidiary(-ies) +// Copyright (C) 2007 Staikos Computing Services Inc. +// Copyright (C) 2007 Apple Inc. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only // The documentation in this file was imported from QtWebKit and is thus constrained // by its LGPL license. Documentation written from scratch for new methods should be @@ -131,85 +115,86 @@ should be enabled to get automatic focus. \value PasteAndMatchStyle Paste content from the clipboard with current style. - \value OpenLinkInThisWindow Open the current link in the current window. (Added in Qt 5.6) - \value OpenLinkInNewWindow Open the current link in a new window. Requires implementation of - \l createWindow() or \l newWindowRequested() (Added in Qt 5.6) - \value OpenLinkInNewTab Open the current link in a new tab. Requires implementation of - \l createWindow() or \l newWindowRequested(). (Added in Qt 5.6) - \value OpenLinkInNewBackgroundTab Open the current link in a new background tab. Requires - implementation of \l createWindow() or \l newWindowRequested(). (Added in Qt 5.7) - \value CopyLinkToClipboard Copy the current link to the clipboard. (Added in Qt 5.6) - - \value CopyImageToClipboard Copy the clicked image to the clipboard. (Added in Qt 5.6) - \value CopyImageUrlToClipboard Copy the clicked image's URL to the clipboard. (Added in Qt 5.6) - \value CopyMediaUrlToClipboard Copy the hovered audio or video's URL to the clipboard. (Added in Qt 5.6) - \value ToggleMediaControls Toggle between showing and hiding the controls for the hovered audio - or video element. (Added in Qt 5.6) - \value ToggleMediaLoop Toggle whether the hovered audio or video should loop on completetion or - not. (Added in Qt 5.6) - \value ToggleMediaPlayPause Toggle the play/pause state of the hovered audio or video element. - (Added in Qt 5.6) - \value ToggleMediaMute Mute or unmute the hovered audio or video element. (Added in Qt 5.6) - \value DownloadLinkToDisk Download the current link to the disk. Requires a slot for - \l{QWebEngineProfile::}{downloadRequested()}. (Added in Qt 5.6) - \value DownloadImageToDisk Download the highlighted image to the disk. Requires a slot for - \l{QWebEngineProfile::}{downloadRequested()}. (Added in Qt 5.6) - \value DownloadMediaToDisk Download the hovered audio or video to the disk. Requires a slot for - \l{QWebEngineProfile::}{downloadRequested()}. (Added in Qt 5.6) - - \value InspectElement Trigger any attached Web Inspector to inspect the highlighed element. - (Added in Qt 5.6) - \value ExitFullScreen Exit the fullscreen mode. (Added in Qt 5.6) - \value RequestClose Request to close the web page. If defined, the \c{window.onbeforeunload} + \value [since 5.6] OpenLinkInThisWindow Open the current link in the current window. + \value [since 5.6] OpenLinkInNewWindow Open the current link in a new window. Requires implementation of + \l createWindow() or \l newWindowRequested(). + \value [since 5.6] OpenLinkInNewTab Open the current link in a new tab. Requires implementation of + \l createWindow() or \l newWindowRequested(). + \value [since 5.7] OpenLinkInNewBackgroundTab Open the current link in a new background tab. Requires + implementation of \l createWindow() or \l newWindowRequested(). + \value [since 5.6] CopyLinkToClipboard Copy the current link to the clipboard. + + \value [since 5.6] CopyImageToClipboard Copy the clicked image to the clipboard. + \value [since 5.6] CopyImageUrlToClipboard Copy the clicked image's URL to the clipboard. + \value [since 5.6] CopyMediaUrlToClipboard Copy the hovered audio or video's URL to the clipboard. + \value [since 5.6] ToggleMediaControls Toggle between showing and hiding the controls for the hovered audio + or video element. + \value [since 5.6] ToggleMediaLoop Toggle whether the hovered audio or video should loop on completetion or + not. + \value [since 5.6] ToggleMediaPlayPause Toggle the play/pause state of the hovered audio or video element. + \value [since 5.6] ToggleMediaMute Mute or unmute the hovered audio or video element. + \value [since 5.6] DownloadLinkToDisk Download the current link to the disk. Requires a slot for + \l{QWebEngineProfile::}{downloadRequested()}. + \value [since 5.6] DownloadImageToDisk Download the highlighted image to the disk. Requires a slot for + \l{QWebEngineProfile::}{downloadRequested()}. + \value [since 5.6] DownloadMediaToDisk Download the hovered audio or video to the disk. Requires a slot for + \l{QWebEngineProfile::}{downloadRequested()}. + + \value [since 5.6] InspectElement Trigger any attached Web Inspector to inspect the highlighed element. + \value [since 5.6] ExitFullScreen Exit the fullscreen mode. + \value [since 5.6] RequestClose Request to close the web page. If defined, the \c{window.onbeforeunload} handler is run, and the user can confirm or reject to close the page. If the close - request is confirmed, \c windowCloseRequested is emitted. (Added in Qt 5.6) - \value Unselect Clear the current selection. (Added in Qt 5.7) - \value SavePage Save the current page to disk. MHTML is the default format that is used to store + request is confirmed, \c windowCloseRequested is emitted. + \value [since 5.7] Unselect Clear the current selection. + \value [since 5.7] SavePage Save the current page to disk. MHTML is the default format that is used to store the web page on disk. Requires a slot for \l{QWebEngineProfile::}{downloadRequested()}. - (Added in Qt 5.7) - \value ViewSource Show the source of the current page in a new tab. Requires implementation of - \l createWindow() or \l newWindowRequested(). (Added in Qt 5.8) + \value [since 5.8] ViewSource Show the source of the current page in a new tab. Requires implementation of + \l createWindow() or \l newWindowRequested(). - \value ToggleBold + \value [since 5.10] ToggleBold Toggles boldness for the selection or at the cursor position. - Requires \c contenteditable="true". (Added in Qt 5.10) - \value ToggleItalic + Requires \c contenteditable="true". + \value [since 5.10] ToggleItalic Toggles italics for the selection or at the cursor position. - Requires \c contenteditable="true". (Added in Qt 5.10) - \value ToggleUnderline + Requires \c contenteditable="true". + \value [since 5.10] ToggleUnderline Toggles underlining of the selection or at the cursor position. - Requires \c contenteditable="true". (Added in Qt 5.10) - \value ToggleStrikethrough + Requires \c contenteditable="true". + \value [since 5.10] ToggleStrikethrough Toggles striking through the selection or at the cursor position. - Requires \c contenteditable="true". (Added in Qt 5.10) + Requires \c contenteditable="true". - \value AlignLeft + \value [since 5.10] AlignLeft Aligns the lines containing the selection or the cursor to the left. - Requires \c contenteditable="true". (Added in Qt 5.10) - \value AlignCenter + Requires \c contenteditable="true". + \value [since 5.10] AlignCenter Aligns the lines containing the selection or the cursor at the center. - Requires \c contenteditable="true". (Added in Qt 5.10) - \value AlignRight + Requires \c contenteditable="true". + \value [since 5.10] AlignRight Aligns the lines containing the selection or the cursor to the right. - Requires \c contenteditable="true". (Added in Qt 5.10) - \value AlignJustified + Requires \c contenteditable="true". + \value [since 5.10] 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 Indent + Requires \c contenteditable="true". + \value [since 5.10] Indent Indents the lines containing the selection or the cursor. - Requires \c contenteditable="true". (Added in Qt 5.10) - \value Outdent + Requires \c contenteditable="true". + \value [since 5.10] Outdent Outdents the lines containing the selection or the cursor. - Requires \c contenteditable="true". (Added in Qt 5.10) + Requires \c contenteditable="true". - \value InsertOrderedList + \value [since 5.10] InsertOrderedList Inserts an ordered list at the current cursor position, deleting the current selection. - Requires \c contenteditable="true". (Added in Qt 5.10) - \value InsertUnorderedList + Requires \c contenteditable="true". + \value [since 5.10] InsertUnorderedList Inserts an unordered list at the current cursor position, deleting the current selection. - Requires \c contenteditable="true". (Added in Qt 5.10) + Requires \c contenteditable="true". + \value [since 6.6] ChangeTextDirectionLTR + Changes text direction to left-to-right in the focused input element. + \value [since 6.6] ChangeTextDirectionRTL + Changes text direction to right-to-left in the focused input element. \omitvalue WebActionCount */ @@ -225,8 +210,8 @@ A web browser tab. \value WebDialog A window without decoration. - \value WebBrowserBackgroundTab - A web browser tab without hiding the current visible WebEngineView. (Added in Qt 5.7) + \value [since 5.7] WebBrowserBackgroundTab + A web browser tab without hiding the current visible WebEngineView. */ /*! @@ -252,6 +237,8 @@ Return multiple file names. \value FileSelectUploadFolder Allows users to specify a single existing folder for upload. + \value FileSelectSave + Specify a new file to be created. \sa chooseFiles() */ @@ -278,7 +265,7 @@ \value NavigationTypeFormSubmitted The navigation request resulted from a form submission. \value NavigationTypeBackForward The navigation request resulted from a back or forward action. \value NavigationTypeReload The navigation request resulted from a reload action. - \value NavigationTypeRedirect The navigation request resulted from a content or server controlled redirect. This also includes automatic reloads. (Added in Qt 5.14) + \value [since 5.14] NavigationTypeRedirect The navigation request resulted from a content or server controlled redirect. This also includes automatic reloads. \value NavigationTypeOther The navigation request was triggered by other means not covered by the above. \sa acceptNavigationRequest() @@ -303,11 +290,18 @@ \value MouseLock Mouse locking, which locks the mouse pointer to the web view and is typically used in games. - \value DesktopVideoCapture + \value [since 5.10] DesktopVideoCapture Video output capture, that is, the capture of the user's display, - for screen sharing purposes for example. (Added in Qt 5.10) - \value DesktopAudioVideoCapture - Both audio and video output capture. (Added in Qt 5.10) + for screen sharing purposes for example. + \value [since 5.10] DesktopAudioVideoCapture + Both audio and video output capture. + \value [since 6.8] ClipboardReadWrite + Read and write access for the clipboard. If both \l{QWebEngineSettings::JavascriptCanPaste} + {JavascriptCanPaste} and \l{QWebEngineSettings::JavascriptCanAccessClipboard} + {JavascriptCanAccessClipboard} settings are enabled, this permission will always be granted + automatically and no feature requests will be made. + \value [since 6.8] LocalFontsAccess + Access to the fonts installed on the user's machine. Only available on desktop platforms. \sa featurePermissionRequested(), featurePermissionRequestCanceled(), setFeaturePermission(), PermissionPolicy @@ -465,6 +459,9 @@ The action is owned by the QWebEnginePage but you can customize the look by changing its properties. + \l{QWebEnginePage::action(WebAction action)} does not have a default styled icon. + Use \l{QWebEngineView::pageAction()} to have an action with a default styled icon. + QWebEnginePage also takes care of implementing the action, so that upon triggering the corresponding action is performed on the page. @@ -720,6 +717,7 @@ is empty, it is assumed that the content is \c{text/plain,charset=US-ASCII}. External objects referenced in the content are located relative to \a baseUrl. + For external objects with relative URLs to be loaded, \c baseUrl cannot be empty. The \a data is loaded immediately; external objects are loaded asynchronously. @@ -826,3 +824,15 @@ \sa url() */ + +/*! + \fn void QWebEnginePage::webAuthUxRequested(QWebEngineWebAuthUxRequest *request); + \since 6.7 + + This signal is emitted when a WebAuth authenticator needs user interaction + during the authentication process. These requests are handled by displaying a dialog to the user. + + The \a request contains the information and API required to complete the WebAuth UX request. + + \sa QWebEngineWebAuthUxRequest +*/ |