summaryrefslogtreecommitdiffstats
path: root/src/gui/doc/snippets
Commit message (Collapse)AuthorAgeFilesLines
* doc: Clarify the term advance widthEskil Abrahamsen Blomfeldt2022-09-081-2/+2
| | | | | | | | | | | | | | The QFontMetrics documentation has been wrongly stating that the the horizontalAdvance() gives the width of a string, dating back to when the function was misnamed as width(). This can cause issues e.g. when using the value as input to eliding or clipping, since the advance may be smaller than what is actually drawn. This tries to clarify the term a bit. Task-number: QTBUG-90036 Change-Id: I8ed82fa14fe26c2a20cdbee9f2097a0aa4cc3925 Reviewed-by: Lars Knoll <lars@knoll.priv.no>
* Use SPDX license identifiersLucie Gérard2022-05-16117-5733/+234
| | | | | | | | | | | | | 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: Replace "C:\Documents and Settings" pathsKai Köhne2022-01-121-1/+1
| | | | | | | | | | "C:\Documents and Settings" isn't a real path anymore since Windows Vista. Replace it by C:\Users, or - in the snippet for QDesktopServices that is for demoing a path with space - with C:\Program Files. Pick-to: 6.2 6.3 5.15 Change-Id: I1bef97b6482180a6467fffcd1d62d6c168bcb389 Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
* 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>
* Fix name used for qmath.h in an includeEdward Welbourne2021-09-171-2/+2
| | | | | | Pick-to: 6.2 Change-Id: I9be8d4cc33d75a806a1ecf9950d7bac330abe9ea Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Introduce QDoubleValidator::fixup()Ivan Solovev2021-09-171-0/+19
| | | | | | | | | | | | | The provided implementation tries to fix positions for the group separator. In case of scientific notation it can also converts the value to normalized form. It uses QLocale::FloatingPointShortest internally to convert the double value back to string, so the number of decimals may change after calling this method. Change-Id: I963bc5f97b653e2bb912f4b95b09a4d1ee201e7f Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
* Android: Enable QDesktopServiceLars Schmertmann2021-09-101-1/+25
| | | | | | | | | | | | QDesktopServices::openUrl(const QUrl &url) is already implemented on Android. But even if it is possible to set an URL handler, the mechanism to invoke it is missing. With this commit the URL handler will work on Android like it is already working on iOS. Task-number: QTBUG-84382 Pick-to: 6.2 Change-Id: Ic560bd380f1cc59586861aa1a6a3ea064276a39e Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
* QMenu/QToolBar: remove addAction() functionsMarc Mutz2021-07-135-16/+16
| | | | | | | | | | | | | | | | | | | | They're now in QWidget itself. Remove them from the API, but not the ABI. The QToolBar case is straight-forward. QMenu is a bit more complicated: Since QT_CONFIG(shortcut) builds changed the signature of an existing function instead of adding/removing an overload, we have to deal with two cases: In a QT_CONFIG(shortcut) build, these overloads that take a trailing QKeySequence parameter have been deprecated and therefore cannot be removed. In a !QT_CONFIG(shortcut) build, the same functions are 1:1 copies of QWidget functions and can be removed (from the API). [ChangeLog][QtWidgets][QMenu/QToolBar] The addAction() functions have been moved down into QWidget. Change-Id: I49997b3440c137a1d4e3858d1d27d34a191e1eed Reviewed-by: Richard Moe Gustavsen <richard.gustavsen@qt.io>
* Doc: Improve QTransform documentationPaul Wicking2021-06-252-12/+10
| | | | | | | | | | | | * Explain QTransform's model of vector/matrix operations. * Improve snippets used to illuminate QTransform's behavior. Fixes: QTBUG-83869 Pick-to: 6.2 6.1 5.15 Change-Id: I84c3b1a221c139ee992f82c3ee4aebadeef8ee63 Reviewed-by: Edward Welbourne <edward.welbourne@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Andy Nichols <andy.nichols@qt.io>
* vulkan: Update legacy tests and examples to the modern validation layerLaszlo Agocs2021-05-312-4/+4
| | | | | | Fixes: QTBUG-88388 Change-Id: Ib072f203ada5d692dea8d35da2b24db0deac0297 Reviewed-by: Andy Nichols <andy.nichols@qt.io>
* Improve the sample codeFan PengCheng2021-03-191-1/+6
| | | | | | | maybe you forgot this line Change-Id: I1f5abd08023bd344e5bb2bf811b6195cbcf61dff Reviewed-by: Christian Ehrlicher <ch.ehrlicher@gmx.de>
* Initialize some uninitialized member variablesHe MingYang2021-02-201-1/+1
| | | | | Change-Id: Ia8e06850a2288f40906602adfbe40abb0faf8057 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Revert "Remove the qmake project files" for snippetsNico Vertriest2021-02-121-0/+3
| | | | | | | | | | | This reverts a limited part of commit ad2da2d27a590333fc89a56fc58700a09c3017b3 that deleted .pro files for snippets compilation. Some .pro files which contain snippets used in the documentation itself should be restored. Task-number: QTBUG-90483 Change-Id: I1b03833c8ff17b5fca43a5b6c5417e8545b1711b Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Remove the qmake project filesJoerg Bornemann2021-01-0742-388/+0
| | | | | | | | | | | | | | | | Remove the qmake project files for most of Qt. Leave the qmake project files for examples, because we still test those in the CI to ensure qmake does not regress. Also leave the qmake project files for utils and other minor parts that lack CMake project files. Task-number: QTBUG-88742 Change-Id: I6cdf059e6204816f617f9624f3ea9822703f73cc Reviewed-by: Edward Welbourne <edward.welbourne@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Kai Koehne <kai.koehne@qt.io>
* Doc: Use explicit linkage with target_link_librariesKai Koehne2020-11-301-1/+1
| | | | | | | | | | | | | | The Professional CMake book suggests always using explicit linkage with target_link_libraries, so let's use that. Whether to use PUBLIC or PRIVATE depends on the context. But let's be conservative and advise on using PRIVATE by default. Task-number: QTBUG-88935 Pick-to: 6.0 Change-Id: I12b80ee85be9f6916f1e4dea6b1c9cb29e03c20f Reviewed-by: Craig Scott <craig.scott@qt.io> Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Doc: Fix documentation warnings for Qt GUITopi Reinio2020-11-194-0/+68
| | | | | | | | | | | | | | | - Remove obsolete dependencies and references. - Restore previously deleted snippet code referenced in richtext.qdoc. - Add widgets snippets path to exampledirs; some classes were moved from QtWidgets to QtGUI and related \snippet commands were broken. - Mark internal functions under QNativeInterface::Private as \internal. Task-number: QTBUG-86295 Change-Id: I9c165c860c7191dac65972d702698a1745bff77f Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Get rid of all instance usage of QFontDatabaseVolker Hilsheimer2020-11-031-4/+3
| | | | | | | | All QFontDatabase APIs are static, use them accordingly. Task-number: QTBUG-88114 Change-Id: I0e4a7508646037e6e2812611262eed8b6d7ad3de Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@qt.io>
* Doc: Prefer versioned CMake library targetsv6.0.0-beta3Kai Koehne2020-11-011-1/+1
| | | | | | | | The non-versioned one's do miss some properties. It's therefore best to not advocate using them. Change-Id: I53645e65ed4de4e0100e59905c024cdfe40be0c5 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Organize QtOpenGLWidgets documentationVolker Hilsheimer2020-10-293-317/+0
| | | | | | | | | | | Move snippets to the right place, and give the widgets class a place to live. QtOpenGLWidgets is just a library, not a separate module, but we need a module page that the class can refer to for correct build instructions. Change-Id: I6d955ad3c4cd1003a828cc1f256deb6e7fb50ec4 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Add an example to the documentation of QImage::scanLine()Mitch Curtis2020-10-121-0/+11
| | | | | | | | | I couldn't find any examples in Qt's documentation of this when I was trying to use it in a project. Pick-to: 5.15 5.12 Change-Id: Ic7b7b71f219b2c1012829980866940b9a77bd11f Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Improve QRgb documentationMitch Curtis2020-10-121-0/+8
| | | | | | | | | - Add examples of how to create QRgb values - Link to qRgba() Pick-to: 5.15 5.12 Change-Id: I2a86b1c8e00137ba868426b8157a3aa0d924d7a6 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Another round of replacing 0 with nullptrAllan Sandfeld Jensen2020-10-071-2/+2
| | | | | | | | | This time based on grepping to also include documentation, tests and examples previously missed by the automatic tool. Change-Id: Ied1703f4bcc470fbc275f759ed5b7c588a5c4e9f Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Doc: Update CMake snippets to Qt 6Kai Koehne2020-09-251-2/+2
| | | | | | | Change-Id: I53021781a25c141db5d5fc6771192cd8d6ed732a Reviewed-by: Edward Welbourne <edward.welbourne@qt.io> Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Long live QKeyCombination!Giuseppe D'Angelo2020-09-032-3/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | C++20 via P1120 is deprecating arithmetic operations between unrelated enumeration types, and GCC 10 is already complaining. Hence, these operations might become illegal in C++23 or C++26 at the latest. A case of this that affects Qt is in key combinations: a QKeySequence can be constructed by summing / ORing modifiers and a key, for instance: Qt::CTRL + Qt::Key_A Qt::SHIFT | Qt::CTRL | Qt::Key_G (recommended, see below) The problem is that the modifiers and the key belong to different enumerations (and there's 2 enumerations for the modifier, and one for the key). To solve this: add a dedicated class to represent a combination of keys, and operators between those enumerations to build instances of this class. I would've simply defined operator|, but again docs and pre-existing code use operator+ as well, so added both to at least tackle simple cases (modifier + key). Multiple modifiers create a problem: operator+ between them yields int, not the corresponding flags type (because operator+ is not overloaded for this use case): Qt::CTRL + Qt::SHIFT + Qt::Key_A \__________________/ / int / \______________/ int Not only this loses track of the datatypes involved, but it would also then "add" the key (with NO warnings, now its int + enum, so it's not mixing enums!) and yielding int again. I don't want to special-case this; the point of the class is that int is the wrong datatype. Everything works just fine when using operator| instead: Qt::CTRL | Qt::SHIFT | Qt::Key_A \__________________/ / Qt::Modifiers / \______________/ QKeyCombination So I'm defining operator+ so that the simple cases still work, but also deprecating it. Port some code around Qt to the new class. In certain cases, it's a huge win for clarity. In some others, I've just added the necessary casts to make it still compile without warnings, without attempting refactorings. [ChangeLog][QtCore][QKeyCombination] New class to represent a combination of a key and zero or more modifiers, to be used when defining shortcuts or similar. [ChangeLog][Potentially Source-Incompatible Changes] A keyboard modifier (such as Qt::CTRL, Qt::AltModifier, etc.) should be combined with a key (such as Qt::Key_A, Qt::Key_F1, etc.) by using operator|, not operator+. The result is now an object of type QKeyCombination, that stores the key and the modifiers. Change-Id: I657a3a328232f059023fff69c5031ee31cc91dd6 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Remove "fallback session management"Andreas Hartmetz2020-09-011-1/+0
| | | | | | | | | | | | | | With the Qt6 compatibility break, it can finally be removed. Closing windows (which might quit the application with quitOnLastWindowClosed() true, the default) acted contrary to the documentation of the commitDataRequest() signal, which could have been a hint. This removes the workaround API from the fix for QTBUG-49667 and also removes the problematic feature that it worked around. Change-Id: I672be58864ef062df7fb7f2a81658b92c4feedd2 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* Doc: compile transform snippetsPaul Wicking2020-09-013-3/+12
| | | | | | | Done-with: Nico Vertriest <nico.vertriest@qt.io> Fixes: QTBUG-81486 Change-Id: Ie35d22469e7f8d9c244b70665af30b39e265766a Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: compile separations snippetsPaul Wicking2020-09-015-16/+27
| | | | | | | Done-with: Nico Vertriest <nico.vertriest@qt.io> Task-number: QTBUG-81486 Change-Id: I62294cedd4a0f96ebc2513b5b4179d451bb4b375 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: compile scribe-overview snippetPaul Wicking2020-09-013-17/+23
| | | | | | | Done-with: Nico Vertriest <nico.vertriest@qt.io> Task-number: QTBUG-81486 Change-Id: If760744aba49361d8d9ed51c4a2641b743c35c25 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: compile textobjectinterface snippetPaul Wicking2020-09-013-0/+11
| | | | | | | Done-with: Nico Vertriest <nico.vertriest@qt.io> Task-number: QTBUG-81486 Change-Id: Ibad1ef95b85d5484ee7e9cceee8019d026c10cb9 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: compile qstatustipevent snippetPaul Wicking2020-09-013-2/+11
| | | | | | | Done-with: Nico Vertriest <nico.vertriest@qt.io> Task-number: QTBUG-81486 Change-Id: I44c7b31e0a99009f51f81e2c8d0e736e6eafd535 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: compile qimagewriter snippetPaul Wicking2020-09-013-16/+19
| | | | | | | Done-with: Nico Vertriest <nico.vertriest@qt.io> Task-number: QTBUG-81486 Change-Id: Ibb4087d7035c3061b2980b317ab4280fa38aab50 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: compile qfileopenevent snippetPaul Wicking2020-09-013-1/+10
| | | | | | | Done-with: Nico Vertriest <nico.vertriest@qt.io> Task-number: QTBUG-81486 Change-Id: I28d7e9749b7a8feacd6b82abebcea462010caeba Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: compile polygon snippetsPaul Wicking2020-09-013-48/+56
| | | | | | | Done-with: Nico Vertriest <nico.vertriest@qt.io> Change-Id: I29caf1818154df3b0f2b599ac19c966e826f6287 Taks-number: QTBUG-81486 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: compile plaintextlayout snippetPaul Wicking2020-09-013-55/+54
| | | | | | | Done-with: Nico Vertriest <nico.vertriest@qt.io> Task-number: QTBUG-81486 Change-Id: I2bac37fd41703cc4cfb7de3946b31412c4af37b9 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: compile picture snippetsPaul Wicking2020-09-013-25/+31
| | | | | | | Done-with: Nico Vertriest <nico.vertriest@qt.io> Task-number: QTBUG-81486 Change-Id: I9daf8ed8c7d9620cd59feb40677795cbac30c97c Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Remove obsolete snippet filePaul Wicking2020-09-011-150/+0
| | | | | | | | | | QMatrix is gone, remove the snippet file as the content is not referenced anywhere. Done-with: Nico Vertriest <nico.vertriest@qt.io> Task-number: QTBUG-81486 Change-Id: I57040bce50cc51f7a3580af65cc56713567330f9 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: compile image snippetsPaul Wicking2020-09-014-58/+36
| | | | | | | Done-with: Nico Vertriest <nico.vertriest@qt.io> Task-number: 81486 Change-Id: I9860217a80cf94d27542d7e7836fe60fcd60897e Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: compile droprectangle snippetsPaul Wicking2020-09-013-43/+17
| | | | | | | Done-with: Nico Vertriest <nico.vertriest@qt.io> Task-number: QTBUG-81486 Change-Id: I0087f7cc0746168bc2223972074fed468c3fba46 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Compile dropevents snippetsPaul Wicking2020-09-013-5/+32
| | | | | | | Done-with: Nico Vertriest <nico.vertriest@qt.io> Task-number: QTBUG-81486 Change-Id: I8d2eebcd82f47c500a215e310b5828f9b7e303c6 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Remove unused snippet filesPaul Wicking2020-09-016-418/+0
| | | | | | | Done-with: Nico Vertriest <nico.vertriest@qt.io> Task-number: QTBUG-81486 Change-Id: I7bf5794ffc9f96ca0cb85cc6f58b4400468df439 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Make snippets Qt Gui compilable - textblock-fragmentsNico Vertriest2020-09-014-9/+19
| | | | | | Task-number: QTBUG-81486 Change-Id: I3a6ee6ef744abb694d1cc7ef409f8bb584854395 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Remove unused files from snippetPaul Wicking2020-09-013-295/+0
| | | | | | | | | These files aren't referenced from anywhere and duplicates other snippet content. Remove them. Task-number: QTBUG-81486 Change-Id: I48976dae3c095ae38ced682147527f2809a8fef6 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Make snippets Qt Gui compilable - textblock-formatsNico Vertriest2020-09-013-5/+10
| | | | | | Task-number: QTGUI-81486 Change-Id: I06dd6ce04b4d37c49df07d4b1b47c3ef029ee419 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Compile droparea snippetPaul Wicking2020-09-013-81/+21
| | | | | | | | | | | droparea.h has been removed. Remove all code that depends on that header except the one snippet that is still used. Add minimal code to allow the snippet to be compiled. Done-with: Nico Vertriest <nico.vertriest@qt.io> Task-number: QTBUG-81486 Change-Id: I58c80d3527c82389ccff97567f4c75c33aec0f5e Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Make Qt Gui snippets compilable - textdocument-texttableNico Vertriest2020-09-013-3/+11
| | | | | | Task-number: QTBUG-81486 Change-Id: If77873649aa10552047e0f89a7fccf55597e73f5 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Compile textdocument-tables snippetsPaul Wicking2020-09-015-12/+18
| | | | | | | | Minor code cleanup in passing. Task-number: QTBUG-81486 Change-Id: I23f8b3a22f627050582c69c81e5e0b85b5e45768 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Make Qt Gui snippets compilable - textdocument-selectionsNico Vertriest2020-09-015-18/+21
| | | | | | Task-number: QTBUG-81486 Change-Id: I467ca4d5ecd33f84e44b456a9559748ffd6cc53c Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Make Qt Gui snippets compilable - textdocument-resourcesNico Vertriest2020-09-012-3/+8
| | | | | | Task-number: QTBUG-81486 Change-Id: Ifd3b8d79617532bf16f33f0935f370b956048130 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Make Qt Gui snippets compilable - textdocument-printingNico Vertriest2020-09-015-14/+26
| | | | | | Task-number: QTBUG-81486 Change-Id: If811ac26eebbd6b3f9fd20e2b3fb29d3be24d1cb Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Make Qt Gui snippets compilable - textdocument-listsNico Vertriest2020-09-013-135/+18
| | | | | | Task-number: QTBUG-81486 Change-Id: I5f8017c7dc7fc735af83279ac340e3dfde68af89 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>