summaryrefslogtreecommitdiffstats
path: root/src/gui/doc
Commit message (Collapse)AuthorAgeFilesLines
* Rename "Porting" pages to "Changes"Jerome Pasion2020-11-092-4/+4
| | | | | | | | | | | | | | The content in the porting guides are closer to a changelog than a porting guide. At this point, it is easier for maintainers and contributors to write in a changelog than a guide. This change should help with readability and is closer to the usage of "Changes" in documentation. Part of a rename in other submodules. Task-number: QTBUG-87156 Change-Id: Ib59de7976fae19e7b39962e80161df6628e4070b Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Initial porting guide for QtGui and QtPrintSupportVolker Hilsheimer2020-11-041-1/+60
| | | | | | | | | Additional porting documentation for QtWidgets. Task-number: QTBUG-88149 Task-number: QTBUG-88151 Change-Id: Ia28f01a8d8d6eaee9d8f08af1a54b76e57620cab 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>
* Doc: Fix links to the CMake manualTopi Reinio2020-10-301-1/+1
| | | | | | Task-number: QTBUG-86295 Change-Id: I7b2208284d65ec9182352490bd4c92458c5e5e37 Reviewed-by: Paul Wicking <paul.wicking@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>
* doc: Update and flesh out native interface docsTor Arne Vestbø2020-10-182-426/+0
| | | | | | | | | The namespace and overviews are in the qtdoc repository. Docs for individual interfaces should live with their platform. Change-Id: Iba5fd7e9ebc4f1f634ec9dc3ec125ce88a1312ba Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* doc: Make QtGui docs depend on platform integration docsTor Arne Vestbø2020-10-171-1/+2
| | | | | Change-Id: I72cad7f399219d448d78763c50369f087e9d0cf7 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>
* Rename the new platform APIs from QPlatformInterface to QNativeInterfaceTor Arne Vestbø2020-10-071-47/+47
| | | | | | | | | | | | We were already using the 'native' nomenclature when referring to these kinds of APIs, e.g. when talking about native handles, or the existing QPlatformNativeInterface on a QPA level. Using 'native' for the user facing APIs also distinguishes them from the 'platform' backend layer in QPA and elsewhere. Change-Id: I0f3273265904f0f19c0b6d62471f8820d3c3232e Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Lars Knoll <lars.knoll@qt.io>
* Doc: Qt GUI: Depend on qtprintsupport documentation moduleTopi Reinio2020-09-291-0/+1
| | | | | | | | | | This adds 'Inherited by:' links to print support classes deriving from Qt GUI types. Pick-to: 5.15 Task-number: QTBUG-77126 Change-Id: I84ecee5df8cae0635d42653b1483db6b3c6074ee Reviewed-by: Paul Wicking <paul.wicking@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>
* Doc: Correct link errors qtbaseNico Vertriest2020-09-211-1/+1
| | | | | | Task-number: QTBUG-86295 Change-Id: I27f6bbdadffb08a8794520a14dfe0e2334979575 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Add links to Qt 6 changes files from module indexPaul Wicking2020-09-181-0/+4
| | | | | | Task-number: QTBUG-84051 Change-Id: Iac25df135c9d73a990b41243e08cd38ea78296a4 Reviewed-by: Kai Koehne <kai.koehne@qt.io>
* Doc: Add porting guide documentsPaul Wicking2020-09-161-0/+46
| | | | | | | | Also add existing such docs to the new document group Task-number: QTBUG-84051 Change-Id: I76f033f0846e09943f249d2beeb1606869eef382 Reviewed-by: Topi Reiniö <topi.reinio@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>
* Document native interfacesFriedemann Kleint2020-09-025-0/+494
| | | | | | | | | | | | | | As the private headers are not included by default in the precompiled header QDoc builds for QtGui, create a custom module header for the documentation build and pull in the required headers. Add dummy declarations for Windows-specific types for building docs on non-Windows platforms. Task-number: QTBUG-83252 Change-Id: I225ed08f68cf4f7c1f1d093424070b13ce36aa51 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Tor Arne Vestbø <tor.arne.vestbo@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>
* Doc: Make Qt Gui snippets compilable - textdocument-listitemstylesNico Vertriest2020-09-015-9/+19
| | | | | | Task-number: QTBUG-81486 Change-Id: Ie718f4ae3de3f9ae12702264f5455f23d38bf1fe Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Make Qt Gui snippets compilable - textdocument-listitemsNico Vertriest2020-09-015-9/+22
| | | | | | Task-number: QTBUG-81486 Change-Id: I7bbecd3cbf086243ea3a03fb7822064bde85201c Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Make snippets Qt Gui compilable - textdocument-imagesNico Vertriest2020-09-013-5/+13
| | | | | | Task-number: QTBUG-81486 Change-Id: I98b6d0b498d181931ee0fc2e39cb1fde5208a303 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Make snippets Qt Gui compilable - textdocument-imageformatNico Vertriest2020-09-013-5/+14
| | | | | | Task-number: QTBUG-81486 Change-Id: I9bf94bb8c82d7751a8615c6e1e3278400e77ce3a Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Make snippets Qt Gui compilable - textdocument-imagedropNico Vertriest2020-09-013-8/+15
| | | | | | Task-number: QTBUG-81486 Change-Id: I80b66fce31ba5ee511690283cf56ce4306702b14 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-20 12:58:18 +0000