aboutsummaryrefslogtreecommitdiffstats
path: root/src/webchannel/doc/src
Commit message (Collapse)AuthorAgeFilesLines
* Document that only a single QWebChannel object can be used on a pageVolker Hilsheimer2024-04-121-0/+2
| | | | | | | | | | This has been the status quo for a long time, so document it as a current limitation. Task-number: QTBUG-64408 Pick-to: 6.7 6.5 Change-Id: Ia702f69a5b44dda61c8cff85036cbff8dea70ac2 Reviewed-by: Milian Wolff <milian.wolff@kdab.com>
* Add wrappers to optionally convert incoming dataØystein Heskestad2022-11-111-1/+10
| | | | | | | | | | | | | | | | | Wrappers can be added as a third argument to WebChannel constructors or by explicitly calling addConverter. They can be added by supplying their name or by supplying a function. If the function is not applicable it must return undefined to proceed to to the next wrapper. Data is transmitted as JSON when sent over the WebChannel. Because JSON does not have a date, type QDateTime objects are sent as ISO 8601 text strings. The "Date" converter converts such strings to ECMAScript Date objects. Fixes: QTBUG-98490 Change-Id: I83bb7476b50838359db5b981f500871142fa41f0 Reviewed-by: Arno Rehn <a.rehn@menlosystems.com>
* Use SPDX license identifiersLucie Gérard2022-06-106-156/+12
| | | | | | | | | | | Replace the current license disclaimer in files by a SPDX-License-Identifier. License files are organized under LICENSES directory. Pick-to: 6.4 Task-number: QTBUG-67283 Change-Id: Id704376bd7d5a127ad3e9bf09f9abedcf2b0f498 Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* Revise Qt Web Channel module landing pageAndreas Eliasson2022-03-281-35/+34
| | | | | | | | | | Remove the include directive section and add global CMake and qmake snippets. Also, reorganize some of the sections structure. Task-number: QTBUG-100369 Pick-to: 6.3 6.3.0 Change-Id: I6af1a2e4a9e77a1ae7a2a3a5d515929683ea26da Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Add Changes Qt 5 to Qt 6 page to Qt WebChannelPaul Wicking2021-08-041-0/+44
| | | | | | | | | Add a basic changes page for consistency with other modules. Task-number: QTBUG-94931 Pick-to: 6.2 Change-Id: I3076247496ec6171144afde877d7f958497a685e Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Fix documentation to use commonly working syntax for property changesMilian Wolff2020-02-041-2/+2
| | | | | | | | | | | | | The "on" prefix and capitalization of the first letter in the change signal name is only done in QML, not in JavaScript. Furthermore, not all notify signals carry the new value in their signature. Adapt the example code to not show the "on" prefix and also use the more reliable approach to read a property value directly. Task-number: QTBUG-81782 Change-Id: I9c25e48c2d7abcdabbca88526f62c3d79eb952f8 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Merge remote-tracking branch 'origin/5.13' into devQt Forward Merge Bot2019-04-132-7/+7
|\ | | | | | | Change-Id: I8b70f062015311e0e3827fe001155d6ce1e146d2
| * Automatically register the latest import versionv5.13.0-beta3Kai Koehne2019-04-122-7/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | This follows what was done in d28c9f6a for Qt Quick Controls 2. The latest import version (e.g. 1.14 in Qt 5.14) will automatically be registered whenever the Qt version is bumped. This avoids needing to wait until a new type is added (or a new revision is added to an existing type) before being able to use the newest Qt Quick version. Change-Id: I2570c2bc50c629101adb763e5e5f90bc3ded8bac Reviewed-by: Milian Wolff <milian.wolff@kdab.com>
* | Implement actual overload resolutionArno Rehn2019-03-291-6/+14
| | | | | | | | | | | | | | | | | | | | | | | | This implements host-side overload resolution. If a client invokes a method by its name instead of its id, the overload resolution tries to find the best match for the given arguments. The JavaScript client implementation now defaults to invocation-by-name, except when a method is invoked by its full signature. In that case, the invocation is still performed by method id. Change-Id: I09f12bdbfee2e84ff66a1454608468113f96e3ed Reviewed-by: Milian Wolff <milian.wolff@kdab.com>
* | Publish overloaded methods and signals to JavaScriptMilian Wolff2019-03-251-0/+40
|/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Previously, we only published the first method or signal of any given name. We keep this behavior for the nice JavaScript notation that looks like a normal JavaScript method call `foo.bar(...)`. When you need to call a different overloaded method, this patch offers you to specify the explicit signature on the JavaScript side. I.e. when we have an object with `foo(int i)` and `foo(const QString &str, int i)`, then on the JavaScript a call to `obj.foo(...)` will always call the first method like before. But now you can specify the full QMetaMethod signature and call matching methods explicitly via `obj["foo(int)"]` or `obj["foo(QString,int)"]`. Automatic overload resolution on the C++ side for the nice notation cannot easily be implemented: We need to know the return value of the called function, otherwise we cannot construct a valid QGenericReturnArgument. Furthermore, we wouldn't be able to differentiate between e.g. any numeric types on the C++ side, since JavaScript only has a single `double` type internally. [ChangeLog][QWebChannel][General] It is now possible to explicitly call overloaded methods or connect to overloaded signals by specifying the full method or signal signature in string form on the JavaScript side. Fixes: QTBUG-73010 Change-Id: I4645edee97af56fd8d126e77d70dc33ed3513deb Reviewed-by: Arno Rehn <a.rehn@menlosystems.com> Reviewed-by: Frederik Gladhorn <frederik.gladhorn@qt.io> Reviewed-by: Milian Wolff <milian.wolff@kdab.com>
* Use FDL license for all .qdoc filesKai Koehne2018-05-231-21/+9
| | | | | Change-Id: I039e3a47ca2c3889c3272f81fafb3997777881f6 Reviewed-by: Milian Wolff <milian.wolff@kdab.com>
* Doc: Add license details to index pageKai Koehne2018-05-141-0/+9
| | | | | Change-Id: I7ef0f2d7c760fcb4016e925ae5cd94fc158b53a6 Reviewed-by: Milian Wolff <milian.wolff@kdab.com>
* Fix outdated FDL headerKai Koehne2017-09-294-12/+12
| | | | | Change-Id: I5a200b078a6d3485cd6277f79902aca8021b6770 Reviewed-by: Milian Wolff <milian.wolff@kdab.com>
* Merge remote-tracking branch 'origin/5.7' into devEdward Welbourne2016-07-214-19/+100
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: src/webchannel/doc/src/index.qdoc src/webchannel/qwebchannelabstracttransport.cpp Overlapping changes to documentation; constructed hybrid. src/webchannel/qmetaobjectpublisher.cpp tests/auto/webchannel/tst_webchannel.cpp tests/auto/webchannel/tst_webchannel.h Both sides made additions; in the same place. Change-Id: Iff12970978b70946dc3e1290841aca2d35c9c1d0
| * Merge remote-tracking branch 'origin/5.6' into 5.7Edward Welbourne2016-07-152-17/+40
| |\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Alleged Conflicts: examples/webchannel/chatclient-html/doc/src/chatclient-html.qdoc examples/webchannel/chatclient-qml/doc/src/chatclient-qml.qdoc examples/webchannel/chatserver-cpp/doc/src/chatserver-cpp.qdoc In each case, the two sides agreed byte-for-byte. Not quite sure what git thought the conflict was ! Change-Id: I5da9695b667f4112848c520b630ab1304d61cea3
| | * Doc: Fix links to other modulesLeena Miettinen2016-05-311-9/+8
| | | | | | | | | | | | | | | | | | | | | -Remove references to Qt WebKit Change-Id: I0bd184021b1a87828e93f5783c38b9ba97f37763 Reviewed-by: Milian Wolff <milian.wolff@kdab.com>
| | * Doc: Edit the index pageLeena Miettinen2016-05-311-8/+32
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - Remove reference to Qt WebKit - Add Getting Started section - Use standard section titles for API Reference and Examples Change-Id: Ie5e3ac792a109f680132a79e86d5e1065f4c3829 Reviewed-by: Milian Wolff <milian.wolff@kdab.com>
| | * Doc: Edit example documentationLeena Miettinen2016-05-312-1/+59
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - Add images to the examples. - Add instructions for running the examples - Edit for grammar and style - Add dependencies to Qt WebEngine and Qt WebSockets modules - Add a workaround for preventing autolinking of WebChannel, WebEngine and WebSockets to the wrong targets - Use explicit linking where necessary Change-Id: Ia4025284063fa09c9e2a0b2c347ee682bba8a615 Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
| * | Doc: Edit example documentationLeena Miettinen2016-06-022-1/+59
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - Add images to the examples. - Add instructions for running the examples - Edit for grammar and style - Add dependencies to Qt WebEngine and Qt WebSockets modules - Add a workaround for preventing autolinking of WebChannel, WebEngine and WebSockets to the wrong targets - Use explicit linking where necessary Change-Id: Ia4025284063fa09c9e2a0b2c347ee682bba8a615 Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com> (cherry picked from commit 01ea92c7c8d77d3d3c10ab1cc4bf4f214aa07126)
* | | Clarify the module descriptionFrank Meerkoetter2016-04-251-8/+7
|/ / | | | | | | | | Change-Id: Ib651958ec7aa12eb205a11a515fa9a464e254bd0 Reviewed-by: Milian Wolff <milian.wolff@kdab.com>
* / Updated license headersAntti Kokko2016-01-201-14/+20
|/ | | | | | | | | | From Qt 5.7 -> LGPL v2.1 isn't an option anymore, see http://blog.qt.io/blog/2016/01/13/new-agreement-with-the-kde-free-qt-foundation/ Updated license headers to use new LGPL header instead of LGPL21 one (in those files which will be under LGPL v3) Change-Id: I2fe282e6b9d52f9635cd69e3e8de53724cbb8b0a Reviewed-by: Lars Knoll <lars.knoll@theqtcompany.com>
* Doc: Added a brief overview about the modulev5.5.0-beta1Venugopal Shivashankar2015-04-201-5/+13
| | | | | Change-Id: Ib45c48613c687fdfcafd121ed9d4932cbc116799 Reviewed-by: Milian Wolff <milian.wolff@kdab.com>
* Update copyright headersv5.5.0-alpha1Antti Kokko2015-02-174-21/+21
| | | | | | | | | 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: Iebed549451f58a9fbdd86adf5d0340412d7766d7 Reviewed-by: Jani Heikkinen <jani.heikkinen@theqtcompany.com>
* Update license headers and add new licensesJani Heikkinen2014-08-261-18/+10
| | | | | | | | | | | | | | - Renamed LICENSE.LGPL to LICENSE.LGPLv21 - Added LICENSE.LGPLv3 & LICENSE.GPLv2 - Removed LICENSE.GPL Furthermore we need to update the sync.profile to not point to the dev branch in order to integrate this patch in the CI. Change-Id: I06b5496b5d865e2da4808532362616429c969658 Reviewed-by: Sergio Ahumada <sahumada@blackberry.com> Reviewed-by: Milian Wolff <milian.wolff@kdab.com>
* Doc: Edited links JavaScript API page and other documentation fixes.Jerome Pasion2014-08-231-5/+6
| | | | | | | | | The JavaScript API page is important to the rest of the documentation but there was no link to it. Task-number: QTBUG-40756 Change-Id: Id741a67ac2b57e21da548c2961c622c7516ac8cf Reviewed-by: Milian Wolff <milian.wolff@kdab.com>
* Doc: Fix example documentation and pathsTopi Reinio2014-08-132-1/+51
| | | | | | | | | | | | | | | To fix issues related to example documentation and to follow Qt convention, do the following changes: - Rename examples/qwebchannel to examples/webchannel - Move example-specific documentation to correct location(s) - Include generic 'Running the Example' instructions - Add the module name to example title, fix links This ensures that example docs are built and the example manifest file generated correctly. Change-Id: I284e0b13db95a6738d72258735018b59156cc7da Reviewed-by: Milian Wolff <milian.wolff@kdab.com>
* Fixup documentation issues.Milian Wolff2014-08-042-3/+3
| | | | | | | | | These issues were raised by Sze Howe Koh in code review 89965 of change I259c204e. This change set does not yet include any comparison to the old Qt WebKit bridging functionality. I'll hand this in later. Change-Id: Idc7df0e02bfcda3c3fcf1a4e147c1dfac4f18a64 Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com>
* Add documentation for the QtWebChannel module.Milian Wolff2014-08-013-0/+207
Please proof-read it and tell me what needs to be improved. I assume most people will probably not use the QWebChannel directly. Rather, they will only consume its features indirectly through the integration in QtWebKit/QtWebEngine. Thus the documentation here is for QWebChannel as a library. User-end documentation should be added to QtWebKit, I think. Change-Id: I259c204e24331271b8dc74ea11695988234a79d3 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-19 23:31:33 +0000