aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/doc
Commit message (Collapse)AuthorAgeFilesLines
* 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: add list of SVG colors to color QML Basic Type pageMitch Curtis2018-08-093-2/+605
| | | | | | | | | 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: 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: add a section that demonstrates various contentX/contentY statesMitch Curtis2018-07-0410-0/+0
| | | | | | | This makes it easier to visualize how the properties work. Change-Id: I04cb1a99a1f831e5c892cb27e4a0cd127fe450e0 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@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-223-6/+58
| | | | | 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>
* 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: 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: 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-053-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: Drop the use of QT_PLUGIN_PATH in documentation configTopi Reinio2018-03-282-3/+5
| | | | | | | | | | | | This caused build issues in certain configurations. We don't actually need it, as we can rely on the base Qt include path instead. Also move the custom header under src/quick/doc and rename it. Task-number: QTBUG-67342 Change-Id: Id75e140f9d286f6a47c2ecc039bfb52b13a92608 Reviewed-by: Simon Hausmann <simon.hausmann@qt.io> Reviewed-by: Martin Smith <martin.smith@qt.io>
* doc: Fix qtquick.qdocconf to include stuff for qtquickwidgetsMartin Smith2018-03-221-0/+4
| | | | | | | | | | A fake module header is added for qtquick named QtQuick_pch.h, and qtquick.qdocconf is modified to use this fake module header instead of using QtQuick. The fake module header includes QtQuick and QtQuickWidgets. Change-Id: I2a3bd4ad32bdad878f8e7049cf71c393517547a0 Reviewed-by: Topi Reiniö <topi.reinio@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>
* Fix grammar in "Qt Quick Best Practices"Mitch Curtis2018-03-201-2/+2
| | | | | Change-Id: I3ba63110a3674675f44feca51ba98128844e1904 Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
* Doc: Add Qt Quick usage guidelinesVenugopal Shivashankar2018-03-134-0/+368
| | | | | | Task-number: QTBUG-15757 Change-Id: I9193ed459ced63cceb819a66f5a8c76042f455b6 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* Fix typos, punctuation, and grammar in sprites.qdocMitch Curtis2018-03-131-30/+30
| | | | | Change-Id: Ie3c24958e96c54cd91cd4a752638c11764338028 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Doc: Change QtQuickTest to QtQmlTestMartin Smith2018-03-021-1/+1
| | | | | | | | | | | | | The creation of module QtQmlTest remains incomplete, but this update improves the situation a bit. In qtqmltest.qdocconf, all instances of QtQuickTest are changed to QtQmlTest. In qtquick.qdocconf, qtqmltest is added as a dependency. This remains incomplete, because the module header is still called QtQuickTest, but the number of qdoc warnings in qtdeclarative is reduced. Change-Id: Id545f9b5ecb2165d3f0972a059a8a4a4cfd52f2f Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* doc: Fix link to page titleMartin Smith2018-03-021-1/+1
| | | | | | | Removed the word Overview, which had been deleted from the title. Change-Id: I1af6cc48b0f3c38e2fabe11346b023de317b1fd7 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* doc: Add qtquickcontrols2 to the dependency listMartin Smith2018-03-021-1/+1
| | | | | | | | qtquickcontrols2 was missing from the dependency list in qtquick.qdocconf. Change-Id: I29231c097ca9f748ed8b3ae49100466318da8352 Reviewed-by: Topi Reiniö <topi.reinio@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>
* Doc: add code examples and GIFs of AnimatedSpriteMitch Curtis2018-02-284-0/+0
| | | | | Change-Id: Ie1c7541e526e2777af83a46d6ff01b3f7a9a0d3e Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
* doc: QtQuick must see the index file for QtSqlMartin Smith2018-02-231-1/+1
| | | | | | | The qdocconffile for QtQuick is updated to include the dependency on QtSql. Change-Id: I9d0315e4d52958bd213afa611c2898b386c4c728 Reviewed-by: Martin Smith <martin.smith@qt.io>
* Merge remote-tracking branch 'origin/5.10' into 5.11Liang Qi2018-02-121-0/+4
|\ | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: src/imports/shapes/qquickshape.cpp src/imports/shapes/qquickshape_p_p.h src/qml/compiler/qqmlpropertycachecreator_p.h src/qml/jsruntime/qv4value_p.h src/quick/items/qquickloader_p.h tests/auto/qml/qqmlecmascript/tst_qqmlecmascript.cpp tools/qmlprofiler/qmlprofilerapplication.cpp Change-Id: Iafc66ae84bf78630ed72a986acb678e9d19e3a69
| * Merge remote-tracking branch 'origin/5.9' into 5.10Liang Qi2018-02-021-0/+4
| |\ | | | | | | | | | Change-Id: I41ca9120a470a905c2f5c168c1de4cf970fa0fff
| | * Add a link to the "Using C++ Models in QML Tutorial" videoMitch Curtis2018-02-011-0/+4
| | | | | | | | | | | | | | | Change-Id: I1e1d8f3996bf2d187491d50a76852fb82257a42b Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* | | Merge remote-tracking branch 'origin/5.10' into devLiang Qi2018-02-022-27/+29
|\| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: src/plugins/qmltooling/qmldbg_profiler/qqmlprofilerservice.cpp src/qml/compiler/qqmlirbuilder.cpp src/qml/compiler/qqmlirbuilder_p.h src/qml/compiler/qqmltypecompiler.cpp src/qml/compiler/qv4codegen.cpp src/qml/compiler/qv4codegen_p.h src/qml/compiler/qv4compileddata_p.h src/qml/compiler/qv4compiler.cpp src/qml/compiler/qv4compilercontext_p.h src/qml/compiler/qv4isel_moth.cpp src/qml/compiler/qv4jsir.cpp src/qml/compiler/qv4jsir_p.h src/qml/jit/qv4isel_masm.cpp src/qml/jsruntime/qv4engine.cpp src/qml/jsruntime/qv4functionobject.cpp src/qml/jsruntime/qv4runtimecodegen.cpp src/qml/jsruntime/qv4script.cpp src/qml/jsruntime/qv4script_p.h src/qml/qml/qqmltypeloader.cpp src/quick/items/qquickanimatedimage.cpp src/quick/items/qquickanimatedimage_p_p.h src/quick/scenegraph/compressedtexture/qsgpkmhandler.cpp tests/auto/qml/qmlplugindump/qmlplugindump.pro tests/auto/qml/qmlplugindump/tst_qmlplugindump.cpp tools/qmlcachegen/qmlcachegen.cpp tools/qmljs/qmljs.cpp Done-with: Shawn Rutledge <shawn.rutledge@qt.io> Done-with: Lars Knoll <lars.knoll@qt.io> Done-with: Ulf Hermann <ulf.hermann@qt.io> Change-Id: I010e6525440a85f3b9a10bb9083f8e4352751b1d
| * | Merge remote-tracking branch 'origin/5.9' into 5.10Liang Qi2018-01-242-27/+29
| |\| | | | | | | | | | Change-Id: I37bc7afea415261639b71e7b8dfc9177fdd4cb62
| | * Doc: Do make 'Licenses and Attributions' valid for multiple Qt versionsKai Koehne2018-01-221-1/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The Qt documentation is supposed to be valid for older Qt versions too. Anyhow, the generated attributions are only valid for the exact version the documentation was generated from, so make this explicit. Also mention since when the libraries are under LGPL3/GPL3. Change-Id: Iec8f67e5e43be456cc77283ca6d2a7ebe142f501 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
| | * Doc: Rename Renderer page to 'Scene Graph OpenGL Renderer'Kai Koehne2018-01-221-5/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | While the architecture might be similar for e.g. the DirectX Renderer, the details are only valid for OpenGL backend. Make this explicit by renaming the page. Change-Id: I24bf82de35099ae14eb6bfb9d58b422b476636ac Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-04 17:56:55 +0000