aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/doc
Commit message (Collapse)AuthorAgeFilesLines
* Doc: Fix documentation warnings for Qt QuickTopi Reinio2021-02-011-10/+7
| | | | | | | | | | | - Source code for several QML modules has moved, adjust documentation configuration accordingly. - Comment out \instantiates commands referring to internal/undocumented classes. Task-number: QTBUG-90439 Change-Id: I360c8a5c02c5a03b84c77010f399d1a0e36b1263 Reviewed-by: Nico Vertriest <nico.vertriest@qt.io>
* Doc: Fix qdoc link warningNico Vertriest2021-01-271-2/+4
| | | | | | | | Path th qmllocalstorage missing in sourcedirs/headerdirs Task-number: QTBUG-90412 Change-Id: I8971e7c569e2ce3bb2c763178af6f1b546b3dc41 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Fix CI warnings qtdeclarativeNico Vertriest2021-01-211-1/+1
| | | | | | Task-number: QTBUG-90439 Change-Id: I24664b27c3185c595b1ffd994cdf51b944f494ee Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Change section about writing a qmltypes fileUlf Hermann2021-01-201-1/+1
| | | | | | | | | | | You should not write qmltypes files manually. We only document their existence and that you should add them to manually written qmldir files now. Change-Id: I434398656179806c3e57724324aba38738384e1d Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> Reviewed-by: Andrei Golubev <andrei.golubev@qt.io>
* Remove the qmake project filesFabian Kosmale2021-01-152-23/+0
| | | | | | | | | Remove all qmake project files, except for examples which are used to test that qmake continues to work. Change-Id: Ic4abb72dc2dcd75df7a797c56056b6b3c5fe62ac Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Doc: Add links to examples of Qt Quick Particle SystemNico Vertriest2021-01-121-0/+6
| | | | | | | | | | Doc Using the Qt Quick Particle System did not contain links to examples. Fixes: QTBUG-29378 Pick-to: 6.0 Change-Id: I82e3a3af4925f7c8e58ce6a5c5af57b854cb9e36 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* 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. Pick-to: 6.0 5.15 Change-Id: Idcf2cdbedcac24a6890ce761c3f2a23f2c7a8dc4 Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
* Document how to use CMake for Qt QuickKai Koehne2020-12-043-1/+41
| | | | | | | Task-number: QTBUG-73058 Pick-to: 6.0 Change-Id: Ie72c1f4331ad05f31d9a646730133c97c4b15790 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* QML engine: Deprecate DefaultMethodFabian Kosmale2020-12-031-1/+3
| | | | | | | | | | | | | | | | | | | | | | Assigning objects to signal handlers can be convenient, as seen in the examples which use it together with ListView.onRemove. However, that convenience makes it hard to reason about what actually happens. Moreover, the only user of that functionality are the Animation classes, and the usage of DefaultMethod is not documented anywhere. [ChangeLog][QtQml] Assigning an object to a signal handler is deprecated. Instead, create the object, give it an id, and call the desired slot from the signal handler. For instance, instead of of ListView.onRemove: SequentialAnimation {...} use SequentialAnimation {id: removeAnimation; ...} ListView.onRemove: removeAnimation.start() A warning will be printed whenever an assignment of an object to a signal handler occurs. The warning can be controlled via the qt.qml.defaultmethod logging category. Change-Id: I001ddf4d7933871977f84a5e012d020fb043cc64 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Add documentation dependency to qtshadertoolsAndreas Buhr2020-12-021-1/+2
| | | | | | | | | Documentation links to qtshadertools. This patch adds qtshadertools to the dependencies so these links can work. Pick-to: 6.0 Change-Id: Icb059fd681e7456f3452aeba60287bfa1cc3539e Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Fix documentation links to High DPI documentationAndreas Buhr2020-12-011-1/+1
| | | | | | | | | | | The documentation on High DPI was recently rewritten, renaming several sections. This patch fixes the links which were broken by this change. Task-number: QTBUG-88533 Pick-to: 6.0 Change-Id: I30c1f801f93773e04f85d7ebb3603fafa8f4f2a0 Reviewed-by: Tor Arne Vestbø <tor.arne.vestbo@qt.io>
* Doc: Remove version numbers for import statementJerome Pasion2020-11-263-12/+11
| | | | | | | | | | | -recommend using the import statement without versions for Qt 6.0 -update use of \qml snippet without \QtMinorVersion -some language change to be neutral about versions Task-number: QTBUG-87155 Pick-to: 6.0 6.0.0 Change-Id: I3ac44f93aab3086c1a49de79ecc677beb4ef9180 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Doc: Fix documentation dependenciesTopi Reinio2020-11-251-1/+14
| | | | | | | | | | - Add missing dependency to qtquick3d - Remove qtscript, qtquickdialog dependencies - Use multiline formatting to have a clean git history of dependencies Pick-to: 6.0 6.0.0 Change-Id: If79df67ef14cce4156cd24042725e56654da4444 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Remove most examples/demos from highlighted listVolker Hilsheimer2020-11-251-7/+1
| | | | | | | | | There's nothing new in those, leave the space on top to more intersting stuff. Pick-to: 6.0 6.0.0 Change-Id: I9c349393b073e80155db594f6777778f31efdf02 Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
* Doc: Remove version numbers for import statementJerome Pasion2020-11-245-9/+16
| | | | | | | | | | -recommend using the import statement without versions for Qt 6.0 -update use of \qml Task-number: QTBUG-87155 Pick-to: 6.0 6.0.0 Change-Id: I555d582a13006c5abb6dc1e0266d2987ba79c6d8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Add Qt 6 Qt Quick QML Type changes from qtdocJerome Pasion2020-11-191-1/+99
| | | | | | | | | -changes to Qt Quick QML Types and OpenGL support -content from doc/src/qmlapp/applicationdevelopers.qdoc Task-number: QTBUG-87156 Change-Id: I3384e5bfa070c891015e5aa4af2e2c0b2dae35cf Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
* Remove extra \endlist commandJerome Pasion2020-11-181-1/+0
| | | | | | | | -fixes qdoc warnings Task-number: QTBUG-86102 Change-Id: I2e2a2f98d7127629bedc06612d6c6b4f7e57fb52 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Remove scene graph section that has only a dead linkVolker Hilsheimer2020-11-171-5/+0
| | | | | | | | Scene graph changes are documented in the section further down. Task-number: QTBUG-88152 Change-Id: I6362999e6830e05981e95af78b3d2f00b5e398e3 Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
* 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>
* Add Qt 6 API changes doc from qtdocJerome Pasion2020-11-111-1/+162
| | | | | | | | | | -changes to QQuickItem and QQuickWidget -changes to scenegraph's QSG* and QQuick* APIs -content from qtdoc/doc/src/source-breaks.qdoc Task-number: QTBUG-87156 Change-Id: I5d75791b888573a4ad9a9103de56a6c3f7445c7a Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
* Rename "Porting" pages to "Changes"Jerome Pasion2020-11-091-2/+2
| | | | | | | | | | | | | | The content in the porting guides are closer to a changelog than a porting guide. At this point, it is easier for maintainers and contributors to write in a changelog than a guide. This change should help with readability and is closer to the usage of "Changes" in documentation. Part of a rename in other submodules. Task-number: QTBUG-87156 Change-Id: Ibb58a3cba5394962a5709aeb08e3701e16c7775d Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
* Doc: Fix documentation warnings for Qt QuickTopi Reinio2020-11-0510-46/+17
| | | | | | | | | | | - Remove links to modules and examples that are not part of Qt 6. - Remove links to entities marked as \internal - Add missing enum value and QML property docs where it's trivial to do so. Task-number: QTBUG-88156 Change-Id: I10a1c7bcc5fe0e2354ea69eaf24930362edb7415 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* sg docs: Add a note about direct graphics API usageLaszlo Agocs2020-11-021-0/+9
| | | | | Change-Id: I7edc83cc945a1e11d0b1197fa0b26e10b69a99c8 Reviewed-by: Andy Nichols <andy.nichols@qt.io>
* doc: Update sg rhi backend sectionLaszlo Agocs2020-10-191-5/+5
| | | | | | | | Use the now preferred GraphicsApi enum value (e.g. Vulkan instead of VulkanRhi). Drop a reference to the long gone QSG_RHI env.var. Change-Id: I233611b40186884a70e9680b3dfef7284b3e3c73 Reviewed-by: Andy Nichols <andy.nichols@qt.io>
* doc: Don't overwrite native interface docsTor Arne Vestbø2020-10-151-1/+1
| | | | | | | | It doesn't look like qdoc can document the Quick specific namespace docs. Change-Id: Ic3eca2d0834c0a461f696762070e9f099e3e2641 Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
* Doc: Update the depends listVenugopal Shivashankar2020-09-211-1/+1
| | | | | | | | Some of the modules are not part of the 6.0 release. Change-Id: I1a7ce0fb34b579b2eb08c8e977e67930f561ef44 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Add porting guides for all modules to porting guidePaul Wicking2020-09-161-0/+46
| | | | | | | Task-number: QTBUG-84051 Change-Id: Iffc8774898dba5bda329fa572289cc0134fddb6f Reviewed-by: Kai Koehne <kai.koehne@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Remove qml statemachine plugin from qtdeclarativeKarsten Heimrich2020-08-231-2/+1
| | | | | | Task-number: QTBUG-80316 Change-Id: I584b699a1eec88117f343870bd2cd01075da64f7 Reviewed-by: Maurice Kalinowski <maurice.kalinowski@qt.io>
* Doc: Drop dependency on qtgraphicaleffectsPaul Wicking2020-08-191-1/+1
| | | | | | | qtgraphicaleffects is not part of 6.0, drop the doc dependency. Change-Id: I5df1cd84608667f58129074b8764a575a4923109 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc:Update docs with cmake package informationNico Vertriest2020-07-021-0/+1
| | | | | | Task-number: QTBUG-85179 Change-Id: I14a1d01c8e983021461f72c5108383f4b277478b Reviewed-by: Paul Wicking <paul.wicking@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>
* Fix up the Scenegraph section in examples.qdocLaszlo Agocs2020-06-241-8/+6
| | | | | | | | Add the newly introduced custommaterials example. The list was out of date in other ways as well, fix it all up. Change-Id: I4dc6911930b834a8ac9992042605ceebcb5e450c Reviewed-by: Paul Olav Tvete <paul.tvete@qt.io>
* Rename setSceneGraphBackend to setGraphicsApiLaszlo Agocs2020-06-222-3/+3
| | | | | | | | | | | | | | | | ...and fix up the docs. The string-based setSceneGraphBackend() stays of course (the docs have been enhanced, however). The GraphicsApi enum-based overload is now renamed to setGraphicsApi(). Using the same name for both functions is a historical artifact, reflecting the evolution (5.0 - 5.8 - 5.14). In 6.0 we can give it a more appropriate name, since it does not have much to do with "backends" from the user's perspective. Change-Id: Id75dbf81f50a148797e5b5de9be4000153737473 Reviewed-by: Andy Nichols <andy.nichols@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>
* docs: Clean up some 5.14-era RHI-being-optional referencesLaszlo Agocs2020-06-023-46/+41
| | | | | Change-Id: Ic46382263c3b12d3b4d158d6e269192508d01924 Reviewed-by: Eirik Aavitsland <eirik.aavitsland@qt.io>
* Remove CustomParticleEirik Aavitsland2020-06-021-4/+3
| | | | | | | | | The implementation is intertwined with the direct GL path and not really portable to RHI. Fixes: QTBUG-78574 Change-Id: I6ac8707544c19a24661f07e0e6d2fc405e49cbff Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
* Doc: Fix typos that cause QDoc warningsPaul Wicking2020-05-181-2/+2
| | | | | Change-Id: I496e4a7fb17e7d7fb93f0f50f99e332f1456a190 Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
* Document qmlformatMaximilian Goldstein2020-05-151-0/+16
| | | | | | Fixes: QTBUG-84218 Change-Id: I354737d839e8ebe498fbbe3d3777c0826987436e Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Add qmllint documentationFabian Kosmale2020-05-141-1/+25
| | | | | | | Fixes: QTBUG-84217 Change-Id: I9c5dccc05555aca70779208d8b215006ccf4eabb Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* Remove qtxmlpatterns reference from qdocconfFabian Kosmale2020-05-111-1/+1
| | | | | | | Change-Id: I922a8f2cf777f4da28200f538bc03c60528b57f5 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> Reviewed-by: Simon Hausmann <hausmann@gmail.com> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Remove the 'windows' render loopLaszlo Agocs2020-05-041-23/+17
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | For compatibility, QSG_RENDER_LOOP=windows shows a warning and uses basic. For OpenGL proper, threaded is the default on Windows since Qt 5.5, so this will not affect there in any way. By default the windows loop was only used with ANGLE, or a non-standard opengl32 implementation like the Mesa llvmpipe shipped with the pre-built Qt packages. (and only on Windows, as the name suggests, even though the implementation of this loop is not tied to Windows in any way) For these we default to basic now. This will make no difference in practice: The windows render loop's value is that it takes the custom animation driver (advanced per frame, assuming that vsync-based throttling is active) approach from the threaded loop, while behaving like basic otherwise, thus providing smoother animations compared to basic, in theory. But due to its relatively little use (not the default since 5.5), ANGLE being removed in the near future, and not making much sense for the software rasterizer cases (those will have bigger problems than smoothly advancing animations, often providing no vsync, so they are better off with basic anyways), it makes no sense to invest into adding QRhi support for this loop too. Task-number: QTBUG-78578 Task-number: QTBUG-82997 Change-Id: I8ccd2e5e375799df5bb5018df247aa5b8197032a Reviewed-by: Andy Nichols <andy.nichols@qt.io>
* Doc: Remove imagePaul Wicking2020-05-041-0/+0
| | | | | | | | | | Image wasn't removed when the example moved to qtxmlpatterns. Pick-to: 5.15 Task-number: QTBUG-83958 Change-Id: I5f5d684ebe8bb1a3f089c5fffb42be58c4ee7bf8 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Change documentation to mention QRegularExpressionLars Knoll2020-04-021-1/+1
| | | | | | | | As QRegExp is going away in Qt 6. Change-Id: Ifb98da762b3d6cb593ec53cc23f7525cb2e9f595 Reviewed-by: Samuel Gaist <samuel.gaist@idiap.ch> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Merge "Merge remote-tracking branch 'origin/5.15' into dev"Qt Forward Merge Bot2020-03-183-11/+0
|\
| * Merge remote-tracking branch 'origin/5.15' into devQt Forward Merge Bot2020-03-183-11/+0
| |\ | | | | | | | | | | | | | | | | | | Conflicts: tools/qmllint/findunqualified.cpp Change-Id: I2593b5cc0db1d14e0c944aec4b88a80f46f5b0c1
| | * Doc: Remove \contentspage commandsTopi Reinio2020-03-153-11/+0
| | | | | | | | | | | | | | | | | | | | | | | | The command is deprecated and has no effect apart from generating a documentation warning. Change-Id: I4a873359a8e795b8807371470b2da148a4077cbe Reviewed-by: Paul Wicking <paul.wicking@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>
* | Merge remote-tracking branch 'origin/5.15' into devQt Forward Merge Bot2020-03-093-42/+119
|\| | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: src/qml/compiler/qqmlirbuilder_p.h src/qml/qml/qqmlpropertycachecreator_p.h src/qmltyperegistrar/qmltypesclassdescription.cpp src/qmltyperegistrar/qmltypesclassdescription.h src/qmltyperegistrar/qmltypescreator.cpp src/quick/items/qquicktext_p.h src/quick/util/qquickvaluetypes_p.h Change-Id: Ic209741592e7b85820bf3845722023a190ebc1c5
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-21 15:02:21 +0000