summaryrefslogtreecommitdiffstats
path: root/src/widgets/doc/src
Commit message (Collapse)AuthorAgeFilesLines
* Doc: Remove table for listing imagesVenugopal Shivashankar2024-03-221-15/+12
| | | | | | | Task-number: QTBUG-122580 Pick-to: 6.7 6.6 Change-Id: I7ca3d677262b48ce9e1d85bd9347ad5b15d1598f Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Documentation: Clarify palette/font/stylesheet inheritance/propagationAxel Spoerl2024-03-181-4/+13
| | | | | | | | | | | | | | | | Palette and font changes made by a style sheet are propagated to existing widgets and their children at change time. Palette and font changes made by setPalette() and setFont() are inherited by all existing and future children of the widget to which the call was made. Clarify this in the documentation. Fixes: QTBUG-122588 Pick-to: 6.7 6.6 6.5 6.2 5.15 Change-Id: Ic40d96fc1e5e4507f84a33138303b7193948d3fe Reviewed-by: Richard Moe Gustavsen <richard.gustavsen@qt.io>
* Doc: Further replace 'Qt Designer' with 'Qt Widgets Designer'Kai Köhne2024-02-295-14/+14
| | | | | | | | | | Use \QD macro wherever possible. Amends 8aceccc7eb075 Task-number: QTBUG-122253 Change-Id: I276dabd40fb81486f6380fd90cf9968990932a24 Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
* Documentation: Rename 'Qt Designer' to 'Qt Widgets Designer'Friedemann Kleint2024-02-191-1/+1
| | | | | | Task-number: QTBUG-122253 Change-Id: I04ab521decaf908b1c1491987f6de1e816a42a33 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Turn SpinBox Delegate example into snippetsVolker Hilsheimer2023-12-202-18/+13
| | | | | | | | | | | | The essence of the example was already fully quoted in the model/view documentation. Move the code into a snippet source, and update the screenshot. Fixes: QTBUG-119976 Pick-to: 6.7 6.6 Change-Id: Id2f10bb26a650419969bbfa9b76cb74babd3319e Reviewed-by: Richard Moe Gustavsen <richard.gustavsen@qt.io> Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io>
* Doc: Modify unreadable tablesInkamari Harjula2023-11-281-512/+879
| | | | | | | | | | | | Added breaks in List of Stylable Widgets table. Changed List of Properties table into sections. Added list of Qt-specific properties in beg of List of Properties chapter. Moved snippet comments to different rows. Task-number: QTBUG-118446 Pick-to: 6.6 Change-Id: I494401058c7982c0a0ada18c8c94429beabba348 Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
* Doc: Revise QWidget docsAndreas Eliasson2023-11-013-39/+42
| | | | | | | | | | | | | | Reviewing and improving the docs for QWidget is part of the objectives for the 2023 Q4 OKRs. Most of the work in this patch is fixing grammatical errors and typos. It is tempting to move much, if not all, of the Detailed Description content from the QWidget class reference page (qwidget.cpp) into its own overview/explanation page, which would be more in line with the diátaxis framework. But I think that should be a different patch. Fixes: QTBUG-117758 Pick-to: 6.6 6.5 6.2 5.15 Change-Id: Ibb3f367c4677f7e6615bc0cd39d0ffe921862cb9 Reviewed-by: Safiyyah Moosa <safiyyah.moosa@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Add example categories to Qt Widget examplesMats Honkamaa2023-09-051-0/+4
| | | | | | | | | Added example categories and fixed some minor typos as well. Task-number: QTBUG-116359 Pick-to: 6.5 6.6 Change-Id: I2e270a1919003f4cea233666b64437e4c2b77121 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Rename accent color in QPaletteSanthosh Kumar2023-08-181-2/+2
| | | | | | | | | | Accent color role has been renamed according to name rule of other color roles in QPalette. Fixes: QTBUG-116107 Pick-to: 6.6 Change-Id: I70ac98a1e97afbdc7ea5f8d79f808c307e170712 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* Move pixelator example to manual testTor Arne Vestbø2023-06-301-4/+0
| | | | | | Pick-to: 6.5 6.6 Change-Id: I3ce2bc269a9f77bce3dd41f0127d01091c1408f6 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Move stylesheets example to manual testTor Arne Vestbø2023-06-291-17/+2
| | | | | | Pick-to: 6.5 6.6 Change-Id: If0206e63546bf948af4cfb65773e2662c53a5e79 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Move item views puzzle example to manual testTor Arne Vestbø2023-06-281-2/+0
| | | | | | Pick-to: 6.5 6.6 Change-Id: Idbb4222861be86275a86f731e75127b8496a08a7 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Fix qdoc link warnings after moving a few examples to manual testsTor Arne Vestbø2023-06-272-4/+2
| | | | | | Pick-to: 6.5 6.6 Change-Id: I81a6e9d52e858c3f733d4c527c70408772813b56 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Implement color role AccentColor in QStyleSheetStyle and QCssParserAxel Spoerl2023-05-221-0/+8
| | | | | | | | | | | | | | | | | The color role AccentColor has been added to QPalette. This patch implements the new color role in QCssParser and subsequently in QStyleSheetStyle. The QBrush variable names used to populate brushes, have been changed into speaking names for better code readability. tst_QCssParser has been adapted accordingly. The test function accentColor() has been added in tst_QStyleSheetStyle. Documentation has been updated. Change-Id: Ib09ddc1b61868f2bb8f70f654e83ea1c35276d30 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Doc: Replace mentions of deprecated macroTopi Reinio2023-05-151-2/+2
| | | | | | | | | Q_ENUMS() is deprecated in favor of Q_ENUM(). Pick-to: 6.5 Task-number: QTBUG-113229 Change-Id: I29cc23c87b1d6e8eeb49dd1d3ddaf4ca7d2cf8c2 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Clarify module changes in Qt6Jaishree Vyas2023-05-091-1/+1
| | | | | | | | | Changed Briefs for better understanding Fixes: QTBUG-109324 Pick-to: 6.5 Change-Id: I15b0c0dc12b1bf96626fb8ea4ad16d04b2b118ca Reviewed-by: Kai Köhne <kai.koehne@qt.io>
* doc: Add note about platform support for window positionsEskil Abrahamsen Blomfeldt2023-03-171-0/+9
| | | | | | | | | | | On some platforms, such as Wayland (and also eglfs), manual window positioning is not supported. Since this has caused confusion in the past, we add a note to the documentation. Pick-to: 6.2 6.5 Fixes: QTBUG-86780 Change-Id: Idf8dcdfad8ccfb9eb0f704fce05216562e433e20 Reviewed-by: Tor Arne Vestbø <tor.arne.vestbo@qt.io>
* Doc: rewrite shortcut focus sectionPaul Wicking2023-03-011-4/+9
| | | | | | | | | | As pointed out in review, somewhat contradictory advise. Rewrite the section to be more active, focus on the user and their application, and a bit more consistent. Pick-to: 6.5 Change-Id: Idbbf29d3033d32ade553290a2e89bd778876224c Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Doc: Use \keyword for alternative name of CMake commandKai Köhne2023-01-301-1/+1
| | | | | | | | | | \target will let the browser jump right below the title. Instead, open the page from the start. Pick-to: 6.5 Change-Id: Ia58664aa2696aca4f299d57b8dbaa9b6cda90f27 Reviewed-by: Pranta Ghosh Dastider <pranta.dastider@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Doc: Drop link to deleted pagePaul Wicking2023-01-051-3/+1
| | | | | | | | The standard accelerators page was deleted, drop the link to it. Pick-to: 6.5 6.4 Change-Id: I2fa9a94200d0e5f8895bb8c6981c73b3e9dd159e Reviewed-by: Kai Köhne <kai.koehne@qt.io>
* Doc: Add link to Tools Examples from the Qt Widgets module front pageLeena Miettinen2022-12-191-0/+1
| | | | | | | | The example docs were difficult to find. Pick-to: 6.4 6.5 Change-Id: Id7003b140275e722dad2c41767eabc24fef728e5 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Normalize page namesKai Köhne2022-11-021-1/+1
| | | | | | | | | | | | | | | qdoc does enforce lowercase file names for .html pages, and also replaces underscore with a dash. Make sure that the original \page name already is normalized, so that it's easier to search. This was done by find . -name "*.qdoc" -exec perl -p -i -E "s/\\\page (.*)/\\\page \L\1/ && s/_/-/g" {} ; Pick-to: 6.4 Change-Id: Ib50b85af8ffd985edf06856266eefdebf8b328a3 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Luca Di Sera <luca.disera@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Style sheets: add placeholder text color property for edit widgetsEirik Aavitsland2022-09-291-1/+25
| | | | | | | | | The placeholder text was given its own QPalette color role in Qt 5.12, but there has been no way to specify it from a Qt style sheet. Fixes: QTBUG-93009 Change-Id: If58ca844c19c65b7eee14c6d5730a4ba27640c33 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Doc: Format certain operators in textPaul Wicking2022-08-231-1/+1
| | | | | | | | | | Use correct text formatting; this ensures e.g. the decrement operator isn't converted to an en dash in the docs. Apply to increment operator docs also for consistency. Task-number: QTBUG-105729 Change-Id: I5f126b90bc1d1b91d86e1f87c9b17a583841adb6 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Documentation: Fix "Using Model Indexes" in Model View Programming guide to workFriedemann Kleint2022-08-091-4/+9
| | | | | | | | | | | | | The code introduced by 54d5ca0c2766e915c960fa437cee6c20a324c1a7 did not work since the variables parentIndex/numRows were local to the lambda and the outer code would not wait. Move the widgets population into the lambda to fix this. Modernize the remaining code a bit. Pick-to: 6.4 6.3 6.2 Change-Id: I2a09878987df9edb9ff04f0ac4ad82af1a8b52c8 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Styles: fix typos in the docLaszlo Papp2022-07-151-4/+4
| | | | | Change-Id: I4b4ee0be40f7cef8bae41d763eaf4c1822e91c43 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Fix typos in docs and commentsKai Köhne2022-06-151-1/+1
| | | | | | | | | Found by codespell Pick-to: 6.4 Change-Id: Ie3e301a23830c773a2e9aff487c702a223d246eb Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io> Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
* Use SPDX license identifiersLucie Gérard2022-05-1620-520/+40
| | | | | | | | | | | | | Replace the current license disclaimer in files by a SPDX-License-Identifier. Files that have to be modified by hand are modified. License files are organized under LICENSES directory. Task-number: QTBUG-67283 Change-Id: Id880c92784c40f3bbde861c0d93f58151c18b9f1 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Lars Knoll <lars.knoll@qt.io> Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* Doc: Reorganize sections structure in Qt Widgets landing pageAndreas Eliasson2022-03-221-20/+21
| | | | | | | | | | Also, use the global include snippets for the 'Using the Module' section. Task-number: QTBUG-100369 Pick-to: 6.3 Change-Id: Ib9e32dd48689879c91c7c307f8cf0f01dc478efe Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Replace deprecated QColor::fromString in tests and documentationVolker Hilsheimer2022-03-211-1/+1
| | | | | | | | Don't use deprecated methods in tests, and don't refer to them in documentation. Change-Id: I110480742d9a7b9b0a2e194e3fe610208c1e07da Reviewed-by: Marc Mutz <marc.mutz@qt.io>
* Document change to style sheet selectors for enum propertiesVolker Hilsheimer2022-02-201-0/+21
| | | | | | | | | | | | | | The change is presumably an unintentional side effect of QVariant and QMetaType system changes in Qt 6, but it arguably is a good change. Document it in the porting guide, while evaluating whether (and figure out how) we want to support integer values as well. Pick-to: 6.3 6.2 Task-number: QTBUG-99642 Change-Id: Id1589c594bcdc2afe5c4fd0e47a158cd5e03e52f Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> Reviewed-by: Axel Spoerl <axel.spoerl@qt.io>
* Doc: Remove "Docs about UI Design" book overviewKai Köhne2022-01-192-81/+4
| | | | | | | | | | | | | | Recommending a Qt 4 book in Qt 6 documentation tells us something about how much we maintain the list :) The other books might still be good sources. Anyhow, the chances of a customer looking exactly in this place to learn good books about icons are not very high. So let's just ditch the page, and use external links instead. Pick-to: 6.3 Change-Id: I8013a5ab9d3416fe795f4aaed647e26db79508a1 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
* Doc: Remove mentioning of Fowler bookKai Köhne2022-01-171-10/+0
| | | | | | | | | It is out of print since years, and probably quite dated by now (released 1997). Pick-to: 6.3 Change-Id: I1653eb404713c15d70b8a15858e8c7d12b2e71cb Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Doc: Use find_package(Qt6 REQUIRED COMPONENTS ...) idiomKai Köhne2021-12-091-1/+1
| | | | | | | | | | Using REQUIRED as a prefix instead of suffix works better with OPTIONAL_COMPONENTS, and is also the order in the CMake manual. Task-number: QTBUG-98867 Pick-to: 6.2 Change-Id: I1ab68408b95d8edf06272a3b9fceccd8d8e597fc Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
* Mention a change to QDateTimeEdit::setDateTime()Edward Welbourne2021-10-161-1/+13
| | | | | | | | | | | I neglected to record the change in the Qt 6 changes documents that help folk migrate from Qt 5. This is a follow-up to commit 2a653fde48f7312ccd2f792d72d305061b410ae3 Fixes: QTBUG-97493 Pick-to: 6.2 6.2.1 Change-Id: Ie496fdd05759eeeac4c7610db40ab6745b5e0640 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Fix usage of \summary macroTopi Reinio2021-10-121-1/+1
| | | | | | | | | The macro takes only one parameter, sentences must be wrapped in {}. Pick-to: 6.2 Fixes: QTBUG-97441 Change-Id: I7177548a32a67d720c2b551d16c09d898b0fda51 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* widgets: Fix typos in documentationJonas Kvinge2021-10-122-3/+3
| | | | | | Pick-to: 5.15 6.2 Change-Id: I6b77f0ec043d08da3b7958d780dce9595daf97a6 Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
* Doc: Make it explicit when CMake API is definedKai Köhne2021-10-052-0/+7
| | | | | | | | Task-number: QTBUG-96239 Pick-to: 6.2 Change-Id: Iaa99024f98f5422aa39f148a89594186b40344bf Reviewed-by: Edward Welbourne <edward.welbourne@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Add summary to CMake commandsKai Köhne2021-10-041-1/+1
| | | | | | | | | | | | For normal \page elements, \brief is just showing in the \generatelist or \annotatedlist commands. Make sure the description is also visible in the actual CMake command/variable/property page by defining a \summary macro. Pick-to: 6.2 Change-Id: I12bc854d547059a2f6309a5922bb0b2a36d4e41c Reviewed-by: Craig Scott <craig.scott@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Add global \versionlessCMakeCommandsNote qdoc macroJoerg Bornemann2021-08-231-3/+2
| | | | | | | | | | | | | | When documenting a CMake command, document the unversioned command 'qt_foo' and use '\versionlessCMakeCommandNote qt6_foo' to refer to the versioned command. This avoids duplicating the command signature. Use the new macro where applicable. Pick-to: 6.2 Task-number: QTBUG-95796 Change-Id: I2e4180fbda0b89acf3d8c036459f591eb2f46475 Reviewed-by: Craig Scott <craig.scott@qt.io> Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Implement missing support for 'em' and 'ex' lengths in style sheetVolker Hilsheimer2021-08-101-1/+2
| | | | | | | | | | | | | | | | | | | | | | | | The Qt style sheet reference claimed that Length properties can be specified in 'em' or 'ex' units, but that was never implemented. Add the missing implementation. Since the sizes depend on the size of the font of the current element, we cannot convert the units in the CSS parser, but have to do so in the QRenderRule constructor, where we can make a decision about which font to use if the style sheet itself doesn't specify a font. Fall back to the widget font if possible; otherwise it will be the application default font. The implementation translates em into QFontMetrics.height, identical to what is already done in the QCssParser. This is in line with the CSS specification, but contradicts our previous documentation which stated that 'em' means "width of M". Fix the documentation. Fixes: QTBUG-8096 Pick-to: 6.2 Change-Id: I145e2504ae3b19101a0d0dd63653466b6c2cec1d Done-with: Cristian Maureira-Fredes <Cristian.Maureira-Fredes@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Richard Moe Gustavsen <richard.gustavsen@qt.io>
* Doc: fix QStyleOptionMenuItem::menuHasCheckableItems typoJeremy Katz2021-08-101-1/+1
| | | | | Change-Id: I2553f3e799e57e688ae98090e34f30122fea1142 Reviewed-by: Richard Moe Gustavsen <richard.gustavsen@qt.io>
* Documentation: Remove section advertising AmazonFriedemann Kleint2021-06-281-13/+0
| | | | | | Pick-to: 6.2 6.1 5.15 Change-Id: Ibf61cdf4ccb08c00c74c88e66aac200971be62d1 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Add note about the risk of setting min-width/height in a style sheetVolker Hilsheimer2021-05-071-2/+8
| | | | | | | Task-number: QTBUG-86677 Pick-to: 6.1 5.15 Change-Id: I1e5e10ee79d80fee40d04afe439489d6ce16a43e Reviewed-by: Andy Shaw <andy.shaw@qt.io>
* Document change to QAbstractItemView::viewOptions in porting guideVolker Hilsheimer2021-04-041-0/+8
| | | | | | | | | | | We couldn't deprecate and add the replacement in 5.15, so list it explicitly here. Amends c501e09efacb8a60deb41f85f3402f6f4c041d95. Pick-to: 6.0 6.1 Change-Id: I174a7b6214cd8b9579b029ebf57e4d5b2e28e574 Reviewed-by: Christian Ehrlicher <ch.ehrlicher@gmx.de>
* Doc: Fix qdoc warnings on snippet filesNico Vertriest2021-03-221-1/+1
| | | | | | | | | qtwidgets-index.qdoc:123: (qdoc) warning: Cannot find file to quote from: 'snippets/snippets.pro' qtwidgets-index.qdoc:123: (qdoc) warning: Unexpected '\snippet (//! [qmake_use])' Task-number: QTBUG-90662 Change-Id: I702b685e7cd9c34b5a07480ecb99e913ce250d70 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Change section titles that cause bad linksPaul Wicking2021-03-111-3/+3
| | | | | | | | | | | Section titles are valid targets for QDoc's autolinker. When they are identical to other valid link targets, such as for example a class, these sections may cause invalid links. Pick-to: 6.0 6.1 Fixes: QTBUG-91141 Change-Id: Ie9a6258d2bf83932335976d8c0b5fc59f2028ae5 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Doc: Fix broken link in stylesheet examplesNico Vertriest2020-12-231-2/+4
| | | | | | Task-number: QTBUG-89211 Change-Id: Idde01e22dd57c37c78d8c86305d047562e5c1f64 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Fix various documentation warningsTopi Reinio2020-11-301-1/+1
| | | | | | | | | | | | | - QList iterators are now nested classes inside QList. - Drop reference to Qt OpenGL Widgets landing page, there is no such page. - Fix typos and linking issues. Fixes: QTBUG-86295 Pick-to: 6.0 Change-Id: I964843deb81aa55ff8ddb9a1c2b004cb72e68de9 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Update CMake functions in Qt Widgets for Qt 6Kai Koehne2020-11-232-74/+12
| | | | | | Pick-to: 6.0 6.0.0 Change-Id: I4110e8695c75c40cec6f94bb94879b07282b29d3 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-03 22:52:15 +0000