aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/doc/src
Commit message (Collapse)AuthorAgeFilesLines
* 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>
* | 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>
* | Merge remote-tracking branch 'origin/5.12' into devQt Forward Merge Bot2019-01-105-8/+3
|\| | | | | | | | | | | | | Conflicts: .qmake.conf Change-Id: I6b2539bf17d3e9bc66d96b53c1bce95680113ed8
| * Doc: Fix link issuesNico Vertriest2019-01-035-8/+3
| | | | | | | | | | 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>
* Doc: Fix linking to Qt Quick ControlsTopi Reinio2018-10-301-2/+1
| | | | | | | | | | 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>
* 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-011-2/+2
| | | | | | | | | | 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-251-5/+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>
* | Doc: Add the youtube tutorial videoVenugopal Shivashankar2018-09-051-3/+4
| | | | | | | | | | | | | | | | | | The \youtube macro embeds the video within the online docs and the thumbnail JPG is used for the offline version. Change-Id: Ic26fb8b517b50e3a8be2b80b1627823fdbd37909 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* | Merge remote-tracking branch 'origin/5.11' into 5.12Simon Hausmann2018-08-273-6/+606
|\| | | | | | | Change-Id: I850a8e9c99bb10216fa315cca693d78a82b2b5b2
| * Doc: add list of SVG colors to color QML Basic Type pageMitch Curtis2018-08-092-2/+602
| | | | | | | | | | | | | | | | | | The page that we link to used to contain a list of the colors, but it doesn't anymore, so we'll add our own. Change-Id: I1160e3de7f4ab0ead727b0261edafda30cce3270 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Martin Smith <martin.smith@qt.io>
| * Doc: Rename section titles to avoid auto-linker issuesPaul Wicking2018-08-071-4/+4
| | | | | | | | | | | | | | | | | | The section titles cause links that should target QML types to link to the page sections. Renaming the section titles to link correctly. Task-number: QTBUG-59445 Change-Id: Idde600c87621d270c4e25a5dac0a55fbfc7a96ef Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* | Doc: correct statement on Qt Quick QML types reference pageMitch Curtis2018-08-211-1/+1
| | | | | | | | | | | | | | | | Not _all_ QML types in Qt Quick inherit from QQuickItem; a decent amount inherit from QObject. Change-Id: I47bfe69b8d2f335adf54b71f6a56b1dbc80c7d65 Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
* | Rearrange docs: Pointer Handlers -> Input HandlersShawn Rutledge2018-07-264-95/+45
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | At QtCS 2018 we decided to rename Pointer Handlers to Input Handlers and include the Keys attached property as part of this set (since we plan to have attached-property pointer handlers too, eventually). It's no longer a module, it's included in Qt Quick 2.12. We need to start promoting Input Handlers and reducing the visibility of legacy stuff like MouseArea and MultiPointTouchArea (in the hope of being able to deprecate them eventually). Task-number: QTBUG-66651 Change-Id: I801351ac2531191cbb1faac9318441c67a109af6 Reviewed-by: Jan Arve Sæther <jan-arve.saether@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* | Doc: bump import version to 2.12Shawn Rutledge2018-07-243-10/+10
|/ | | | | | | | | This is important since 2.12 is LTS and because Input Handlers are now included. Change-Id: I09417eb873ed7971fc768dddb916954d46091a6b Reviewed-by: Jan Arve Sæther <jan-arve.saether@qt.io> Reviewed-by: Martin Smith <martin.smith@qt.io>
* Doc: update link to point to Controls 2 rather than Controls 1Mitch Curtis2018-07-161-1/+1
| | | | | | Change-Id: I2dd5877754b3ccbc975e5cdae5e80d1db28f8e48 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
* Doc: Fix broken link to examplePaul Wicking2018-07-131-1/+1
| | | | | | Task-number: QTBUG-69438 Change-Id: I4ac191029eccc97e7b9947ec56bf008562c9f4ef Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* Item, QQuickItem: document which properties are used in map functionsMitch Curtis2018-07-101-0/+6
| | | | | Change-Id: Idf3aecf88319a2967ca51985003be32c7e7ef42a Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
* Doc: add section about type safetyMitch Curtis2018-07-101-0/+30
| | | | | Change-Id: I6ae5be8480ff817651c66a1617dceeefb96e5712 Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
* Doc: clarify and trim down the list in "Using Qt Quick Layouts"Mitch Curtis2018-07-091-6/+5
| | | | | | | | | - Clarify that anchors are fine for layouts that are not children of a layout. - Remove redundant list item. Change-Id: I187875ff3970620a6089716c5d9f41cc80997b07 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Doc: replace "KiSS" section with Coding ConventionsMitch Curtis2018-07-061-6/+5
| | | | | | | | | | The section currently doesn't have any content, and as such, it doesn't provide much value. The coding conventions link in the related information sub-section is useful information to have, however, so we should keep that. Change-Id: Idc62b41d098528898cc8d65bfaf73879caa14b86 Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
* Doc: Mark the \snippet statements with a .pro fileVenugopal Shivashankar2018-07-021-0/+2
| | | | | | | | | Conditionally excluding such statements is required to avoid irrelevant content in documentation in some cases. Change-Id: If6751608dc438de6f7cc0376ffc36f8d994afba6 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Doc: Fix broken linksVenugopal Shivashankar2018-06-282-2/+2
| | | | | | Change-Id: I3c09f8172fd79f3517b338e2d097bdbd88f325d6 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* Doc: Move literal codeblocks to snippet filesVenugopal Shivashankar2018-06-221-6/+2
| | | | | Change-Id: Iff45ea6cf414717fd1cb0a194eef390a9f153838 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: link to integration flowchart in "Interacting with QML from C++"Mitch Curtis2018-05-221-2/+2
| | | | | | | | | | Replace the link to the more specific "Integrating QML and C++" page with a link to "Choosing the Correct Integration Method Between C++ and QML", as the flowchart is a much quicker way for users to determine the correct approach for their use case. Change-Id: Ia2c269f9149d801644407bba7388624d69a75564 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Doc: add "Best Practices for QML and Qt Quick" to best-practices groupMitch Curtis2018-04-281-0/+1
| | | | | | | So that it shows up on http://doc.qt.io/qt-5/best-practices.html Change-Id: I0968362dc055adb6b882c1b7dc6a4a4d7f8b6351 Reviewed-by: J-P Nurmi <jpnurmi@qt.io>
* Document latest QtQuick.Test import version to be 2.11Kai Koehne2018-04-201-2/+2
| | | | | | | | | Since commit 214fbaa57b73296a0 the latest minor version of the import is automatically the Qt minor version, so let's also document this. Change-Id: Ie2fe1d172898bd0d51f0841c078abd1f8ab8d744 Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
* Document latest QtQuick.Layouts import to be 2.11Kai Koehne2018-04-202-3/+3
| | | | | | | | | Since commit 214fbaa57b73296a0 the latest minor version of the import is automatically the Qt minor version, so let's also document this. Change-Id: I4131a399cca7c66b0e9df549f14be43eeaa94af3 Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
* Document latest QtQuick.Particles import version to be 2.11Kai Koehne2018-04-201-3/+3
| | | | | | | | | Since commit 214fbaa57b73296a0 the latest minor version of the import is automatically the Qt minor version, so let's also document this. Change-Id: I9443be62da5cc9fc281e167f38fa299c73115eda Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
* Doc: Bump QtQuick import to 2.11Kai Koehne2018-04-191-3/+3
| | | | | | Task-number: QTBUG-67786 Change-Id: Ie371d4c931ce31f728cdd960ad454e26c40cc4ed Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
* Doc: Add Licensing section to "Qt Quick Test", "Qt Quick Layouts"Kai Koehne2018-04-171-0/+9
| | | | | | | Mention licenses in the remaining landing pages. Change-Id: I3754d959db9d9e4914e50d670f159eba1afa7596 Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
* Doc: Improve the "Interacting with QML from C++" sectionMitch Curtis2018-04-091-4/+20
| | | | | Change-Id: I8930314179514d091a39640551f2816a23cbebc8 Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
* Doc: Change the section title to avoid a linking conflictVenugopal Shivashankar2018-04-061-1/+1
| | | | | | | Otherwise, all links to the Qt Quick Layouts module page will lead here. Change-Id: I04c14ca9a28ebf0e19e489229352ba4d11f24859 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* Doc: Add a section on scalable application UIVenugopal Shivashankar2018-04-052-3/+46
| | | | | | | | Also fixed a grammar issue and a few broken links. Change-Id: I807da06536d6a9101e67fd73858cbbfe90d00663 Reviewed-by: J-P Nurmi <jpnurmi@qt.io> Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* Doc: provide an example of the C++ - QML interaction pathMitch Curtis2018-03-211-11/+115
| | | | | Change-Id: Ib65bb9edbcbd1172cc620243b078c9691d961828 Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
* Doc: mention alternative syntax for resource filesMitch Curtis2018-03-211-15/+35
| | | | | | | | This syntax allows creating distinct .qrc files without having to create them manually. Change-Id: Iab7c76fd162bb7f39b42fb983f85d74fce3036d4 Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
* Rename best practices page to "Best Practices for QML and Qt Quick"Mitch Curtis2018-03-201-5/+5
| | | | | | | | | | | Qt Quick is most often used via its QML types, and since some of the tips on this page are not specific to Qt Quick but apply to QML in general, it makes sense to list them both on the same page for convenience and completeness. Change-Id: I6d61b98ffd7e52dc28b33ef00a78dd745f39820a Reviewed-by: Frederik Gladhorn <frederik.gladhorn@qt.io> Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
* Remove qtquick-guidelines, move contents into qtquick-bestpracticesMitch Curtis2018-03-202-50/+15
| | | | | | | | | | | | This page doesn't offer much on its own, and qtquick-bestpractices.qdoc is already starting to gather useful guidelines, so move its contents there. Having everything related to best practices/guidelines on one page means less clicking between these "overview" pages, which I think is a bit of a problem currently. Change-Id: I18316dc177a6a7eb5a031e178cd0aed31dfa63ae Reviewed-by: J-P Nurmi <jpnurmi@qt.io> Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
* Doc: improve "Separate UI from Logic" sectionMitch Curtis2018-03-201-17/+31
| | | | | Change-Id: I0d36e009b4551e45e5e7fda6c95fc3fbfabfe1a5 Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
* Doc: simplify "Qt Quick Best Practices" introduction paragraphMitch Curtis2018-03-201-4/+4
| | | | | | | | We don't need to mention specific challenges in the introduction. Change-Id: I03eec5fe543fbf0b1859850424eba8cfa9f134a5 Reviewed-by: J-P Nurmi <jpnurmi@qt.io> Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
* Doc: reorganize "Bundle Application Resources" sectionMitch Curtis2018-03-201-18/+30
| | | | | | | | | | Start off with the "direct" syntax, as that's the most straight-forward. Then, explain why it can be inefficient and introduce the concept of separate .qrc files. Change-Id: I63c2c3e188db04ed58e816f7e69ab98a42196ff1 Reviewed-by: hjk <hjk@qt.io> Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>