summaryrefslogtreecommitdiffstats
path: root/src/webenginewidgets/doc
Commit message (Collapse)AuthorAgeFilesLines
* Doc: clean up QWebEngineSettings docsLeena Miettinen2015-08-241-45/+48
| | | | | | | | | | | ... and the corresponding QQuickWebEngineSettings docs - Add missing documentation - Remove references to obsolete classes - Edit for grammar and style Change-Id: I368fff274609941d6435ddf3343b81bca6013945 Reviewed-by: Joerg Bornemann <joerg.bornemann@theqtcompany.com>
* Doc: Added a note about setting feature permission to a pageVenugopal Shivashankar2015-08-111-0/+4
| | | | | | | | | | The feature premissions set ahead of a feature request has no effect. The QWebEnginePage::setFeaturePermission method serves pending feature requests only. Task-number: QTBUG-47173 Change-Id: Ifff4dadc56fae1ecdcce9029a15d57576a830923 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Fix docs to use iconUrl/iconUrlChanged.Florian Bruhin2015-08-042-4/+4
| | | | | | | | 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-205-4/+6
| | | | | | | | Also added \since info. for some of the classes. Task-number: QTBUG-47274 Change-Id: Id8cfbd6d0e5b5826ceaebb008a453cd1c216a921 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Cleaned up the module overview.Kavindra Palaraja2015-07-141-33/+12
| | | | | | | | Polished the brief and some sentences in the module overview to improve readability. Change-Id: I35964880214ecd61859094b0ea7e318ff3e53fa6 Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>
* Polished the module overview.Kavindra Palaraja2015-06-271-8/+7
| | | | | | | | Simplified sentences in the Architecture section to improve readability. Change-Id: I324a95caf811c0c8afe14c90fe10529999e3c538 Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com> Reviewed-by: Andras Becsi <andras.becsi@theqtcompany.com>
* Add license file and mention in the docs for GPLv2+.Pierre Rossi2015-06-121-1/+1
| | | | | | Change-Id: I4fa625452228eda7aef97b3e4fb09d21bbdf6470 Reviewed-by: Andras Becsi <andras.becsi@theqtcompany.com> Reviewed-by: Lars Knoll <lars.knoll@digia.com>
* Improve documentation about certificate errorsPaulo Pinheiro2015-04-071-0/+11
| | | | | | | | | | Documentation about how to handle certificate errors was poor, so this patch try to improve that. [ChangeLog][QtWebEngineQML][QQuickWebEngineCertificateError] New API for handling certificate errors in the QML API. Change-Id: I9234f5c8296651e7634ee41827fc6dcce503398b Reviewed-by: Michael Brüning <michael.bruning@theqtcompany.com>
* Use singular they instead of he as a pronoun for the user.Michael Brüning2015-03-131-2/+2
| | | | | | | It is neutral and commonly used. Change-Id: I16f5f058377ba99e599fc84037157314d0dd68a3 Reviewed-by: Allan Sandfeld Jensen <allan.jensen@theqtcompany.com>
* Update copyright headersJani Heikkinen2015-02-167-22/+22
| | | | | | | | | 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>
* Document geolocation featureAllan Sandfeld Jensen2015-01-281-0/+1
| | | | | | | | | When the geolocation feature was activated, the feature request was not documented along with it. Change-Id: I8cb1b60015c3cffe7f3d035ea4f61625d81be5b0 Reviewed-by: Florian Bruhin <qt-project.org@the-compiler.org> Reviewed-by: Pierre Rossi <pierre.rossi@theqtcompany.com>
* Merge remote-tracking branch 'origin/5.4' into devAndras Becsi2014-12-011-0/+6
|\ | | | | | | | | | | | | | | | | Conflicts: src/core/access_token_store_qt.cpp src/core/access_token_store_qt.h src/core/content_browser_client_qt.cpp Change-Id: Id319ad0d87ce071e63d9c6c22b4fc35523ddfa74
| * Doc: Fix issues related to example docsTopi Reinio2014-11-171-0/+6
| | | | | | | | | | | | | | | | | | | | | | | | - Add documentation for Quick Nano Browser - Add all examples to the correct group - Add instructions to run the examples - Qt WebEngine Widgets index page: Add examples section Task-number: QTBUG-42668 Change-Id: Ie60f8708336b9c147d0c22afb555fe87287deddc Reviewed-by: Jocelyn Turcotte <jocelyn.turcotte@digia.com> Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
* | Merge remote-tracking branch 'origin/5.4' into devAllan Sandfeld Jensen2014-11-113-9/+8
|\| | | | | | | | | | | | | | | Conflicts: src/core/browser_context_qt.cpp src/webengine/api/qquickwebengineview_p.h Change-Id: I73bdec03b627b282851d7dda12006d4ab631072c
| * Fix enum names of audio/video featuresAllan Sandfeld Jensen2014-11-071-5/+3
| | | | | | | | | | | | | | | | | | | | | | | | The feature enum names and documentation gave the impression it could control audio and video output, while they only control input. Also removed documentation of non connected feature permissions for Notifications and GeoLocation. Change-Id: Ia35142ca691ebd6059b7472e9803fda8cbd84813 Reviewed-by: Jocelyn Turcotte <jocelyn.turcotte@digia.com> Reviewed-by: Pierre Rossi <pierre.rossi@gmail.com>
| * Add setting ErrorPageEnabledAndras Becsi2014-10-141-0/+1
| | | | | | | | | | | | | | | | | | This is required so that embedders can implement custom error pages, and is also needed for tests, where error-page loading has side-effects on subsequent page loads. Change-Id: I5ae276a58864a2fa9d7b608bea3340b482a92f4e Reviewed-by: Peter Varga <pvarga@inf.u-szeged.hu>
| * Doc: Correct snippets for QWebEngineView API doc.Michael Brüning2014-10-091-4/+4
| | | | | | | | | | | | | | | | Those were using wrong action names and also the wrong trigger methods in the wrong context. Change-Id: If124bf7836a553dc4a632db208cee41fb998c622 Reviewed-by: Jocelyn Turcotte <jocelyn.turcotte@digia.com>
* | Implement acceptNavigationRequest for the widgets API.Andras Becsi2014-10-201-0/+24
|/ | | | | | | | | This is the equivalent API for navigationRequested in QtQuick. This patch also enables and updates tests that depended on this API, and removes the ones that we will not support. Change-Id: I28970c11225420a9680fbd767880130492664179 Reviewed-by: Michael Bruning <michael.bruning@digia.com>
* Doc: Fix issues in .qdocconf filesTopi Reinio2014-10-031-1/+1
| | | | | | | | | - Remove url variable (it's included from global doc config) - Fix qhp selector for QML types - Sort the examples in qhp Change-Id: I7f72aebe4f5482ac922a294ad156f8a73e4ccc6e Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Use proper module name for Qt WebEngine WidgetsTopi Reinio2014-10-035-6/+12
| | | | | | | | | | 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>
* Import the Qt WebKit porting guide from the wikiJocelyn Turcotte2014-09-293-1/+295
| | | | | | | | Also added a link to it in a new section briefly explaining the difference between Qt WebKit and Qt WebEngine. Change-Id: I89529c701e7f9faae1e4b7d15d5e5d6aec0c8f9f Reviewed-by: Andras Becsi <andras.becsi@digia.com>
* Various doc tweaksJocelyn Turcotte2014-09-293-20/+9
| | | | | | | | | | | | - Fix the example pages titles to match the qdocconf files - Remove information not as relevant for QtWebEngine as it was for QtWebKit - Fix the QtWebEngineWidgets snippet not to refer to webengine - Remove the dead link and the reference to Arora from QtWebEngine Change-Id: Ib3c57c8dd534330b3323c94fb2217374b3e52cf9 Reviewed-by: Andras Becsi <andras.becsi@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Hide QWebEngineCallback from the docsPierre Rossi2014-09-183-7/+72
| | | | | | | | | 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-174-0/+220
| | | | | | | Also silence some warnings by tagging functions as reimplemented. Change-Id: I0572e466709d433a44c7a154ff37e43178a6013f Reviewed-by: Jocelyn Turcotte <jocelyn.turcotte@digia.com>
* Do away without QWebEngineWidgets::initializePierre Rossi2014-08-042-8/+0
| | | | | | | | | If we consider the plugin scenario is unlikely and decide it's unsupported for widgets, we can simplify our tests and examples a bit on this front. Change-Id: Idc96032c127b4ee74fb5c7b3d2cdfdf99c3a722e Reviewed-by: Andras Becsi <andras.becsi@digia.com>
* Add api to get the favicon URLAllan Sandfeld Jensen2014-07-302-0/+32
| | | | | | | | | | | 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-194-110/+132
| | | | | | | | | 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>
* Remove the webpage snippet for now.Michael Brüning2014-05-163-115/+0
| | | | | | | | | | This snippet contains API that we might not support at all. It is better to remove it and add a new version in case we reintroduce this than to present a snippet that does not work or only works partially. Change-Id: Ia47ad69108ddcbe529aecff8e4f235b17d80514f Reviewed-by: Jocelyn Turcotte <jocelyn.turcotte@digia.com>
* Fix up some more documentation.Michael Brüning2014-05-124-158/+95
| | | | | | | | | | 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-1510-2619/+8
| | | | | | | | | | | | | 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>
* Replace uses of QWebEngineFrame with a security origin URLJocelyn Turcotte2014-04-151-6/+6
| | | | | | | | This changes implemented methods. The rest of the references will go away with the public headers cleanup. Change-Id: I82340cd7a4488c4b463489ae98cd9c16de4e7487 Reviewed-by: Michael Bruning <michael.bruning@digia.com>
* Update QWebEnginePage::WebWindowTypeJocelyn Turcotte2014-04-151-2/+3
| | | | | | | | | | | Expose the same values as currently available in QQuickWebEngineView::NewViewDestination. Rename the WebModalDialog to WebDialog, which actually replaces the tool/status/menuBarVisibilityChangeRequested signals. Change-Id: Icc103f434fb3eca49f1a53e476e101c3d6fffd36 Reviewed-by: Pierre Rossi <pierre.rossi@gmail.com>
* First iteration of adujsting widgets docs and snipperts.Michael Brüning2014-04-104-26/+18
| | | | | | | | * Removes inappropriate licensing info. * Corrects simple snippet. Change-Id: I9ac7738d8da22957aa32c91fdcbf81ddedefed72 Reviewed-by: Jocelyn Turcotte <jocelyn.turcotte@digia.com>
* Rough port of the documentation to QtWebEngineJocelyn Turcotte2014-03-3110-742/+667
| | | | | | | | | | | | | | | 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-3117-0/+4308
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>