aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/doc/snippets
Commit message (Collapse)AuthorAgeFilesLines
* Doc: mention that Item's childrenRect property is local to the itemMitch Curtis2021-01-051-0/+68
| | | | | | | | | As opposed to being local to the item's parent. Change-Id: Idcf2cdbedcac24a6890ce761c3f2a23f2c7a8dc4 Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io> (cherry picked from commit a0769549cdb81c7104b60c2a67dfa62e8c42c224) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Document how to use CMake for Qt QuickKai Koehne2020-12-041-0/+4
| | | | | | | | Task-number: QTBUG-73058 Change-Id: Ie72c1f4331ad05f31d9a646730133c97c4b15790 Reviewed-by: Paul Wicking <paul.wicking@qt.io> (cherry picked from commit c8b108ca76e29d5c1b55468a9659eef80a6afa86) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* QQuickView docs: show correct usage of setInitialPropertiesFabian Kosmale2020-11-121-0/+9
| | | | | | Pick-to: 5.15 Change-Id: If63f4c59f18bc0754ce2e68e424f6efd0f512d30 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* Reimplement UniformAnimator for ShaderEffectJonas Karlsson2020-06-291-49/+33
| | | | | | Fixes: QTBUG-83976 Change-Id: I307e96be0d3d2edeb8d9065d100c1ef38c8824c7 Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
* Doc: fix delegate snippetMitch Curtis2020-06-291-4/+4
| | | | | | Pick-to: 5.15 Change-Id: I50facb06e37c26bf86d032d3fd5377f23a5d2bc2 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* Update ShaderEffect docsLaszlo Agocs2020-06-183-273/+0
| | | | | | | | | | | | | | The two ShaderEffect related snippets are removed, with the relevant code folded into the documentation itself. We cannot support standalone snippets with custom shaders as we'd need to have separate shader files, qsb files, scripts to build, etc. This is not reasonable at this point. In layerblending.qml the ShaderEffect serves no purpose, apart from providing a fancy background that is irrelevant to the topic. Just remove that. Change-Id: I726f029c8b7096938aa609031e391e9e57ef1655 Reviewed-by: Christian Strømme <christian.stromme@qt.io>
* Remove QQuickOpenGLShaderEffectPaul Olav Tvete2020-06-041-42/+44
| | | | | | | | | This also removes QQuickUniformAnimator, which is not yet ported to RHI (QTBUG-83976) Task-number: QTBUG-83977 Change-Id: I3e656e6817ac991371b7f6557f050e122635d279 Reviewed-by: Eirik Aavitsland <eirik.aavitsland@qt.io>
* Remove QRegExpValidator usagesLars Knoll2020-03-181-56/+0
| | | | | | | | | | | This also means the RegExpValidator QML type will be gone. Use QRegularExpressionValidator instead. [ChangeLog][QtQuick][RegExpValidator] The RegExpValidator QML type has been removed. Use RegularExpressionValidator instead. Change-Id: If25fc5a258a669dfd28e705271757caa252ce05c Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* Doc: Fix QQuickTableView snippetUlf Hermann2020-02-243-42/+119
| | | | | | | | Use static registration, provide a .pro file, and make it load and show the right file. Change-Id: I949831a399ce00cd8b3d012d8bd4e95a1efcdeb5 Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
* Add required property documentationFabian Kosmale2020-02-061-0/+81
| | | | | Change-Id: I9e2c44ddcbb6c7e3a92b2bd7d2492ece0cd0e62d Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Merge remote-tracking branch 'origin/5.14' into 5.15Qt Forward Merge Bot2020-01-291-20/+0
|\ | | | | | | | | | | | | Conflicts: src/plugins/qmltooling/qmldbg_debugger/qqmlenginedebugservice.cpp Change-Id: I133bfd4bd9dd6f704252c956c90f05e8a8a40d6a
| * Doc: Move snippet file to qtxmlpatternsPaul Wicking2020-01-271-20/+0
| | | | | | | | | | | | | | | | | | This file was forgotten when moving the documentation to qtxmlpatterns, leaving the docs broken. Task-number: QTBUG-77176 Change-Id: I832a4c3cb2551b8e683b6e6fb97034ba86a74322 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* | Merge remote-tracking branch 'origin/5.14' into 5.15Qt Forward Merge Bot2020-01-202-0/+151
|\| | | | | | | | | | | | | Conflicts: src/quick/items/qquickitemview.cpp Change-Id: Ib9faebdbef5eebb80f4e6aeb5b15b5df7494b157
| * Text and TextEdit: document MarkdownText formatShawn Rutledge2020-01-172-0/+151
| | | | | | | | | | | | | | Task-number: QTBUG-81306 Change-Id: I8ee50727f4e75eee8c0997f17193d8c99e855551 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* | QQuickListView: document delegate item recyclingRichard Moe Gustavsen2019-12-091-0/+82
|/ | | | | Change-Id: I6777eb179643ca2d5fb14f96f5f5ac02f5f2fb04 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Doc: Fix documentation warningsTopi Reinio2019-11-111-1/+1
| | | | | | | | | | | | | | | | | | There were a lot of documentation warnings introduced by the separation of QtQml.Models and QtQml.WorkerScript modules from the QtQml documentation project into their own sub-projects. Fix the above, and also ensure that the experimental Qt.labs.qmlmodels QML types are listed in the documentation, and add them also on the QML module page for QtQml.Models. A few warnings remain, they may be indicative of issues not in the scope of this commit. Fixes: QTBUG-79812 Change-Id: Idc25c976e4c96feab4aae893519d6c9245f57a64 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* CMake: Document newly introduced QT5_IMPORT_QML_PLUGINS functionAlexandru Croitor2019-08-281-0/+6
| | | | | | | Task-number: QTBUG-38913 Change-Id: I25ada92de8c7d7186c9b083b8a8ccc4427945b28 Reviewed-by: Kavindra Palaraja <kpalaraja@luxoft.com> Reviewed-by: Kai Koehne <kai.koehne@qt.io>
* Merge remote-tracking branch 'origin/5.13' into devQt Forward Merge Bot2019-08-201-41/+94
|\ | | | | | | Change-Id: I9ce3eee3d6f88783b9e20110a2814bee805291a4
| * Doc: Correct error in doc Transition QML TypeNico Vertriest2019-08-191-41/+94
| | | | | | | | | | | | | | | | | | - corrected reference to non-existing state - added example with multiple states Fixes: QTBUG-73982 Change-Id: I7c815cb706f1ad1b8035f136448b75dce8eb9bfe Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* | Fix docs to explain the new type syntax for QML methodsSimon Hausmann2019-07-101-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | [ChangeLog][QtQml] It is now possible to specify types for method parameters and their return value in QML (basic and object types), using TypeScript-like syntax with a colon separator. The syntax for QML declared signals supports the same style. This change also adapts the remaining snippets and docs to the "fresher" qml signal parameter syntax. Change-Id: I601781f01f696276951b04785584adab39fedfd9 Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* | Register QRegularExpressionValidator in QtQuickUlf Hermann2019-06-122-2/+58
| | | | | | | | | | | | | | | | This should replace QRegExpValidator. RegExpValidator is deprecated now. Task-nunber: QTBUG-72588 Change-Id: I072deb382914fd322ce192509782b241824ccd7b Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
* | Merge remote-tracking branch 'origin/5.13' into devQt Forward Merge Bot2019-05-161-0/+64
|\| | | | | | | Change-Id: I192cb06f3b92869699cb3e072f2c6c1e8dbb1ef4
| * Merge remote-tracking branch 'origin/5.12' into 5.13Qt Forward Merge Bot2019-05-161-0/+64
| |\ | | | | | | | | | Change-Id: Ia93dc734ce25b3134b0f905f473a0c30777ceaf1
| | * Document TapHandler.tapped and [single|double]Tapped eventPoint argumentShawn Rutledge2019-05-091-0/+64
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Amends b8fd580cb3453b3850c36765c4b2537538d2f4f8 to add documentation. The eventPoint is important to get ephemeral state from the pointing device: which button was released (thus triggering the tap), which device it was, and where the release occurred. Users may expect to use the point property, but QQuickHandlerPoint::reset(QQuickEventPoint *) resets every property of the point at the same time, so the architecture currently does not allow for mixed state, i.e. having correct button state but still holding leftover position information. It may be surprising for users, but the changes to the point property are an atomic transaction that occurs before the signal. Task-number: QTBUG-61749 Task-number: QTBUG-64847 Change-Id: I33e0e232084beba8e10d8b02fa3bf85f36293358 Reviewed-by: Jan Arve Sæther <jan-arve.saether@qt.io>
* | | Add WheelHandlerShawn Rutledge2019-04-272-0/+151
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | It can be used to change any qreal property of its target Item in response to wheel rotation, or it can be used in other ways that involve bindings but without a target item. [ChangeLog][QtQuick][Event Handlers] Added WheelHandler, which handles mouse wheel rotation by modifying arbitrary Item properties. Fixes: QTBUG-68119 Change-Id: I247e2325ee993cc1b91a47fbd6c4ba0ffde7ad49 Reviewed-by: Jan Arve Sæther <jan-arve.saether@qt.io>
* | | Add BoundaryRuleShawn Rutledge2019-04-271-0/+74
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | [ChangeLog][Qt Labs Animation] Added the BoundaryRule QML type, a PropertyValueInterceptor that restricts the range of values a numeric property can have, applies "resistance" when the value is overshooting, and provides the ability to animate it back within range. Change-Id: I677b407a351c12b0c5b23c34a45933154310c2cd Reviewed-by: Jan Arve Sæther <jan-arve.saether@qt.io>
* | | Doc: improve Example Usage section of TableViewMitch Curtis2019-04-243-0/+92
|/ / | | | | | | | | | | | | | | | | - Make two sub-sections: C++ and QML - Add a TableModel example to the QML section Change-Id: Ib391b4c0a78e11f5130944b6ac99e20a5982a453 Reviewed-by: Richard Moe Gustavsen <richard.gustavsen@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* / Doc: Fix a code snippet in DragHandler QML typeTopi Reinio2019-02-251-1/+1
|/ | | | | | | Task-number: QTBUG-73900 Change-Id: I00875525450a91d6841e5e7a2af77b41e400ea46 Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Move xmllistmodel to xmlpatternsv5.12.0-beta4Frederik Gladhorn2018-11-051-96/+0
| | | | | | | | | Latest changes moved to xmlpatterns: e08f9393acc6417598f328d7f4b7b082c5d57afa Change-Id: I7e3054a3f0f11833053746294e3b2b958047394d Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> Reviewed-by: Frederik Gladhorn <frederik.gladhorn@qt.io>
* Doc: Fix QDoc warningsPaul Wicking2018-10-011-2/+2
| | | | | Change-Id: I19545953bde10d4ccc2f37843dcda2569dc77df4 Reviewed-by: Martin Smith <martin.smith@qt.io>
* Doc: Remove documentation for deprecated QML typesVenugopal Shivashankar2018-09-251-68/+0
| | | | | | | | | | | | | VisualDataModel, VisualDataGroup, and VisualItemModel are replaced with DelegateModel, DelegateModelGroup, and ObjectModel respectively (since 7cad0e52c5a020bd29635e9912fd8946a6b48124). Also renamed/deleted a few snippet files and an image. Task-number: QTBUG-37725 Change-Id: I5fa93993a31d8f9b08e7a282d5550ddd9bfb813f Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
* Doc: Update the 'reversible' Transition code snippetAlexander Akulich2018-09-111-5/+5
| | | | | | | | | - Use 'better' colors - Replace MouseArea with a TapHandler - Update QtQuick import statement Change-Id: I32c2ca87855ba1708ddc33329a05035a55bab82b Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
* Doc: Fix 'reversible' Transition code snippetAlexander Akulich2018-09-111-1/+3
| | | | | | | | | | The Transition documentation refers to this snippet as an example of 'reversible' property usage, but the code actually misses it and demonstrate the last sentence: "If the transition did not set the to and reversible values..." Change-Id: I54da7dc2886006d8509891ba982f57b1ea97ebf0 Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
* Doc: Show that DragHandler is now a multi-point handlerShawn Rutledge2018-09-112-7/+7
| | | | | | | | | Inheritance changed, and that means it has a centroid property. Amends ca7cdd71ee33f0d77eb6bf1367d2532e26155cb2 Task-number: QTBUG-68106 Change-Id: Ie68eb1376868b143dd56564a3abc896dd7e745c6 Reviewed-by: Jan Arve Sæther <jan-arve.saether@qt.io>
* Doc: Document TableView qml typeRichard Moe Gustavsen2018-09-045-0/+389
| | | | | | | Change-Id: Ic6722a3cae6b3b6a3933206f14e0b6f6613609d8 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> Reviewed-by: Richard Moe Gustavsen <richard.gustavsen@qt.io>
* Get rid of Qt.labs.handlers import, merge into QtQuick 2.12Shawn Rutledge2018-07-177-14/+7
| | | | | | | ... and clean up imports in examples, snippets and tests accordingly. Change-Id: I5bbe63afd2614cdc2c1ec7d179c9acd6bc03b167 Reviewed-by: Jan Arve Sæther <jan-arve.saether@qt.io>
* Teach Rectangle's gradient property to accept QGradient::PresetTor Arne Vestbø2018-07-101-0/+12
| | | | | Change-Id: Id640b596c1d8d52221f2f2be8807d6e245971bdc Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
* Merge remote-tracking branch 'origin/5.11' into devUlf Hermann2018-06-255-0/+270
|\ | | | | | | | | | | | | | | | | | | Conflicts: src/plugins/qmltooling/packetprotocol/qpacketprotocol.cpp src/quick/handlers/qquickhandlerpoint.cpp src/quick/handlers/qquicksinglepointhandler.cpp tests/auto/qml/ecmascripttests/test262 Change-Id: I8908ec8c6116ca626fbd269af7625d4c429429ca
| * Doc: Move literal codeblocks to snippet filesVenugopal Shivashankar2018-06-222-0/+56
| | | | | | | | | | Change-Id: Iff45ea6cf414717fd1cb0a194eef390a9f153838 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
| * Doc: Move the code snippets to a separate snippet fileVenugopal Shivashankar2018-06-223-0/+214
| | | | | | | | | | Change-Id: I17671563f2beebe16ae1d08552854eaf44ae43ee Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* | Make the PathView doc snippet match the animated gif betterShawn Rutledge2018-05-251-2/+2
|/ | | | | | | | | | The docs explain that PathAttribute can be used to "scale and modify the opacity of the items as they rotate", but at first glance it's confusing to see the red/black color change in the code and wonder why it is not that way in the animated preview. Change-Id: I9f441a6342cea464644876834206e2923ce0f471 Reviewed-by: Nico Vertriest <nico.vertriest@qt.io>
* Doc: Describe new 5.11 features in Image elementv5.11.0-beta4Eirik Aavitsland2018-04-131-0/+68
| | | | | | | | Add user documentation of the compressed texture file support and the file extension auto detection. Change-Id: Icfae8574dd3acba30e8275ccd6ff3438fa037868 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* Doc: correct references to snippetNico Vertriest2018-02-281-107/+0
| | | | | | | | | - replace by \quotefromfile statements from existing code - if no example in existing code: use \badcode - this makes dbransaction.js redundant Change-Id: I748fd1b3ee564556d71e9af5ca2dbc70ec37ecc2 Reviewed-by: Martin Smith <martin.smith@qt.io>
* Document when anchors.fill can and can not be usedJan Arve Saether2017-12-021-0/+74
| | | | | | | | | It seems to be a common mistake to manipulate the geometry of child items. Be more explicit about it in the documentation. Task-number: QTBUG-63303 Change-Id: I80fd4f1d194c9b001b76e0fb88877c7c0cf488da Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* PointHandler: fix and improve the docsShawn Rutledge2017-11-231-0/+79
| | | | | | | | | | The qml module tag did not make it clear that it's in Qt.labs.handlers, not officially part of QtQuick yet. Some features needed better explanations. A snippet is helpful. Change-Id: Ie6a57510390bb376f20f5c1d98d8fc4c148af71b Reviewed-by: Jan Arve Sæther <jan-arve.saether@qt.io>
* Fix outdated BSD license headerKai Koehne2017-11-157-14/+84
| | | | | Change-Id: Ib1fe267c23ea9fce9bcc0a91ed61081260338460 Reviewed-by: Liang Qi <liang.qi@qt.io>
* Merge remote-tracking branch 'origin/5.9' into 5.10Liang Qi2017-10-24129-382/+1672
|\ | | | | | | | | | | | | | | | | | | Conflicts: src/qml/qml/qqmlimport.cpp src/qml/qml/qqmlimport_p.h src/qml/qml/qqmltypenamecache.cpp Done-with: Ulf Hermann<ulf.hermann@qt.io> Change-Id: I41ba7a592b2659ddf53da6952ea3b456a7bba319
| * Fix outdated BSD license headerKai Koehne2017-10-17129-382/+1672
| | | | | | | | | | Change-Id: Icc08925454445fc9497fb3bfd2c26efe90605983 Reviewed-by: Jani Heikkinen <jani.heikkinen@qt.io>
* | Merge remote-tracking branch 'origin/5.9' into 5.10v5.10.0-beta1Liang Qi2017-10-041-1/+0
|\| | | | | | | Change-Id: I75b0099b2b9ebb5cfb6f07b43b90b598743ae033
| * Doc: let TextEdit grow vertically in ensureVisible() snippetMitch Curtis2017-10-031-1/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Binding its height to the height of the flickable means that it's only as tall as the flickable, and hence cannot be interacted with beyond a certain point. The flickable was using the correct height (paintedHeight), which meant that the entire text could be scrolled, just not interacted with. Let it assume its implicitHeight so that it can grow freely. Task-number: QTBUG-48174 Change-Id: I853d0f505466e26e3100e79ff70210fcfa247f0f Reviewed-by: J-P Nurmi <jpnurmi@qt.io> Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-11 02:21:02 +0000