aboutsummaryrefslogtreecommitdiffstats
path: root/src/quickcontrols/doc/snippets
Commit message (Collapse)AuthorAgeFilesLines
* doc, QQuickHeaderView: ensure example snippet worksRichard Moe Gustavsen2024-08-261-1/+1
| | | | | | | | | | | | | | | | | | As it stood, the qdoc marker in the example code left the final curly brace out of the snippet. A copy paste of this example would therefore not compile. This patch will make sure the brace is a part of the snippet shown in the docs. Task-number: QTBUG-123595 Pick-to: 6.2 Change-Id: I68bfac0cfc3dcecd487bfb69de07c317f787552e Reviewed-by: Santhosh Kumar <santhosh.kumar.selvaraj@qt.io> (cherry picked from commit 3968ef8650da91c8e66d1651f7891793ac3b5d74) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> (cherry picked from commit 9ecc9131ed9be2ad421e3ced0b589c00205de2d5) (cherry picked from commit 303bd79ec66a5752405c32afe0d703f119983e67)
* Controls: replace Qt.styleHints with Application.styleHintsMitch Curtis2024-08-122-2/+2
| | | | | | | | | | | | | | | | | As mentioned in QTBUG-95540, using the latter provides better type information for tooling, and avoids the "this property only exists on the object if Quick has been imported" issue. Replace QtQml import in Fluent style's Config.qml with QtQuick to provide access to the Application type. Fixes: QTBUG-126512 Change-Id: I4aac22e54f3b522f74acafd467ce22139352c9dd Reviewed-by: Ulf Hermann <ulf.hermann@qt.io> (cherry picked from commit 9335b0fd1f2358110b88127c9b34fa6867a14069) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> (cherry picked from commit d70e645ca8071789e7d1906114b96ec36233179b) (cherry picked from commit 2a40db4f99ca6ab02f55968a422172cebc4f10a9)
* Doc snippet, menu: add menu items with addItem and not addMenuRichard Moe Gustavsen2024-07-201-1/+1
| | | | | | | | | | | | | | | | The example recommends to use Menu.addMenu(menu) to add MenuItems dynamically. This will cause run-time warnings to be printed, since a MenuItem is not a Menu. Instead, let the example use addItem for adding MenuItems dynamically. Change-Id: Icd8f54566ba27e0a2c31e6b79d83225ab9a3c879 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> (cherry picked from commit 591bcbb95c14b02e9e989ffc437712f5e856b449) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> (cherry picked from commit 71ed751bfe4346672cc3de366cf838f179d7dcd8) (cherry picked from commit ef4754c0b067d50eeb855253627f8b0958e21ef5)
* Doc: fix warning in ItemDelegate snippetMitch Curtis2024-06-141-1/+2
| | | | | | | | | | | | | The error was: TypeError: Cannot read property 'width' of null Change-Id: I0505e806130769fb7a2ed77b18c80393476edafd Reviewed-by: Richard Moe Gustavsen <richard.gustavsen@qt.io> (cherry picked from commit 7e3e1295f4e240afc9532bc0ab47ff3644ffc008) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> (cherry picked from commit 4397d6490ad96be31b85af6acbc911c19d7682b9) (cherry picked from commit e3cc449dfc88a7a070df33b1a20b368e54b55775)
* Doc: import Basic style in customization snippetsMitch Curtis2024-05-2140-40/+40
| | | | | | | | | | | | | | This ensures that the user won't inadvertently base the customizations on top of the native styles, but also saves adding the extra code that using QtQuick.Templates would require. The first sentence of the section already states that the Basic style is in use. Fixes: QTBUG-125228 Change-Id: I191f1664ab0dcf190e4825b98e7ec12f00de307f Reviewed-by: Richard Moe Gustavsen <richard.gustavsen@qt.io> (cherry picked from commit e4577eb6bb9308d2b84bfe66216333b001ac670b) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> (cherry picked from commit 82a2eedcd4c78da0e918fca38158df381ad4763a)
* Doc: Add an example customization for an indeterminate ProgressBarTopi Reinio2023-12-291-0/+29
| | | | | | | | | | | | | | | The indeterminate state for a ProgressBar control was not mentioned in the customization documentation. Adapt an animation from the old Qt Quick Controls 1 customization and link to the indeterminate property documentation. Fixes: QTBUG-116306 Change-Id: I56d2c7fe4b326637806edd85d40be040b7fdb3f6 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> (cherry picked from commit 57f5f462fcd6ed48fab49041d82edd65cf9138c5) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> (cherry picked from commit 38f167d3c6ac3cbdc721e9c854a2fc6ab619b31a) (cherry picked from commit 682518e18bb7e7735dd948fcc32633f80c2d9b72)
* Remove duplicated import in qtquickcontrols-selectionrectangle.qmlVladimir Belyavsky2023-12-091-2/+0
| | | | | | | | | | | Remove extra QtQuick import and fix QML run-time check warning M400 in Qt Creator. Change-Id: I0268d796af8dcceda336439ae9e533e53161980d Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> (cherry picked from commit dd18c4614ac5006d7df76024f361a96abc8027d0) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> (cherry picked from commit 56815b1e082522e2a1cc51d5369fb6755e0b3932)
* Remove commercial SPDX-License-Identifier from build filesTarja Sundqvist2023-11-241-1/+1
| | | | | | | | | The build files should not include a commercial SPDX-License-Identifier. Instead, a BSD-3-Clause license identifier is used. Task-number: QTQAINFRA-5900 Change-Id: I419c4cea2bc0c836811155eddfe3bca2edb22323 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Update commercial SPDX-License-IdentifierTarja Sundqvist2023-10-231-1/+1
| | | | | | | | | | Updated the commercial SPDX-License-Identifier to the files in tqtc-qtdeclarative. Examples, tests, or documentation files were not updated. Task-number: QTQAINFRA-5900 Change-Id: I74e2ac15b270b503edc80369b126913dd2ec33e1 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Doc: explain popup property propagationMitch Curtis2023-08-281-0/+59
| | | | | | | | | | | | It's not obvious that parent popups do not propagate properties to their children, but is intended. Task-number: QTBUG-115322 Task-number: QTBUG-115554 Change-Id: I21b99ee6ea0f2f62bfd4a82e57bd653e823e59d0 Reviewed-by: Richard Moe Gustavsen <richard.gustavsen@qt.io> (cherry picked from commit e4ba076e43f3f35388dfc634c0baf1ed7d2c70de) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Doc: explain how to always show ScrollBar when neededMitch Curtis2023-07-052-0/+21
| | | | | | | | | | | | Until we e.g. add a transient property to ScrollBar, we should document how users can ensure that it is always visible when the content size exceeds the view size. Task-number: QTBUG-76895 Change-Id: Iaf755f51ca9fd3865ae710a2cba13b58b897930e Reviewed-by: Richard Moe Gustavsen <richard.gustavsen@qt.io> (cherry picked from commit 62e3830944e2b4430cc1443617445560e9e90af1) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* doc: Clarify usage of palette; testable snippetsShawn Rutledge2023-05-171-0/+43
| | | | | | | | | | | | | | | | | | - color groups are better shown with copyable monospace syntax rather than capitalized - clarify that using palette grouped-property syntax does not imply that you must define every color - Window has a palette property, inited from SystemPalette: it's not only ApplicationWindow - testable snippets - reuse part of the windowPalette snippet for the Window.active property (switching colors might be the main use case) - make more links Change-Id: I5974351ba66fc9aeec34cb6a4aba1eb85289f536 Reviewed-by: Oliver Eftevaag <oliver.eftevaag@qt.io> (cherry picked from commit f1e7e1c3987b905157a1b9b418ea2649100eb390) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Doc: improve the SpinBox floating point exampleMitch Curtis2023-05-121-9/+17
| | | | | | | | | | | | | | | | | | | | | | | | Until we get a dedicated DoubleSpinBox control, we should make it easier for users to roll their own. We have a snippet for this in the docs already, but we can make it better: - Make the SpinBox editable. It's not very useful as an example if it's not, since the stepSize is an integer, so there's no way to modify the decimal component otherwise (without modifying the source, which users shouldn't have to do). - Set decimals in the validator so that it prevents entering more than 2. - Add a convenience function to convert decimals to integers. - Store the magic number 100 in a read-only property. - Use StandardNotation rather than ScientificNotation. This allows our internal fixup logic to work with the entered text. - Rename spinbox to spinBox. Task-number: QTBUG-67349 Change-Id: I2b0cab086b87d668408df194440ebaf64f598241 Reviewed-by: Richard Moe Gustavsen <richard.gustavsen@qt.io> (cherry picked from commit e0c13e1138a1730047e627f4cb2087f6217b8d42) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Doc: explain how to handle currentIndex changes in TabBar and SwipeViewMitch Curtis2023-05-031-0/+13
| | | | | | | | | | | Add a snippet and link to property change signal handlers to explain the concept, since that page is hard to find unless you know where to look. Change-Id: Id4019076d55199a9cafe4acdced1a7efc64bb3f2 Reviewed-by: Oliver Eftevaag <oliver.eftevaag@qt.io> (cherry picked from commit 7e745bbba235c41107292da06dc63beabf3c913c) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Add implicit height and width to custom dial snippetMatthias Rauter2023-03-291-0/+2
| | | | | | | | | | This is required to capture mouse events properly. Similarly handled in basic dial. Fixes: QTBUG-108390 Change-Id: If273cc72a25bfea21f08d7c1511f14d7ab9d2fd0 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> (cherry picked from commit b093fdc0bec354a885e75716dc6fd43a18ec2e81) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* doc, HeaderView: add a code snippet to the documentationRichard Moe Gustavsen2023-03-211-0/+79
| | | | | | | | | | Add a doc snippet to the HeaderView documentation that shows how can use it together with a TableView. Change-Id: Id1043d2b6561f6e68e0ac120b7ba040760263314 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> (cherry picked from commit 540017652ffd545ee2046393c1a64fd798cf1d1d) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* tst_snippets: move Line inline component out of PageMitch Curtis2023-03-101-17/+17
| | | | | | | | | | | | | | This causes an alias to break when QML_DISABLE_DISK_CACHE is not set (the default). Although it probably should work regardless, it doesn't make sense for the inline component to be in the Page. Amends d648235777fb4d84afc611c6fa47c15b01f0917a. Task-number: QTBUG-111857 Change-Id: I58d7234ad8f4e439093eb4ee60c7c9461660568a Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io> (cherry picked from commit 92c220812cdb2f54e68a92123022f952b41c9c5f) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Fix scoping of index in SwipeDelegate snippetDaniel Smith2023-02-281-2/+1
| | | | | | | | Fixes: QTBUG-111566 Change-Id: Idf3d5fd140f2b69215844ff25b24bfc2abfc14b1 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> (cherry picked from commit 925c6b06b17e78f125cc5119efe702774298b154) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Update style screenshotsMitch Curtis2023-02-242-0/+130
| | | | | | | | | | | | | | | | | - Added iOS screenshots. - Replaced single Fusion screenshot with light and dark screenshots. - Updated Material screenshots. - Added snippet to generate Material attributes screenshot. - Removed "thumbnail" screenshots in favor of individual images joined side-by-side in a \table. They are the same dimensions anyway, and this results in less images to maintain. - Moved duplicated qdoc style table code into a parameterized include file. Fixes: QTBUG-111175 Change-Id: Ic828468b050db71d6821a797a6480bd0d449e611 Reviewed-by: Oliver Eftevaag <oliver.eftevaag@qt.io> (cherry picked from commit d648235777fb4d84afc611c6fa47c15b01f0917a) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Doc: Add createObject() approach to dynamically generating menu itemsAndreas Eliasson2022-12-211-0/+37
| | | | | | | | | Fixes: QTBUG-108798 Change-Id: Ie8c8edfe00b11eca0082e89c864ec20cef8748e5 Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@qt.io> Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> (cherry picked from commit 239082b5ad44adfe2711cd334da1a9d57dd79a6f) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Doc: remove "2" from Qt Quick Controls filesMitch Curtis2022-12-01125-0/+0
| | | | | | | | | | | | | Work on this was already started for the documentation in 1abdfe5d5a052f2298b7bf657513dfa7e0c66a56. The CMake target (docs_QuickControls2) probably can't be renamed until we rename the library, which won't happen until Qt 7. Task-number: QTBUG-95413 Change-Id: Ied20805a91286436606577c3de39671a447f27dd Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
* Remove "2" from Qt Quick Controls directoriesMitch Curtis2022-12-01125-0/+3979
Qt Quick Controls 2 was named that way because it was a follow-up to Qt Quick Controls 1.x. Now that Qt Quick Controls 1 is no longer supported, we don't need to have "2" in the name. Work on this was already started for the documentation in 1abdfe5d5a052f2298b7bf657513dfa7e0c66a56. By doing this renaming a few weeks before feature freeze, it won't affect the release but still results in as little time possible spent manually fixing conflicts in cherry-picks from non-LTS releases as a result of the renaming. This patch does the following: - Renames directories. - Adapts CMakeLists.txt and other files to account for the new paths. A follow-up patch will handle documentation. It does not touch library names or other user-facing stuff, as that will have to be done in Qt 7. Task-number: QTBUG-95413 Change-Id: I170d8db19033ee71e495ff0c5c1a517a41ed7634 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
generated by cgit v1.2.3 (git 2.25.1) at 2025-12-15 13:15:01 +0000