aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/doc
Commit message (Collapse)AuthorAgeFilesLines
* doc: Add missing directories to qdocconf filesMartin Smith2019-09-161-0/+2
| | | | | | | | These might not be complete yet, but they do fix the qdoc errors. Change-Id: I75b0f0f7709a371149a6f7c82adfff9fe88408ea Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Merge remote-tracking branch 'origin/5.13' into 5.14Liang Qi2019-09-124-13/+13
|\ | | | | | | | | | | | | | | | | | | | | | | Conflicts: src/qml/jsruntime/qv4engine.cpp src/quick/handlers/qquicktaphandler.cpp src/quick/items/qquicktableview.cpp Done-With: Richard Moe Gustavsen <richard.gustavsen@qt.io> Done-With: Ulf Hermann <ulf.hermann@qt.io> Done-With: Shawn Rutledge <shawn.rutledge@qt.io> Change-Id: If9558a33f01693ce96420c094e0b57dfff0626cd
| * Doc: Replace the "Qt Quick Controls 2" instancesVenugopal Shivashankar2019-08-224-13/+13
| | | | | | | | | | | | | | | | This is one of the several commits, replacing the "Qt Quick Controls 2" instances with "Qt Quick Controls". Change-Id: I2e1f1e53bd7756331320f5447dbdabef36dfcb66 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* | Refer to recently added examples into the scenegraph docsLaszlo Agocs2019-09-081-0/+13
| | | | | | | | | | Change-Id: Ib87fde45e5ebfed596c5d0146d6987e5390bac64 Reviewed-by: Andy Nichols <andy.nichols@qt.io>
* | Add metaltextureimport exampleLaszlo Agocs2019-09-081-3/+4
| | | | | | | | | | Change-Id: I499c21083faf6096a0dc3b8ee5682dd5cbcd3ce7 Reviewed-by: Andy Nichols <andy.nichols@qt.io>
* | CMake: Document newly introduced QT5_IMPORT_QML_PLUGINS functionAlexandru Croitor2019-08-282-0/+62
| | | | | | | | | | | | | | 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-203-42/+95
|\| | | | | | | Change-Id: I9ce3eee3d6f88783b9e20110a2814bee805291a4
| * Doc: Correct error in doc Transition QML TypeNico Vertriest2019-08-192-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>
| * Doc: Correct wrong code in qml snippetNico Vertriest2019-08-191-1/+1
| | | | | | | | | | | | | | | | | | Replace QT_TRANSLATE_NOOP with equiv. qStr statement Task-number: QTBUG-56875 Change-Id: I80581ecf05a25e0c69da434d3e548261eac5811e Reviewed-by: Frederik Schwarzer <schwarzer@kde.org> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* | Add an initial set of scenegraph docs for the rhiLaszlo Agocs2019-08-174-135/+255
| | | | | | | | | | | | | | | | | | | | Just the basics for now. Start moving away of the assumption of default backend = direct OpenGL, but limit the amount of RHI-specific details for now. This should be sufficient for the first preview in 5.14. Change-Id: I94e80d5fbed1269f7e8911284c28ac5fbc858be7 Reviewed-by: Christian Strømme <christian.stromme@qt.io>
* | Merge remote-tracking branch 'origin/5.13' into devLiang Qi2019-07-266-2/+4
|\| | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: src/quick/handlers/qquickpointerdevicehandler.cpp src/quick/scenegraph/qsgdefaultglyphnode.cpp src/quick/scenegraph/qsgdefaultglyphnode_p.cpp src/quick/scenegraph/qsgdefaultglyphnode_p_p.h tests/auto/qml/qjsengine/tst_qjsengine.cpp Done-With: Jan Arve Sæther <jan-arve.saether@qt.io> Done-With: Laszlo Agocs <laszlo.agocs@qt.io> Change-Id: I35749152f8dce44b9af8d52b1283629879010f11
| * doc: Update the diagram to mention the correct beforeSynchronizing() signalKavindra Palaraja2019-07-176-2/+4
| | | | | | | | | | | | | | | | Fixes: QTBUG-76602 Change-Id: I82f92c5a8e3d2f5cbc3f00516d119be532add302 Reviewed-by: Andy Shaw <andy.shaw@qt.io> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
* | Merge remote-tracking branch 'origin/5.13' into devQt Forward Merge Bot2019-07-122-1/+2
|\| | | | | | | | | | | | | | | Conflicts: src/qml/qml/qqmltypeloader.cpp src/quick/scenegraph/qsgopengldistancefieldglyphcache.cpp Change-Id: I1a226d8738db2ec06e3cef240a0e040e7c144cad
| * Doc: Replace example file lists with links to code.qt.ioTopi Reinio2019-07-091-0/+1
| | | | | | | | | | | | Task-number: QTBUG-74391 Change-Id: I8cd8371e820efbe90d486aef4a68e17c92fd93ea Reviewed-by: Paul Wicking <paul.wicking@qt.io>
| * Doc: Replace old link with an existing featureKavindra Palaraja2019-07-081-1/+1
| | | | | | | | | | | | | | | | While Gimp's Registry no longer exists, the SpriteSheet plugin is still there. Fixes: QTBUG-76844 Change-Id: I3f96ef654f6b64cb2919fe011467f2fa85433eaf Reviewed-by: Ulf Hermann <ulf.hermann@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-06-111-307/+281
|\| | | | | | | | | | | | | | | | | | | Conflicts: src/qml/jsruntime/qv4value_p.h src/qml/qml/qqmlmetatype.cpp src/qml/qml/qqmltypewrapper.cpp src/quick/items/qquicktableview.cpp Change-Id: I684f8e01a711580512848bf1253f39b39fcbf4c7
| * Merge remote-tracking branch 'origin/5.12' into 5.13Qt Forward Merge Bot2019-05-261-307/+281
| |\ | | | | | | | | | Change-Id: I208cd36d2b7add94f36e4d86cf0c790a1e4a7e86
| | * Doc - minor cleanupKavindra Palaraja2019-05-211-307/+281
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Small fixes to improve readability * Fixed some typos * Updated the link to an old-ish MSDN article * Used a list instead of a long paragraph in the introduction area * Swapped a long list for a table for environment variables Change-Id: Id7eeee5c5b24f96e4577212a385cfa766e809d1f Reviewed-by: Simon Hausmann <simon.hausmann@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>
* | Merge remote-tracking branch 'origin/5.12' into 5.13v5.13.0-beta3Qt Forward Merge Bot2019-04-151-3/+9
|\| | | | | | | | | | | | | | | | | Conflicts: src/3rdparty/masm/assembler/LinkBuffer.h src/qmltest/doc/src/qtquicktest-index.qdoc tests/auto/qml/qqmllanguage/tst_qqmllanguage.cpp Change-Id: I7d83ad95cf489dda794dd7a0a33bad3ef3b05609
| * Document macOS threaded render loop availabilityMorten Johan Sørvig2019-04-121-3/+9
| | | | | | | | | | | | | | | | | | | | The threaded render loop (or specifically QPlatformIntegration::Capability::ThreadedOpenGL) is disabled when building with Xcode 10 (10.14 SDK). Task-number: QTBUG-75037 Change-Id: Ib0b4cab56c053958fcae5616cbb496602efbf5e1 Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
* | Doc: Remove testlib sources from Qt Quick documentation configTopi Reinio2019-04-101-1/+0
| | | | | | | | | | | | | | | | Qt Quick Test is now its own documentation module; including the path in both modules resulted in the duplication of QML types. Change-Id: Ib947bb1fa136cc81328dcb46832f616adb1cefce Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* | Merge remote-tracking branch 'origin/5.12' into 5.13Qt Forward Merge Bot2019-03-181-1/+1
|\| | | | | | | | | | | | | Conflicts: src/qml/compiler/qv4codegen.cpp Change-Id: I66b7db42bf208855889094ace0267326595ce03c
| * Doc: Link to the correct example in Qt Quick States topicTopi Reinio2019-03-141-1/+1
| | | | | | | | | | | | | | | | | | While there is no dedicated example for states and transitions for Qt Quick, the Animation example covers these concepts. Fixes: QTBUG-74428 Change-Id: I00f6ca54123011599ebbb6b7bc53d3104b1586ca Reviewed-by: Mitch Curtis <mitch.curtis@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>
* | Merge remote-tracking branch 'origin/5.12' into devLiang Qi2019-01-291-4/+5
|\| | | | | | | | | | | | | | | | | | | | | | | Conflicts: src/3rdparty/masm/yarr/YarrJIT.cpp src/qml/compiler/qv4instr_moth.cpp src/quick/handlers/qquicksinglepointhandler_p.h src/quick/handlers/qquicktaphandler.cpp src/quick/items/context2d/qquickcontext2d.cpp Done-With: Ulf Hermann <ulf.hermann@qt.io> Change-Id: I109453131f9f0a05316ae37c7d6ed1edc8c0f9d4
| * Merge 5.12 into 5.12.1Kari Oikarinen2019-01-086-9/+4
| |\ | | | | | | | | | Change-Id: Ic746fbce93430867e2eda4bc7155d34e20a4aa2b
| * | Doc: Restore QtQuick.Shapes documentationTopi Reinio2018-12-101-4/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Sources for this module were recently moved. Add the new directory to documentation config to make the documentation generate again. Also, make the documented QML module version track the minor version of Qt. Change-Id: I56f439c141cbf39639a97d44d328c068fff6e96e Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
* | | Merge remote-tracking branch 'origin/5.12' into devQt Forward Merge Bot2019-01-106-9/+4
|\ \ \ | | |/ | |/| | | | | | | | | | | | | Conflicts: .qmake.conf Change-Id: I6b2539bf17d3e9bc66d96b53c1bce95680113ed8
| * | Doc: Fix link issuesNico Vertriest2019-01-036-9/+4
| |/ | | | | | | | | Change-Id: I738b9da5335afb048d2eda2edf2be5095a91d7e5 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* / Doc: Fix Qt Quick Test documentationMitch Curtis2018-12-141-16/+0
|/ | | | | | | | | | | | | | | | | | - Add qtquicktest-cppapi.qdoc for the C++ API landing page. - Add qtquicktest.qdoc for the QQuickTest namespace. - Add qtquicktest-qmltypes.qdoc for the QML types landing page. - Add ../../imports/testlib to the sourcedirs variable so that the QML files can be found. - Add a "Reference" section to qtquicktest-index.qdoc that has links to the QML and C++ pages. - Add more targets so that we can reliably link to them while keeping the nice short section names. - Fix minor issues in existing documentation. - Link to the QML API docs from the C++ API docs. Change-Id: I5fc3c90105b095d9ea84c3f76e6c7ba0a47c2695 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Move xmllistmodel to xmlpatternsv5.12.0-beta4Frederik Gladhorn2018-11-052-97/+1
| | | | | | | | | 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 linking to Qt Quick ControlsTopi Reinio2018-10-302-3/+2
| | | | | | | | | | The dependency to Qt Quick Controls 2 is now simply 'qtquickcontrols'. Remove the dependency to old version 1 of Controls, and update linking to Controls examples accordindly. Task-number: QTBUG-70333 Change-Id: I2f42031ab8aea90332b8b68537654ea761e44811 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Add WavefrontMeshEskil Abrahamsen Blomfeldt2018-10-251-0/+0
| | | | | | | | Add a mesh type for use with ShaderEffect which loads the geometry from an .obj file. Change-Id: I53c9149fc56cdab4a36fccc087abf54a6b50f42f Reviewed-by: Andy Nichols <andy.nichols@qt.io>
* Enhance the documentation about changing model data from QMLNils Jeisecke2018-10-082-28/+80
| | | | | | | | | | | | | | | | Since 4253f11774ed113cfc69794435e7e66b373bc2cd (5.6), write access to QQmlListModel model properties is implemented. QAbstractItemModel derived models seem to have implemented setData invocation on model property writes since 5.0. However this was never mentioned in the documentation, so it has been a rather unknown but very useful feature. Task-number: QTBUG-32064 Change-Id: I0424bd440480166f1c36ce9fbad2c36a0e73f08e Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* Merge remote-tracking branch 'origin/5.11' into 5.12Liang Qi2018-10-081-0/+9
|\ | | | | | | | | | | | | | | Conflicts: src/3rdparty/masm/yarr/YarrJIT.h src/quick/items/qquickwindow.cpp Change-Id: I551404e1558d56c0b0626346ad1c86406bff0ec7
| * QQuickItem: document which events are accepted by defaultMitch Curtis2018-10-041-0/+9
| | | | | | | | | | Change-Id: I64a2ab811b48d2a231e18c493fb1f6087fd02905 Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
* | Doc: Fix QDoc warningsPaul Wicking2018-10-012-4/+4
| | | | | | | | | | Change-Id: I19545953bde10d4ccc2f37843dcda2569dc77df4 Reviewed-by: Martin Smith <martin.smith@qt.io>
* | Doc: Remove references to Qt Quick 1Kai Koehne2018-10-011-2/+2
| | | | | | | | | | | | | | | | | | | | Qt Quick 1 is dead since Qt 5.0, so it doesn't make much sense anymore to link to different names there, or highlight behavioral differences. Task-number: QTBUG-70780 Change-Id: Iac5e0b226621f127714e722a11208ca1b21d977f Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* | Doc: Add description of QML_USE_GLYPHCACHE_WORKAROUND env varPaul Wicking2018-09-261-0/+8
| | | | | | | | | | | | Change-Id: I71e2fcaa4358a20bc6ec5b1c89a24b23549f1334 Fixes: QTBUG-59992 Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@qt.io>
* | Doc: Remove documentation for deprecated QML typesVenugopal Shivashankar2018-09-252-73/+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>
* | Limit the repeater model size for integer modelsErik Verbruggen2018-09-241-0/+1
| | | | | | | | | | | | | | | | | | Otherwise you might be able to put INT_MAX in, which would cause problems with things like memory allocations. Task-number: QTBUG-54752 Change-Id: I758d04af65049181c0c741ff42e92a6450963201 Reviewed-by: Michael Brasser <michael.brasser@live.com>
* | Doc: Use a macro to resolve the QML import versionTopi Reinio2018-09-144-27/+30
| | | | | | | | | | | | | | | | | | | | | | QDoc now supports macros for its command parameters, as well as passing parameters to \code and \qml commands. Use these together with the new \QtMinorVersion macro to automate bumping the QML import versions within documentation. Task-number: QTBUG-67818 Change-Id: I8b5300749880421a0d7cdacc1b2c0f96b3b7ef67 Reviewed-by: Kai Koehne <kai.koehne@qt.io>