aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc/extras
Commit message (Collapse)AuthorAgeFilesLines
* Documentation: Add QtQml.ListPropertyFriedemann Kleint2024-04-231-0/+24
| | | | | | | Pick-to: 6.7 Task-number: PYSIDE-2698 Change-Id: If9b9af49bb351fcb4e2355277ff84bd0936b5033 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Fix ClassInfo to be a proper decoratorFriedemann Kleint2024-04-221-7/+5
| | | | | | | Pick-to: 6.7 Task-number: PYSIDE-1106 Change-Id: I298769db5455368fca6890571546d4cf74ace957 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* Documentation/QmlSingleton: Remove mention of Q_OBJECTFriedemann Kleint2024-04-041-1/+1
| | | | | | | | It does not exist in Python. Pick-to: 6.7 Change-Id: Ib52635df70148f604b066435e50653d1126a80dc Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Rename Qt Designer to Qt Widgets DesignerFriedemann Kleint2024-03-257-9/+11
| | | | | | | | | | | | | Use *Qt Widgets Designer* (emphasis/italics) instead of **Qt Widgets Designer** (bold) consistently. Also fix pyside-designer.rst (Qt Widget Designer -> Qt Widgets Designer). Pick-to: 6.7 Task-number: QTBUG-122253 Change-Id: I573264f5b02c62e4b91cfc0f8b0f38da691defed Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Documentation: Change Enum page to be a proper decoratorFriedemann Kleint2024-03-012-74/+84
| | | | | | | | | Split out QFlag to a separate page for proper indexing. Task-number: PYSIDE-1106 Task-number: PYSIDE-2215 Change-Id: Ibf4e1ad045c272adfa7c0a47bb2fe7ff1781d100 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* Documentation: Change slot page to be a proper decoratorFriedemann Kleint2024-03-011-42/+27
| | | | | | | Task-number: PYSIDE-1106 Task-number: PYSIDE-2215 Change-Id: I159b4d40240cdc36a02c5f4db347cd5161a8bb23 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Add support for decoratorsFriedemann Kleint2024-03-018-97/+57
| | | | | | | | | | | | | | | Add the necessary sphinx modules and configuration. In the doc generator, split out a helper to read an extra documentation page and scan for sphinx directives. Add a decorator list and write it below classes. As a drive-by, outdent the QML decorator descriptions. Task-number: PYSIDE-1106 Task-number: PYSIDE-2215 Change-Id: I813255385af60ab313b10be26fa20c56c768b405 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* Documentation: List loadUiType() as a function instead a classFriedemann Kleint2024-03-011-35/+0
| | | | | | | | Move the loadUiType() documentation into a doc snippet. Task-number: PYSIDE-1106 Change-Id: I3f878e054f2e6c3a0570f06a340d87661f27cd11 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* Documentation: Fix broken links to classes provided as extra documentsFriedemann Kleint2024-03-018-32/+8
| | | | | | | | | | | | | | The extra documents were previously plain text documents which can no longer be linked with class type links introduced by 81ae1853d8510909413a46ab0c27c5eb68a7816e. Change them to use a class directive to mark them as classes. Decorators will be treated separately by a follow-up patch. Task-number: PYSIDE-1106 Task-number: PYSIDE-2215 Change-Id: I0a8601bb5e9a0211c8bd79b6204e93d79bdc7219 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* doc: fix some issues found with rstcheckCristián Maureira-Fredes2024-01-0815-98/+120
| | | | | | | | | | Checking the local rst files, we had some issues related to repeated links, bad syntax of code-blocks, invalid levels, etc. Pick-to: 6.6 Change-Id: I94d64d9cca5142833640f30299d1ad32b568f7ad Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Add QtQuickTestFriedemann Kleint2023-12-241-0/+58
| | | | | | | | | | [ChangeLog][PySide6] QtQuickTest has been added. Fixes: PYSIDE-2543 Change-Id: I949a0e50a2e522589863ade1e2b2335be580a0d7 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* Document QtQml's global function as functionsFriedemann Kleint2023-12-214-150/+0
| | | | | | | | | | | Replace the extra documents (which get generated into the class list) by function documentation snippets, so that they show up correctly under "Global functions". Task-number: PYSIDE-1106 Change-Id: I6a5c457669f7f1db1f572f131721dc443a7d5c70 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* doc: remove double white spaceCristián Maureira-Fredes2023-11-211-1/+1
| | | | | | Pick-to: 6.6 Change-Id: I68b835bb5fa00d35fe5406deee2acc83c7bac7cb Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
* Add static create() function for decorated QML singletonsFriedemann Kleint2023-11-091-0/+13
| | | | | | | | | | | | | Check for static method named "create()" and use that as a singleton creation callback. [ChangeLog][PySide6] It is now possible to use a static method create(engine) for creating decorated QML singletons. Fixes: PYSIDE-2432 Change-Id: I76c47385a0064733a1949a30d22cc01c280d0423 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* libpyside: Implement QMetaMethod::tags() for @SlotFriedemann Kleint2023-10-171-1/+5
| | | | | | | | | | | | | Tags can be used like annotations and are for example used in the DBus module. [ChangeLog][PySide6] An optional parameter "tag" has been added to @Slot, allowing to set QMetaMethod.tag(). Pick-to: 6.6 Fixes: PYSIDE-748 Change-Id: I62bef6179917307471cb72491ac3d05970572f3f Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Remove mentions of decorator form of signalsFriedemann Kleint2023-04-241-4/+3
| | | | | | | | | | Use class variables instead. Fixes: PYSIDE-2308 Pick-to: 6.5 Change-Id: I4edc07ad2445f05b2db70ca7c1f8e2106177e78b Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
* Documentation: Add note stating that QApplication is required for the Qt ↵Friedemann Kleint2023-01-091-0/+4
| | | | | | | | | Charts QML types Pick-to: 6.4 6.2 Task-number: PYSIDE-2179 Change-Id: Ic7ab5681fce56202eda89e6aa22ad589549f70bf Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Add QtSerialBusFriedemann Kleint2022-10-141-0/+46
| | | | | | | [ChangeLog][PySide6] QtSerialBus has been added. Change-Id: I661912279fa03b51d19483b603fff830ede225a9 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* PyEnum: write about new Enums and Forgiveness ModeChristian Tismer2022-09-201-3/+2
| | | | | | | | | | | | | | | | The new Python enums are described in detail and the similarities and problematic differences explained. Then the forgiveness mode is introduced, showing that most incompatibilities can be ignored, although this mode is not encouraged for new code. Task-number: PYSIDE-1735 Change-Id: Ib0d28745ce430a97a84e52522a5aa0cbbe3f3581 Pick-to: 6.3 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: change http by httpsCristián Maureira-Fredes2022-04-018-8/+8
| | | | | | Pick-to: 6.2 Change-Id: Id796694e947643152dc0d57dd760efb89ddd8f16 Reviewed-by: Christian Tismer <tismer@stackless.com>
* Add QPyQmlParserStatusFriedemann Kleint2022-04-011-0/+10
| | | | | | | | | [ChangeLog][PySide6] class QPyQmlParserStatus for handling QML parser status changes has been added. Fixes: PYSIDE-1876 Change-Id: Ic1066924ec85dc8633f959342921c1d03da1aee4 Reviewed-by: Christian Tismer <tismer@stackless.com>
* Documentation: Link the Tutorial from the Signal/Slot reference pagesFriedemann Kleint2022-03-232-0/+3
| | | | | | | Pick-to: 6.2 Fixes: PYSIDE-1863 Change-Id: I7bf2c04ad5a5ab7b5bb29b082ee9d3fbf3b51c2a Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* PySide6/Documentation: Add module descriptionsFriedemann Kleint2022-03-1629-11/+1346
| | | | | | | | | Add module descriptions and a README.md on how to create them. Pick-to: 6.2 Change-Id: I627205843bedd74e625d14da718e42faac0a2c68 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Add QtNfc documentationFriedemann Kleint2022-03-161-0/+31
| | | | | | | | Amends 65b6c342f0f9c2cf6006f7ebd78dd06e66e1ef1a. Task-number: PYSIDE-1570 Change-Id: I869a706bab514b87c870e8faa994cc1acf36be2e Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Add constructor documentation to Signal/SlotFriedemann Kleint2022-03-142-4/+37
| | | | | | | | As a drive-by, rewrap some paragraphs. Pick-to: 6.2 Change-Id: Ia17c3937bb48a3fab5e573819b5f27b896199240 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Clean up extra documentationFriedemann Kleint2022-03-148-47/+38
| | | | | | | | | Remove obsolete modules. Update and rewrap description texts of existing modules. Add new QtOpenGLWidgets module. Pick-to: 6.2 Change-Id: Ifbe0fec66e964d579348ac0ef438beb8a3ca0a28 Reviewed-by: Christian Tismer <tismer@stackless.com>
* Improve readability of the Property documentationFriedemann Kleint2022-03-021-3/+6
| | | | | | | | | | Put each parameter on one line. Task-number: PYSIDE-1513 Pick-to: 6.2 Change-Id: Ia0ff3c587408f46bfd529278e385320169b108f2 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Implement QQmlPropertyValueSourceFriedemann Kleint2022-02-281-0/+10
| | | | | | | | | | | | | | | As is done with the other interfaces, add a class QPyQmlPropertyValueSource inheriting from QObject and QQmlPropertyValueSource. Store its offset in QQmlPrivate::RegisterType::valueSourceCast if it is found as a base class. [ChangeLog][PySide6] class QPyQmlPropertyValueSource for implementing QML value sources for properties has been added. Task-number: PYSIDE-1709 Change-Id: Icd1bd57972f339f9839ccd8d9bf6ff9e5e16ec62 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Add the QmlAttached decoratorFriedemann Kleint2022-02-161-0/+40
| | | | | | | | [ChangeLog][PySide6] The QmlAttached decorator has been added. Task-number: PYSIDE-1709 Change-Id: I0301ecc7a9bc7a1b798095e8972b2fe4addf2eaf Reviewed-by: Christian Tismer <tismer@stackless.com>
* Add the QmlExtended decoratorFriedemann Kleint2022-02-161-0/+37
| | | | | | | | | [ChangeLog][PySide6] The QmlExtended decorator has been added. Task-number: PYSIDE-1709 Change-Id: I56d1c75f281f37e9d23c64362ce89c5f1f49723a Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> Reviewed-by: Christian Tismer <tismer@stackless.com>
* Add the @QmlForeign decoratorFriedemann Kleint2022-02-111-0/+33
| | | | | | | | [ChangeLog][PySide6] The @QmlForeign decorator has been added. Task-number: PYSIDE-1709 Change-Id: I7dbba47923efb6a1c3ac4accb2b3adcd3fb6fd9b Reviewed-by: Christian Tismer <tismer@stackless.com>
* Add the @QmlNamedElement decoratorFriedemann Kleint2022-02-091-0/+31
| | | | | | | | | | | Add the decorator and split the registration functions in order to be able to pass a different type name. [ChangeLog][PySide6] The @QmlNamedElement decorator has been added. Task-number: PYSIDE-1709 Change-Id: I081cd33313d7b9c19cb6403ee56ac9d8b1d9e606 Reviewed-by: Christian Tismer <tismer@stackless.com>
* PySide6: Fix documentation for QmlUncreatableFriedemann Kleint2021-11-161-8/+9
| | | | | | | | | | | Add a blank line for code-block to work and fix the indentation. Amends a421aab61ad03afa595aa0ba7e53d84b1edbe892. Pick-to: 6.2 Task-number: PYSIDE-1709 Change-Id: Idecb8a69b510191ab1ea27754d71eb94b2f6394a Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Add a QmlSingleton decoratorFriedemann Kleint2021-11-162-0/+27
| | | | | | | | | | Add a simple decorator function that stores the type in a list for the QmlElement decorator to use singleton registration. Task-number: PYSIDE-1709 Pick-to: 6.2 Change-Id: I075d583404bd60dc52b84c23a3d09e50d32a5a3a Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Add a QmlUncreatable decoratorFriedemann Kleint2021-11-152-0/+32
| | | | | | | | | | | Add a class type that stores the reason and registers the type in the call operator. This is then queried by the register type helper functions. Pick-to: 6.2 Task-number: PYSIDE-1709 Change-Id: I0dd0c4c1e05e6e0ee6f22a6947b85546fc373fb9 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* PySide6: Add a QmlAnonymous decoratorFriedemann Kleint2021-11-101-0/+22
| | | | | | | | | | Split out a helper from the qmlElementMacro() to register (also preparing for uncreatable types) and add the decorator. Pick-to: 6.2 Change-Id: I0f3ebf6f31c141083440abcc9f1acd227ce046d7 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Implement qmlRegisterSingletonInstanceCristián Maureira-Fredes2021-08-171-0/+25
| | | | | | | | | | | | Using a similar approach to the qmlRegisterSingletonType, but wrapping the instance (QObject) into a SingletonFunctor as described in Qt/C++. Add helper function PySide::isQObjectDerived Task-number: PYSIDE-487 Change-Id: Id0fd9da0351a9ba58eae006d7d882f9815f06742 Reviewed-by: Christian Tismer <tismer@stackless.com>
* Allow spaces in ClassInfo keysBrett Stottlemyer2021-07-291-2/+15
| | | | | | | | | | | | | | | | | Qt Remote Objects uses ClassInfo keys with spaces. Because PySide uses keyword arguments for keys in the ClassInfo() decorator, it is not possible to create the QtRO info from PySide. This change supports both the current keyword processing as well as passing a python dict. Thus, for example, the following becomes possible: @ClassInfo({'RemoteObject Type': 'Simple', 'RemoteObject Signature':'c6f33edb0554ba4241aad1286a47c8189d65c845'}) class SimpleSource(QObject): ... Task-number: PYSIDE-862 Change-Id: I7764e92a46869766582611a70628dd23d033e09c Reviewed-by: Christian Tismer <tismer@stackless.com>
* Property: provide some hopefully exact documentationChristian Tismer2021-04-301-3/+70
| | | | | | | Task-number: PYSIDE-1513 Pick-to: 5.15 Change-Id: I5817869aaf495f4005c4fda92d15fceafb15600a Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Add further documentation on the Qt Designer pluginFriedemann Kleint2021-02-234-0/+82
| | | | | | | | | | Document the QPy*Extension base classes and functions of QPyDesignerCustomWidgetCollection. Task-number: PYSIDE-1455 Change-Id: I3874058ed50475a418be3becbeb22ad94066dca5 Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* PySide6/Documentation: Fix QmlElement.rstFriedemann Kleint2021-02-151-2/+4
| | | | | | | | | | Change the snippets to be Python code, fixing: QmlElement.rst:28: warning: Definition list ends without a blank line; unexpected unindent. Pick-to: 6.0 Change-Id: I98fa640e206199a466fa9aa8b5df3363fe118f69 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: Update references to Qt6Cristian Maureira-Fredes2020-12-091-4/+4
| | | | | | | | | | | * Updating versions, * Removing references to 5.x * Remove unavailable modules for Qt 6.0.0 * Comment unusable tutorials from the documentation Change-Id: I924953f97406ab8c5c04005a2d42dfbc03fdf7fa Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Christian Tismer <tismer@stackless.com>
* Fix sphinx warning in QtCore.Property.rstFriedemann Kleint2020-11-261-0/+1
| | | | | | | | | Fix doc/rst/PySide6/QtCore/Property.rst:3: WARNING: Explicit markup ends without a blank line; unexpected unindent. Pick-to: 5.15 Change-Id: I20311655899df17313aa657c0b93c9d488f3b5c8 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Rename PySide2 to PySide6Friedemann Kleint2020-11-0224-0/+552
Adapt CMake files, build scripts, tests and examples. Task-number: PYSIDE-904 Change-Id: I845f7b006e9ad274fed5444ec4c1f9dbe176ff88 Reviewed-by: Christian Tismer <tismer@stackless.com>
generated by cgit v1.2.3 (git 2.25.1) at 2025-12-18 21:05:15 +0000