summaryrefslogtreecommitdiffstats
path: root/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc
Commit message (Collapse)AuthorAgeFilesLines
* Clarify meaning of baseUrl argument in setContentMoss Heim2024-02-051-4/+3
| | | | | | | | | | 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>
* Add default styled icons to actionsAnu Aliyas2024-01-061-0/+1
| | | | | | | | | - Added a default icon to action using the newly introduced QWebEngineViewPrivate::webActionIcon() Fixes: QTBUG-119722 Pick-to: 6.6 6.7 Change-Id: I4ee9b4380ead80d991756147bfef40f0f17c0849 Reviewed-by: Michal Klocek <michal.klocek@qt.io>
* Docs: Fix "Can't link to" example warningsSafiyyah Moosa2023-05-101-1/+1
| | | | | | | Task-number: QTBUG-113160 Pick-to: 6.5 Change-Id: Ic987711802db7eb32cdb15ac9f313d2203984981 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Merge recipe browser, stylesheet browser and markdown editor examplesYigit Akcay2023-04-051-1/+1
| | | | | | | | | | This patch merges the qtwebengine examples recipe browser, stylesheet browser and markdown editor into one single example. Pick-to: 6.5 Task-number: QTBUG-108751 Change-Id: I338707d7d3275b03bf2a2d7b65064ac91e562d7f Reviewed-by: Michal Klocek <michal.klocek@qt.io>
* Use SPDX license identifiersLucie Gérard2022-07-081-21/+5
| | | | | | | | | | | Ammend 9b9d789fcb8f63a8998f1eefe44f2a1c8156c362 : some files were still missing SPDX headers Pick-to: 6.4 Task-number: QTBUG-67283 Task-number: QTBUG-104589 Change-Id: Ia4d2aae636bbdb1a99c422e3b8d3f097c3af34d6 Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* Update parameters to findText callbackAllan Sandfeld Jensen2021-07-131-3/+2
| | | | | | | Pick-to: 6.2 Change-Id: I622ff55c1c9b6f9d4818228c75543c3deffa37be Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Peter Varga <pvarga@inf.u-szeged.hu>
* Doc: Fix documentation issues for Qt WebEngineTopi Reinio2021-07-011-2/+0
| | | | | | | | | | API and documentation changes since 5.15 caused multiple warnings from QDoc; this change addresses most of them. Some warnings indicate missing documentation, those issues still remain. Pick-to: 6.2 Change-Id: I96be38b7daac37a7e35c149b4b3ec3f18c4415c9 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Switch QWebEnginePage::findText() to std::functionAllan Sandfeld Jensen2021-06-101-1/+1
| | | | | | | | | Leaving further API modification for later Pick-to: 6.2 Task-number: QTBUG-63235 Change-Id: I75367ee5d4ce071abaeed361d2dc27c64fb6dd8a Reviewed-by: Peter Varga <pvarga@inf.u-szeged.hu>
* Remove usages of deprecated APIsSona Kurazyan2019-09-091-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | - Replaced the following deprecated APIs: QWebEngineProfile::setRequestInterceptor -> QWebEngineProfile::setUrlRequestInterceptor QWebEngineSettings::globalSettings -> WebEngineSettings::defaultSettings QLayout::setMargin -> QLayout::setContentsMargins QWheelEvent::{x, y} -> QWheelEvent::position QWheelEvent::{globalX, globalY} -> QWheelEvent::globalPosition QSysInfo::windowsVersion -> QOperatingSystemVersion::current Qt::InputMethodQuery::ImMicroFocus -> Qt::InputMethodQuery::ImCursorRectangle QDesktopWidget::screenGeometry -> QGuiApplication::primaryScreen::geometry QTime -> QElapsedTimer - Fixed the tests to compile when deprecated APIs are disabled. - Replaced the doc references to deprecated APIs with the new ones. Made the docs for deprecated APIs compile conditionally, based on deprecation version. Task-number: QTBUG-76491 Change-Id: I5c6b7c628957deb9163f0bd2b6bc31bde1c7daec Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
* Doc: Improve documentation for QWebEngineView::setHtml()Leena Miettinen2019-06-071-2/+7
| | | | | | | | | | | ...and QWebEngineView::setContent()and WebEngineView.loadHtml() The baseUrl cannot be empty. Fixes: QTBUG-75760 Change-Id: If276767ed6a7a9421292299e0ac79d02bbbca0e3 Reviewed-by: Michal Klocek <michal.klocek@qt.io>
* Doc: Avoid auto-linking the string 'WebEngine' to the QML typeLeena Miettinen2019-04-011-2/+2
| | | | | | | | | | Remove the previous workaround (internal \externalpage command) that was used for this purpose, and replace it with a \QWE macro that expands to the string 'Qt \WebEngine'. The backslash in the expanded string instructs QDoc not to attempt auto-linking the word. Change-Id: If4e1c95423fa07479b1af055e4760a890c0ac667 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Always treat \brief as full sentenceKai Koehne2019-02-221-6/+6
| | | | | | | | | Make sure all \brief descriptions start with an upper-case letter and end with a . Also start descriptions of \class with the name of the class or struct. Change-Id: Ifd2656201f9c1dff092085508a5423ce516e2d3f Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Clarify documentation of QWebEnginePage::title()Jüri Valdmann2019-02-221-2/+2
| | | | | | | | | | Explain what happens when the HTML has no proper <title> defined and clarify the meaning of 'by default': it refers to the state before load()/setUrl()/etc. Fixes: QTBUG-71799 Change-Id: Ib2669007573b3ea53e205d9228237bae392f6f78 Reviewed-by: Michael Brüning <michael.bruning@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Doc: Extend documentation of callbacksTamas Zakor2019-02-081-0/+4
| | | | | | | | Warn about callbacks on QWebEnginePage destruction. Task-number: QTBUG-72816 Change-Id: I8dbc297a8f364bc237b0672a63325af8da197e01 Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
* Doc: Fix doc generation for QWebEngineView::findText()Leena Miettinen2018-03-081-10/+1
| | | | | | | | | | Removed the Q_QDOC define for the FunctorOrLambda and removed the documentation for it. Modified the signature in the \fn command for the remaining docs. Task-number: QTBUG-66398 Change-Id: I142df88fa599f1f31f50da50377267d1eea322d4 Reviewed-by: Kai Koehne <kai.koehne@qt.io>
* Merge remote-tracking branch 'origin/5.9' into 5.10Allan Sandfeld Jensen2018-01-081-3/+2
|\ | | | | | | | | | | | | | | | | | | | | | | Conflicts: .qmake.conf src/core/api/qwebengineurlrequestjob.cpp src/core/browser_context_adapter.cpp src/core/renderer/user_resource_controller.cpp src/core/web_engine_context.cpp src/webenginewidgets/api/qwebenginepage.cpp Change-Id: I5278e5e22e1776d42975fc94d70ff8ca4f81fb9a
| * Hardcode default argument for mimetype in ::setContentKai Koehne2017-12-181-3/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The docs were wrong in that the default is actually text/plain with US-ASCII encoding (see e.g. data_url_unittest.cc). Anyhow, saying it might change in the future does not help anyone, and is actually a potential security risk - see e.g. the discussion about 'magic' in QTextEdit::setText(). Because of this, it's unlikely that Chromium ever changes the default. Anyhow, we can as well hardcode the default, and document it then. Change-Id: I949111598a30fa69d152d3e98d76e9d96df92d54 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Viktor Engelmann <viktor.engelmann@qt.io> Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
* | Add detailed documentation for when selectionChanged() gets emittedAlexandru Croitor2017-11-271-0/+3
| | | | | | | | | | | | Task-number: QTBUG-51096 Change-Id: Id1029577418884d5aa14296a53a8223ec410a4a2 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* | Remove DemoBrowserJüri Valdmann2017-07-261-1/+1
|/ | | | | | | | | | [ChangeLog][Examples] Removed WebEngine Demo Browser example, which got superseded by the improved WebEngine Widgets Simple Browser. Task-number: QTBUG-59819 Change-Id: I214e6f5f3a946ed617a9f4d628d3259a69874ca1 Reviewed-by: Kai Koehne <kai.koehne@qt.io> Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Doc: Describe size limit for QWebEnginePage::setHtml()Leena Miettinen2017-06-201-0/+6
| | | | | | | | | | The page content is used as a URL, which is limited to 2 MB by Chromium. Task-number: QTBUG-59369 Change-Id: Id0b81b577d1d997dd722c43e3b71b8979d86ee81 Reviewed-by: Kai Koehne <kai.koehne@qt.io> Reviewed-by: Viktor Engelmann <viktor.engelmann@qt.io>
* Add methods to issue various types of HTTP requestsViktor Engelmann2017-01-111-1/+1
| | | | | | | | | | | | | Added class QWebEngineHttpRequest, which describes a GET or POST HTTP Request. Also added overloads of method "load" to QWebEngineView, QWebEnginePage and WebContentsAdapter, which issue such a request. These can be used for example to simulate form-submissions. Task-number: QTBUG-53314 Task-number: QTBUG-53372 Change-Id: I85ac8cdd3d1557905b35e3172b922aba356d1c41 Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
* Doc: Do not advise to overwrite QWidget::contextMenuEvent()Kai Koehne2016-10-061-10/+7
| | | | | | | | | | | | There's also QWidget::setContextMenuPolicy and QWidget::customContextMenuRequested, which is arguably a better approach. Anyhow, this isn't specific to QWebEngineView, so let's leave it at that. Finally, there's no need to call triggerPageAction if you add an action to a menu. Change-Id: I0c84038746a78316ed6b90a98b68fa5eb95fbad5 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Michal Klocek <michal.klocek@qt.io>
* Merge remote-tracking branch 'origin/5.6' into 5.7Liang Qi2016-05-201-2/+4
|\ | | | | | | | | | | | | | | | | | | Conflicts: src/3rdparty src/core/browser_context_adapter.cpp src/core/web_contents_adapter.cpp tests/auto/widgets/qwebenginepage/BLACKLIST Change-Id: I45ee0a33f6316f585555d58fede8072fe514aecf
| * Doc: HTTP GET method is always used to load URLsLeena Miettinen2016-05-191-2/+4
| | | | | | | | | | | | Task-number: QTBUG-53314 Change-Id: I575a740cf0cd6e788c7533f4ec87fc910f1d03fa Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
* | Add missing icon getter and corresponding signal to QWebEngineViewPeter Varga2016-05-031-7/+12
|/ | | | | | | Task-number: QTBUG-51179 Change-Id: I44a34fbe9d738b5f27c5f0f220691aab0120e040 Reviewed-by: Allan Sandfeld Jensen <allan.jensen@theqtcompany.com> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Doc: Improve docs for the zoomFactor propertyLeena Miettinen2016-03-231-1/+3
| | | | | | | | In the WebEngineView type and QWebEnginePage and QWebEngineView docs. Change-Id: Ibbabcf6cc38a48fb14abb105f5fda4c03a89ccba Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>
* Merge remote-tracking branch 'origin/5.6.0' into 5.6Liang Qi2016-03-211-5/+4
|\ | | | | | | | | | | | | Conflicts: src/3rdparty Change-Id: Icbe7ea849b6ccdcee1ea1beccf86309ffb1ed578
| * Doc: Add information about framesLeena Miettinen2016-02-241-5/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - Describe differences between Qt WebKit and Qt WebEngine in the porting guide - Replace references to frames with references to the view in the QWebEngineView docs - Describe frames in the QWebEnginePage class overview - Replace references to frames with references to pages where appropriate in the QWebEnginePage docs - Describe the "security origin" concept that is related to frame handling Change-Id: I8c952d507414058759537a6333649c37976c12e6 Reviewed-by: Allan Sandfeld Jensen <allan.jensen@theqtcompany.com>
* | Doc: State equivalent of setHtml more preciselyJoerg Bornemann2016-02-161-1/+2
|/ | | | | | | | | Calling setContent with mimeType "text/html" does not use UTF-8 encoding. The character set must be specified. Change-Id: I67e3273afd0503b333e718e4706852d911fed2e4 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Reviewed-by: Michael Brüning <michael.bruning@theqtcompany.com>
* Prefix Markdown Editor example with "WebEngine"Kai Koehne2016-02-041-1/+1
| | | | | | | | | | Follow the example of the other examples, and always start with WebEngine. This makes also sure that Qt Creator attaches the 'webengine' tag to the example. Task-number: QTBUG-50582 Change-Id: If99ba9a23560abae61e4e2ef5a5b091b3c5473c2 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
* Widgets: Add example names to documentationSzabolcs David2016-01-191-2/+2
| | | | | Change-Id: I73f6e944e3a64b948b86882e951f85593fdb800f Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
* Doc: edit QWebEngineView docsLeena Miettinen2015-10-061-57/+48
| | | | | | | Fix grammar, style, and punctuation. Change-Id: I0d6a8f9ccda16c81f7bc32194d09c5ca0e8761ce Reviewed-by: Michael Brüning <michael.bruning@theqtcompany.com>
* Doc: reorganize and rename docsLeena Miettinen2015-08-191-7/+7
| | | | | | | | | | | | - Move general docs to src/webengine/doc/src - Remove a dedicated .qdocconf for Qt WebEngine Core, build its documentation as part of Qt WebEngine - Describe all Qt WebEngine modules on the Qt WebEngine index and overview pages - Add a wireframe drawing on the architecture Change-Id: Ib4261d1a16bbaf313d0f858515184a96dab524a5 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Fix docs to use iconUrl/iconUrlChanged.Florian Bruhin2015-08-041-2/+2
| | | | | | | | The docs presumably were copied from QtWebKit and this didn't get adjusted when icon()/iconChanged() was changed to iconUrl()/iconUrlChanged(). Change-Id: Iccecc7b0e1c69f5242bddae2dedb4135120e3519 Reviewed-by: Joerg Bornemann <joerg.bornemann@theqtcompany.com>
* Doc: Added \qtvariable to enable QDoc include QT += info.Venugopal Shivashankar2015-07-201-0/+1
| | | | | | | | Also added \since info. for some of the classes. Task-number: QTBUG-47274 Change-Id: Id8cfbd6d0e5b5826ceaebb008a453cd1c216a921 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Update copyright headersJani Heikkinen2015-02-161-1/+1
| | | | | | | | | Qt copyrights are now in The Qt Company, so we could update the source code headers accordingly. In the same go we should also fix the links to point to qt.io. Change-Id: Ieb6bac7a1be5c25eb7cb917495b58b6a870ca6d4 Reviewed-by: Pierre Rossi <pierre.rossi@theqtcompany.com>
* Doc: Use proper module name for Qt WebEngine WidgetsTopi Reinio2014-10-031-1/+1
| | | | | | | | | | Fix the name used for the \module command to include the module name to properly generate the C++ class reference page for Qt WebEngine Widgets, and link to the new page from the module landing page. Change-Id: If0814650fa16ecf1b5c66e8e46e598d576a8c21d Reviewed-by: Friedemann Kleint <Friedemann.Kleint@digia.com>
* Hide QWebEngineCallback from the docsPierre Rossi2014-09-181-2/+12
| | | | | | | | | In the same fashion as what is done in QObject::connect's documentation, we can keep it simple here and simply document what is expected. Change-Id: I98a09280870cf0aab935fd0cb69401bb98134145 Reviewed-by: Jocelyn Turcotte <jocelyn.turcotte@digia.com>
* Add widgets settings doc plus revive QWeb(Engine)View::settingsPierre Rossi2014-09-171-0/+12
| | | | | | | Also silence some warnings by tagging functions as reimplemented. Change-Id: I0572e466709d433a44c7a154ff37e43178a6013f Reviewed-by: Jocelyn Turcotte <jocelyn.turcotte@digia.com>
* Add api to get the favicon URLAllan Sandfeld Jensen2014-07-301-0/+15
| | | | | | | | | | | Adds one of the missing pieces of the QWebFrame and QWebView APIs. Unlike the QtWebKit version this only fetches the favicon URL, and not the icon. This is because we do not want to implement an icon database, and that the icon would be loaded asynchronous anyway, bringing no guarantee to be a valid icon/image yet. Change-Id: I227311ae3676044da850e687b82bee752b5079c8 Reviewed-by: Jocelyn Turcotte <jocelyn.turcotte@digia.com>
* Fix some more documentation.Michael Brüning2014-05-191-15/+2
| | | | | | | | | Adds the license for Chromium to the legalese part. Adds some missing documentation to QWebEngineView and QWebEnginePage. Change-Id: Ie81aaa87db85bb72efb83680defbdb101a134df0 Reviewed-by: Jocelyn Turcotte <jocelyn.turcotte@digia.com>
* Fix up some more documentation.Michael Brüning2014-05-121-43/+7
| | | | | | | | | | Removes methods from the documentation that no longer exist. Removes left over instance of Qt WebKit / WebKit instead of Qt WebEngine / Chromium in the documentation. Change-Id: I27e1d41fc16116a60f94c3369f76ddfed60e4380 Reviewed-by: Jocelyn Turcotte <jocelyn.turcotte@digia.com>
* Cleanup the QtWebEngineWidgets public headers and APIJocelyn Turcotte2014-04-151-136/+2
| | | | | | | | | | | | | Headers were left intact to leave a trace of the evolution compared to the QtWebKit API and to make it easier to work until we had a basic subset of the API implemented. With the upcoming release, this patch removes this convenience in the aim of starting polishing the headers and the documentation for the upcoming release. Change-Id: Iae436b4ec041d771a7002575e122835802bc9f3e Reviewed-by: Michael Bruning <michael.bruning@digia.com>
* Rough port of the documentation to QtWebEngineJocelyn Turcotte2014-03-311-90/+83
| | | | | | | | | | | | | | | This is a gross mechanical modification of the documentation, along with build system bindings to allow it to generate. This should allow doing iterative improvements to the documentation from now on. This fixes project-related qdoc warnings but we still need to do some serious work to get the documentation better fitting QtWebEngine. All the documentation is ported to match the current state of our headers (without trying to adapt to modified APIs yet) and we should clear the part of the documentation that we don't need at the same time that we clean up our public headers. Change-Id: I6fb4e10e8b4c1c53be7bc7c581286248ac04d4da Reviewed-by: Andras Becsi <andras.becsi@digia.com>
* Import the QtWebKit documentationJocelyn Turcotte2014-03-311-0/+544
This places the documentation in separates .qdoc files with the original license header preserved. We don't want to contaminate our implementation yet just for the documentation, so keep it separate for now. New documentation that isn't attached to the QtWebKit LGPL license should go inline in the code as usual. Change-Id: I113a9ad2b826ed7cea053be065f201b637070d28 Reviewed-by: Andras Becsi <andras.becsi@digia.com>