summaryrefslogtreecommitdiffstats
path: root/src/webenginequick/doc
Commit message (Collapse)AuthorAgeFilesLines
* Docs: Fix linking of WebEngineDownloadRequest::SavePageFormatMichal Klocek2025-10-301-2/+2
| | | | | | | | | Fix warning from qdoc, fix capitalization issues so links do work now. Pick-to: 6.10 Change-Id: Iafcf63e47bdcc4192059f19fcbf6fbee892482d8 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Add chlid frame to qml api of webengineframeMichal Klocek2025-10-281-0/+8
| | | | | | | | | It seems that children property was overlooked. Add it so it is posible to crawl the frame tree. Pick-to: 6.10 Change-Id: Ie4e13ccbc695a4db3782ce2c993c74ebb3d1cc9a Reviewed-by: Moss Heim <moss.heim@qt.io>
* Docs: Fix webEngineDesktopMediaRequest docsMichal Klocek2025-09-232-11/+12
| | | | | | | | | The underling type is now a qml value, update docs accordingly. Pick-to: 6.10 6.10.0 Change-Id: Ic25b5055802d1b1fe8dcc4a920e9a74d5d0f484f Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Doc: Fix type issues in WebEngineView QML docsKaloyan Chehlarski2025-09-101-9/+9
| | | | | | | | | | - QString -> string - QWebEngine... -> WebEngine... - Remove nonsense asterisks from method/signal parameter lists Pick-to: 6.10 Change-Id: I9ad262def8ab2a9513fb1b350e388e158a880269 Reviewed-by: Moss Heim <moss.heim@qt.io>
* Docs: Fix documentation for qml type valuesMichal Klocek2025-09-107-37/+45
| | | | | | | | | Go though our value types docs and fix the capitalization. Add missing qdoc tags. Change-Id: I856a870a333647e656f0b53cad684f806392c6ec Reviewed-by: Ulf Hermann <ulf.hermann@qt.io> Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
* Doc: Slightly reword recentlyAudibleChanged descriptionKaloyan Chehlarski2025-09-081-3/+2
| | | | | | Pick-to: 6.10 Change-Id: Iea3603e13439c0e9e205fc4d99698a49bb8c6c44 Reviewed-by: Jaishree Vyas <jaishree.vyas@qt.io>
* Doc: Minor comma fixesKaloyan Chehlarski2025-09-081-2/+2
| | | | | | Pick-to: 6.10 Change-Id: I1ed24289af08aad651c93a09cb342dc9e8b71349 Reviewed-by: Jaishree Vyas <jaishree.vyas@qt.io>
* Doc: Expand size() and contentSize() definitionsKaloyan Chehlarski2025-09-082-2/+7
| | | | | | | | | These now mention what units the return sizes are in, and what effects high-DPI displays have. Pick-to: 6.10 Change-Id: Icdf0a2c36116d360d5cc158793694422cb33b0cc Reviewed-by: Jaishree Vyas <jaishree.vyas@qt.io>
* Doc: Add [since X.X] tags to enums that are missing themKaloyan Chehlarski2025-09-081-72/+66
| | | | | | Pick-to: 6.10 Change-Id: Ie121e22e18ef61d4c9ecb6fa9085889e742fb7be Reviewed-by: Jaishree Vyas <jaishree.vyas@qt.io>
* Docs: Fix navigation between qml user script collection and web scriptMichal Klocek2025-09-011-10/+10
| | | | | | | | | | | | Use lower case for webEngineScript. Use correct 'qmlvaluetype' section. This amends 1eb2cb02f7ebdfc15a0d2ddc7837d4cffe073006. Fixes: QTBUG-139624 Pick-to: 6.10 6.9 Change-Id: I4766ac876401ac2937af33383dfad48a5f6d1498 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Doc: Expand some definitions in WebEngineHistory documentationKaloyan Chehlarski2025-08-251-3/+12
| | | | | | Pick-to: 6.10 Change-Id: I7cd6ab15d470321f8d830930d8e21e33a5a53be4 Reviewed-by: Jaishree Vyas <jaishree.vyas@qt.io>
* Doc: Synchronize some QML and Widgets documentationKaloyan Chehlarski2025-08-251-0/+13
| | | | | | | | | Copied over information that was only present on one side, but missing on the other. Pick-to: 6.10 Change-Id: I673cfdd7d3e86c1432d035e8902cb9e859e7fcda Reviewed-by: Jaishree Vyas <jaishree.vyas@qt.io>
* Doc: Mention Cmd/Ctrl instead of just CtrlKaloyan Chehlarski2025-08-251-1/+1
| | | | | | Pick-to: 6.10 Change-Id: I3275c5dc5c96aa32210972844f1ee65591ab028b Reviewed-by: Jaishree Vyas <jaishree.vyas@qt.io>
* Doc: Various punctuation fixesKaloyan Chehlarski2025-02-103-13/+12
| | | | | Change-Id: I65b22658eb46e2460e0bd8d82f528671b33fad66 Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
* Doc: Various typo fixesKaloyan Chehlarski2025-02-101-1/+1
| | | | | | Pick-to: 6.9 Change-Id: I3255a89539d23393ca1d0d7ebc440fe7e088d859 Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
* Doc: Fix QWebEngineDesktopMediaRequest documentationTopi Reinio2024-11-072-0/+78
| | | | | | | | | | | | | | - Add missing documentation for the QML type WebEngineDesktopMediaRequest. - Add missing documentation for the signals QWebEnginePage::desktopMediaRequested and WebEngineView::desktopMediaRequested. - Make some minor fixes to existing docs related to the type Pick-to: 6.8 Change-Id: I6fa824a9ac3c05a4e5aec259206bd00f64522e10 Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io> Reviewed-by: Safiyyah Moosa <safiyyah.moosa@qt.io>
* Permission manager: separate tracking of transient permissionsKaloyan Chehlarski2024-08-241-5/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Following the rewrite of the permissions API, transient (a.k.a non-persistent) permissions still passed through the persistent store sometimes, but were filtered out when using user-facing APIs. Unfortunately, thisstill presented some edge cases in the AskEveryTime permission policy mode. This change modifies the PermissionManagerQt class to store a second set of permissions, and associate them with a RenderFrameHost the way the Chromium API is designed to do anyway. This way, a permission will be kept around for the lifetime of a web page, and calling JavaScript APIs that trigger checks for permission state will work properly (e.g. navigator.mediaDevices.enumerateDevices). The new store is regularly cleaned up to make sure expired permissions are purged before they impact performance. As a side effect, this change also introduces pre-granting of non-persistent permissions, which was the biggest omission in the permissions rewrite. In those cases, the permissions will be temporarily stored inside the persistent store, and moved to the transient one the next time they're queried (and can thus be associated with a RenderFrameHost). This also fixes some extremely broken test cases that relied on invalid web API. Fixes: QTBUG-127951 Pick-to: 6.8 Change-Id: Ic084af7673ea0b255d98d94382e77323bb5e7ab0 Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
* Doc: Replace \instantiates with \nativetypePaul Wicking2024-08-2013-15/+15
| | | | | | | | | | | Since the implementation of the `\nativetype`-command in QDoc, the `\instantiates`-command is deprecated. Replace the use of the deprecated command in favor of its replacement. Pick-to: 6.8 Task-number: QTBUG-128216 Change-Id: I10cad9942e34301ded99c7014c1c70375e0698e1 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Doc: Document value types with \qmlvaluetypeTopi Reinio2024-08-083-3/+11
| | | | | | | | | | | As these types are value types, document them as such. Separate object and value types on the QML module page, and fix the incorrect \instantiates argument for webEngineFrame. Pick-to: 6.8 Change-Id: Ieb654efef0ede0eea7c10537d51cc040dc4e9935 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io> Reviewed-by: Moss Heim <moss.heim@qt.io>
* Doc: Fix linking warnings for Qt WebEngineTopi Reinio2024-07-311-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Fixes the following warnings: src/core/doc/src/qwebenginepage_lgpl.qdoc:464: (qdoc) warning: Can't link to 'QWebEnginePage::action(WebAction action)' src/core/api/qwebenginewebauthuxrequest.cpp:109: (qdoc) warning: Can't link to 'WebEngineWebAuthUxRequest.PinEntryReason.Challenge' src/core/api/qwebenginewebauthuxrequest.cpp:113: (qdoc) warning: Can't link to 'WebEngineWebAuthUxRequest.WebAuthUxState.CollectPin' src/core/api/qwebenginewebauthuxrequest.cpp:141: (qdoc) warning: Can't link to 'WebEngineWebAuthUxRequest.PinEntryReason.Challenge' src/webenginequick/api/qquickwebengineprofile.cpp:498: (qdoc) warning: Can't link to 'storageName()' src/webenginequick/api/qquickwebenginescriptcollection.cpp:119: (qdoc) warning: Undocumented return value src/webenginequick/doc/src/webengineview_lgpl.qdoc:879: (qdoc) warning: Can't link to 'WebEngineSettings::JavascriptCanPaste' src/webenginequick/doc/src/webengineview_lgpl.qdoc:880: (qdoc) warning: Can't link to 'WebEngineSettings::JavascriptCanAccessClipboard' In addition, drop remaining references to 'Pepper Plugin API' as that documentation was removed in 9d5f94b7f4b954bbe7e261d184420e237c704557. Pick-to: 6.8 Change-Id: I41fcddcc909b703705f2c32c2c3860872da60a72 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Fix typos in comments & docsMoss Heim2024-07-041-1/+1
| | | | | | | | | | | | | | | POINTER instead of ACTION in enum value names Correct type and name for WebEngineScript::runsOnSubFrames Correct return type for WebEngineScriptCollection::contains \sa notes in docs: insert and remove should point to each other, as should find and contains. This is closer to documentation for QList, QMap, etc. Change-Id: I1ac31fb53bd3fa53463f37e1bb4b6ef3b8fba65b Reviewed-by: Michal Klocek <michal.klocek@qt.io>
* QWebEnginePermission: Post-API reviewKaloyan Chehlarski2024-07-032-42/+51
| | | | | | | | | | | | | | | This commit contains fixes for the issues found during the API review of the new permissions API. In particular: - All new enums are now scoped - Replaced isTransient with its opposite, isPersistent - Renamed Feature to PermissionType - Made origin() return a non-const QUrl - Renamed PersistentPermissionsPolicy members to be more concise - Fixed a couple of bugs in the implementation - Updated documentation Change-Id: Idf84e1c9ba3ae803ef4686e1caa7f3e6c198c87d Reviewed-by: Michal Klocek <michal.klocek@qt.io>
* Add QWebEngineFrame::isMainFrame()Moss Heim2024-06-031-0/+6
| | | | | | Pick-to: 6.8 Change-Id: I5360ebc88aeff2189071c971e4f24a69e765686d Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
* Add QWebEnginePermission and rewrite permissions APIKaloyan Chehlarski2024-06-032-4/+152
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | With the addition of permission persistence, it's now important for us to have an API for querying previously granted/denied permissions, so that they can be revoked at a later point. This change does the bulk of the work to get us there, by introducing a new type representing a single permission for a given URL/Feature pair. This type holds no information about the permission's state; it is simply an accessor object which allows its user to query the current status of the permission, grant/deny it, or reset it back to its initial state (so, delete it from storage). This provides application developers an easy way to store/modify lists of permissions without having to define their own custom types. A subsequent change will expand the API to provide a list of all permissions for a given profile. The current API (in QWebEnginePage and QQuickWebEngineView) has been marked as deprecated, but has not been disabled to ensure a smooth transition for developers. [ChangeLog][QtWebEngineCore][QWebEnginePage] Deprecated old permissions API [ChangeLog][QtWebEngineQuick][WebEngineView] Deprecated old permissions API [ChangeLog][QtWebEngineCore] Added new API for querying and modifying website permissions. [ChangeLog][QtWebEngineQuick] Added new API for querying and modifying website permissions. Pick-to: 6.8 Change-Id: I8661cdc26bbd6dcde6403d29cc083bcea1a49ccc Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
* Add QWebEngineFrame::printToPdfMoss Heim2024-06-031-0/+24
| | | | | | | | | Provide API calls to (1) save to file (QString) and (2) get the bytes in a callback. Pick-to: 6.8 Change-Id: I0ff44a25328b99080491b8c3b36a7b632c065131 Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
* Docs: Fix typo in webEngineFrame::runJavaScriptMoss Heim2024-06-021-2/+2
| | | | | Change-Id: I0672706a7794bef592f746c3090ddae9f92b4705 Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
* Add QWebEnginePage::printRequestedByFrame signalMoss Heim2024-05-311-2/+15
| | | | | | | | | Emitted whenever a frame excluding the main frame calls JS print() function. `printRequested` is now only emitted when the main frame requests printing, instead of any frame. Change-Id: I4b65e5a164b513cc9a9692c1285470847b7a26e3 Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
* Add QWebEngineFrame::runJavaScriptMoss Heim2024-05-221-0/+34
| | | | | | | | | | | | | Run JavaScript code on a specific frame, optionally executing a callback when done. Uses the enclosing page's callback system. There are two sets of overloads, matching the API of QQuickWebEngineView and QWebEnginePage. Also adds QQuickWebEngineFrame::runJavaScript() Change-Id: I48746bd83d0f19644157548483a94637fc70c20f Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
* Add zoomFactorChanged signal to QWebEnginePage and QQuickWebEngineViewKaloyan Chehlarski2024-05-171-0/+9
| | | | | | | | | | | | | | Added a signal that fires whenever the zoom factor for a given page changes, including both via key combinations, and when using the existing zoom API. This already existed in Quick, but was both undocumented and only half-implemented (zooming via keyboard/mouse wouldn't trigger it). Thus, the Quick documentation was changed to list it as a 6.8 addition. Fixes: QTBUG-111041 Change-Id: I91eb7c9bf0d17d99956784841c5c86640554ad1c Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
* Add documentation for runJavaScript overloadMoss Heim2024-05-151-2/+6
| | | | | | | | This overload was added in WE1.3 but not documented until now Change-Id: I949f17d84a050762d51a0aacefbd8048c2536d64 Reviewed-by: Michal Klocek <michal.klocek@qt.io> Reviewed-by: <carl@carlschwan.eu>
* Add QML support for QWebEngineFrameMoss Heim2024-05-072-0/+82
| | | | | | Change-Id: I1f5843b1abba9edb3c106718abac5cd92ee961cd Reviewed-by: Ulf Hermann <ulf.hermann@qt.io> Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
* Add local fonts permission support to QuickWebEngineViewKaloyan Chehlarski2024-03-221-0/+3
| | | | | | | | | This change hooks up QuickWebEngineView to the newly-enabled local font access API. Task-number: QTBUG-121320 Change-Id: Ib7e093904ea8d834a2282cd265086e501cb392ff Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
* Fix typos in documentationMoss Heim2024-03-111-3/+3
| | | | | Change-Id: I315b985c31caa34be7a0a9980fcae60147b7c697 Reviewed-by: Michael Brüning <michael.bruning@qt.io>
* Add granular permission for clipboard-read/writeMoss Heim2024-03-111-0/+6
| | | | | | | | | | | | | | | Previously, permissions for clipboard access could only be managed through the JavascriptCanAccessClipboard and JavascriptCanPaste settings. This change allows copy/paste to be handled the same way as notification and geolocation permissions. If both JavascriptCanAccessClipboard and JavascriptCanPaste are enabled, permissions will be granted unconditionally without a feature request being made. Fixes: QTBUG-77450 Change-Id: I383e27e244ced3d6b7988644e38d2307c6267f76 Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
* Clarify meaning of baseUrl argument in setContentMoss Heim2024-02-051-3/+2
| | | | | | | | | | The previous wording made it sound as if baseUrl must always be non-empty, however this only affects external content relative URLs. Fixes: QTBUG-90927 Pick-to: 6.7 6.6 Change-Id: I0dff3368dec60b5734c1b12bbfe3f4aefc240e14 Reviewed-by: Michael Brüning <michael.bruning@qt.io>
* Correct PrintedPageSizeId to match QPageSize::PageSizeIdMichael Brüning2024-01-241-2/+0
| | | | | | | | | | With Qt 6, QPageSize::PageSizeId enum was cleaned up and some values were reordered, but the WebEngineQuick part was not changed accordingly. Pick-to: 6.7 6.6 6.5 Fixes: QTBUG-120218 Change-Id: I7e4c419750d30a64193e68b0b217ebbccce07d87 Reviewed-by: Michal Klocek <michal.klocek@qt.io>
* Update QWebEngineWebAuthUxRequest based on 6.7 API review commentAnu Aliyas2024-01-171-2/+2
| | | | | | | | | | | - Modified WebAuthUXState as enum class - Renamed QWebEngineWebAuthUXRequest as QWebEngineWebAuthUxRequest - Renamed QWebEngineWebAuthPINRequest as QWebEngineWebAuthPinRequest - Replaced all occurrence of UX and PIN with Ux and Pin respectively Fixes: 6.7 Change-Id: Iaf0b4c93e0dfa3508a604f7d6562c4401ff800af Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
* Doc: Remove \ingroup all-examples command from the docsJaishree Vyas2023-12-061-1/+0
| | | | | | | Task-number: QTBUG-115044 Pick-to: 6.5 6.6 Change-Id: I83314f3b7955e1ef9c857bcc96c07f6f90b2f875 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Fix print button of PDF viewer pluginSzabolcs David2023-07-291-2/+3
| | | | | | | | | | | Do not try to start print preview automatically, just notify the embedder via printRequested signal instead of crashing. Also fix the signal name in WebEngineView docs. Pick-to: 6.6 Task-number: QTBUG-104610 Change-Id: I251e0b8f6f03a73236320a66a0d3c7690939d88b Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
* Support FIDO2 user verificationAnu Aliyas2023-07-121-0/+12
| | | | | | | | | | | - Implemented AuthenticatorRequestClientDelegateQt support to handle authenticator requests. - Added FIDO user verification and resident credential support Fixes: QTBUG-90938 Fixes: QTBUG-90941 Change-Id: I6367791e1e9e8aaac27c376408377f838832f426 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Michael Brüning <michael.bruning@qt.io>
* Doc: Promote Qt6::WebEngine* cmake targetsKai Köhne2023-07-031-1/+1
| | | | | | | | | | Be consistent with the other modules, and promote Qt6:: targets instead of the (mostly functionally equivalent) Qt:: one's. Pick-to: 6.5 6.6 Change-Id: I4da0b7a29782d8927de5e5eafcaf934afb128937 Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
* Sync WebAction enums of QQuickWebEngineView/QWebEnginePageFriedemann Kleint2023-06-281-0/+1
| | | | | | | Pick-to: 6.6 Change-Id: Ibe750d541dba458f2278632355bcaf864fdc845a Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Michael Brüning <michael.bruning@qt.io>
* Doc: Fix documentation issuesTopi Reinio2023-06-101-1/+1
| | | | | | | | | | | * Replace \sa commands specific to section titles with 'See also' paragraphs. * Fix incorrectly named property WebEngineView::devToolsId Pick-to: 6.6 Change-Id: I7f823701c9bb0a1cb8e4a4449ccfc42a34391e99 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Add QWebEnginePage::devToolsId()Benjamin Terrier2023-05-311-0/+14
| | | | | | | | [ChangeLog][WebEngineCore] Add QWebEnginePage::devToolsId() [ChangeLog][WebEngineView] Add devToolsId property Change-Id: I16e8a27d595b010239557c2a3af2d3b39976cd46 Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
* Add WebEngineView::save() convenience APIAnu Aliyas2023-04-201-0/+19
| | | | | | | | | | Add the convenience method QQuickWebEngineView::save for saving pages without the need to explicitly handle download requests. Task-number: QTBUG-56093 Change-Id: I67909fdca6472d1ea9b32e0f89c1ab90219bca3b Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Michal Klocek <michal.klocek@qt.io>
* Replace WebEngineAction example with a snippetMichael Brüning2023-03-311-0/+123
| | | | | | | | | Also moves the example to the manual tests directory. Task-number: QTBUG-108751 Change-Id: Ie3fa492cfcaf61ee26ed65fa22954bb6a6532d6e Reviewed-by: Michael Brüning <michael.bruning@qt.io> (cherry picked from commit 23d1131577e1780de0552211a84357bcb1f63de5)
* Move custom touch handles example to manual testsMichal Klocek2023-03-221-0/+21
| | | | | | | | | | | | Move and add missing parts as snippet. Task-number: QTBUG-108751 Change-Id: I25849941700337626ca46e399fdb52264bc4659a Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Yigit Akcay <yigit.akcay@qt.io> (cherry picked from commit 55f9fc348278b2aa8985ec9c1e7e092f88f68f83) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Move quick minimal example to manual testsMichal Klocek2023-03-224-2/+47
| | | | | | | | Task-number: QTBUG-108751 Change-Id: I0998c46f051908855e0406e5fc7c0a422dc3eef0 Reviewed-by: Michal Klocek <michal.klocek@qt.io> (cherry picked from commit ed76eef004dbac15f4740d33d06d2b271bf770d4) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Doc: Fix wrong WebEngineCertificateError property nameAndreas Eliasson2023-03-011-2/+2
| | | | | | | | | The correct property name should be type, not error. Fixes: QTBUG-111574 Pick-to: 6.5 6.4 Change-Id: I276823f5bc664a99153b31e5bba36ae34608a9b9 Reviewed-by: Michal Klocek <michal.klocek@qt.io>
* Support LTR and RTL text directions in input fieldsSzabolcs David2023-02-151-0/+4
| | | | | | | | | | Implement WebActions to temporarily change text direction directly from context menu - like Chrome does. They only work for the selected input field. Omit the "default" option since it is always grayed out in Chrome. Task-number: QTWB-67 Change-Id: I4bacbd82c6bd7261ac465eec9da3776613f98074 Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>