aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* __feature__: handle properties with function overloadsChristian Tismer2021-10-281-0/+30
| | | | | | | | | | | | | | | | | | | | This is the implementation, see the conclusion of the issue. [ChangeLog][PySide6] When a property would override an existing function with multiple arity or parameters, append an underscore to the property name. REMARK: The current implementation is very correct. It uses introspection via the signature module. But that adds a constant overhead to the true_property feature. Actually, there are only 2 known cases where this overlap happens. It might be considered to simplify things by checking the string names of these two functions? Fixes: PYSIDE-1670 Pick-to: 6.2 Change-Id: I14927995698726957ba8c515dddf5e37c21910ce Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Documentation: Fix platform note on getting started pageFriedemann Kleint2021-10-211-4/+3
| | | | | | Pick-to: 6.2 Change-Id: I0027bd16aa0b5dea6bd51fb3b0df1b5cfb605388 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: include missing modulesCristián Maureira-Fredes2021-10-206-72/+98
| | | | | | | | | | | | | | | | | | The following modules were not generated automatically in the documentation: - QtBluetooth - QtDBus - QtNetworkAuth - QtRemoteObjects - QtSerialPort The two column order of the modules.rst page was removed in favor of moving the page to a box-style in the future. Fixes: PYSIDE-1694 Pick-to: 6.2 Change-Id: Ied62d15c0f4574d0e4f5a8202e5f08692f63e001 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Add a signals and slots tutorialFriedemann Kleint2021-10-073-0/+236
| | | | | | | Pick-to: 6.2 Task-number: PYSIDE-841 Change-Id: I7e78f97fed206f0722e50d967ec84800d3bef810 Reviewed-by: Christian Tismer <tismer@stackless.com>
* Documentation: Fix missing signal/slot lists in class documentationFriedemann Kleint2021-10-011-0/+1
| | | | | | | | | | | | | | | | | | shiboken needs to run with pyside extensions to parse the Qt annoations correctly. Change 62c21af778b7bff6c86e7f89ef03a87efa6c51cb moved the compiler defines from the pyside global header into shiboken. This caused the function type detection to fail in the doc generator since it did not pyside extensions and thus signals/slots were listed as normal functions. To fix this, move the --enable-pyside-extensions option to the base class Generator and add it to documentation's CMakeLists.txt. Pick-to: 6.2 5.15 Change-Id: I70142367ee01839d8e44cbf31e894991cf941197 Reviewed-by: Christian Tismer <tismer@stackless.com>
* Update the online CSS to scale the iconsVenugopal Shivashankar2021-09-291-1/+2
| | | | | | | | The scaled icons look better. Pick-to: 6.2 6.2.0 Change-Id: I66b95372787f3b78a1d4cb2e6bc0f7a2f48b0908 Reviewed-by: Christian Tismer <tismer@stackless.com>
* Documentation: Fix qtpositioning path for buildCristián Maureira-Fredes2021-09-281-2/+2
| | | | | | Pick-to: 6.2 6.2.0 Change-Id: Ia9f93a9d9cb6d31da3bf5a73a62a47a414b5f4c8 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: fix warnings from rst filesCristián Maureira-Fredes2021-09-272-3/+3
| | | | | Change-Id: I97166f7e89c0365f425d1f8b0b840b7ef066d0d7 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: fix missing image in why qt for pythonCristián Maureira-Fredes2021-09-271-0/+3
| | | | | Change-Id: I001f8e1ed3c40e4be8eebebe6a44a1c0c9c869a9 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Document the usage of NuitkaChristian Tismer2021-09-242-0/+142
| | | | | | | | | This documentation is adapted from the document deployment-pyinstaller.rst . Task-number: PYSIDE-1523 Change-Id: I2f42d596ea1073158ff8c198ed01a5816c745d58 Reviewed-by: Christian Tismer <tismer@stackless.com>
* tutorials: update datavisualization and expensesCristián Maureira-Fredes2021-09-2228-78/+141
| | | | | | | | | | | | | | | These tutorials were removed due to QtCharts not being available, additionally due to the QtCharts namespace changes the code needed to be adjusted. Adding panels for the tutorials to display as cards instead of a list, and creating a new section called 'General Applications'. Task-number: PYSIDE-841 Change-Id: I18fbce3fd48ed35013bcc82013ffc6e06f005b03 Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: update qml tutorialsCristián Maureira-Fredes2021-09-178-69/+102
| | | | | | | | | | | | - Add screenshot and updates to the 'first qml application' - Update 'context properties' for 'python-qml interaction' tutorial - Remove the 'Real use-cases' subsection - Update the snippets from QML application tutorial - Update the QML SQL integration tutorial Change-Id: I9c6a1bedb66b130e9c28d340b236e778f7c109b8 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Christian Tismer <tismer@stackless.com>
* PySide6: Document QUiLoader restriction wrt signal/slot connectionsFriedemann Kleint2021-09-151-0/+7
| | | | | | | Fixes: PYSIDE-1659 Pick-to: 6.1 5.15 Change-Id: I9025e8454d7153faec8b49f0ae02bf175dae3fd8 Reviewed-by: Christian Tismer <tismer@stackless.com>
* doc: improve tutorials and stylingCristián Maureira-Fredes2021-09-0935-97/+883
| | | | | | | | | | | | | - Creating screenshots for tutorials. - Add gallery style for tutorials. - Add corporate Icons to the frontpage. - tools: Reduce example long names in the gallery. - videos: new order using panels - Add tutorial about "Why Qt for Python" Change-Id: I3ba50f74998399a47b4a34c1de029f3b746aa1e2 Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
* doc: tweak css for card stylingCristián Maureira-Fredes2021-09-081-6/+14
| | | | | Change-Id: Ie2dc49e7570cb8624bf8e9b6eda2201979680cee Reviewed-by: Christian Tismer <tismer@stackless.com>
* doc: reduce main card sizesCristián Maureira-Fredes2021-09-032-8/+2
| | | | | | | | This reduces the height of the main documentation page, without altering the example cards. Change-Id: Ie15fa6bcbe407f7bf213c0a988e6f56665fde08e Reviewed-by: Christian Tismer <tismer@stackless.com>
* Pyside6/Documentation: Fix path to qtquickcontrols.qdocconfFriedemann Kleint2021-08-311-1/+1
| | | | | | | | The module has been moved into the declarative repo. Task-number: PYSIDE-1623 Change-Id: I47a8c689eab81319bb72360df011a61ab7281583 Reviewed-by: Christian Tismer <tismer@stackless.com>
* 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>
* doc: add logo inside the menubarCristian Maureira-Fredes2021-08-102-19/+32
| | | | | | | | | This is mainly to avoid the logo with a large white space next to it as header. Change-Id: I135b5f91b687b198750ae666b90696ea9e0a2424 Pick-to: 6.1 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* 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>
* feature: fix the UIC switching problemChristian Tismer2021-07-281-0/+9
| | | | | | | | | | | | | | | | | | | | | The BindingManager::getOverride function computes the current switch state from information of a type object. But the type object must first be updated in case a switch has happened. The solution was an extra update call at the beginning of the function. This solution _always_ works, with or without inheritance, for Python >= 3.7. [ChangeLog][shiboken6] Coexistence of different feature selections works now, especially for UIC files and inheritance. Fixes: PYSIDE-1626 Pick-to: 6.1 Pick-to: 5.15 Change-Id: I577331cfb2d7511110d1e16e729bed80985340a0 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* qml: replace context properties and code updatesCristián Maureira-Fredes2021-07-217-62/+87
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Most of the qml code in the repository was outdated, and followed bad practices, like context properties. Complementary, after the major updates for Qt6 most of the code was not relying on the new ways of register types (singletons, and using the decorator QmlElement). Drop the context property usage in the following examples: - signals/qmltopy1 - signals/qmltopy2 - signals/pytoqml2 - usingmodel - quickcontrols2/gallery - textproperties Additionally: - all the tests related to context properties - tutorials/qmlapp - tutorials/qmlsqlintegration - Removing 'scrolling' example - Fixing some flake8 warnings Change-Id: I649248c0149876bf2bf94e78e27cef7110f42f1d Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Keith Kyzivat <keith.kyzivat@qt.io>
* qtattributionsscanner.py: Locate binary in libexecFriedemann Kleint2021-07-201-1/+5
| | | | | | | | | qtattributionsscanner was moved to libexec by qttools/0861ee9e695300645e098c331428ae3a256e74e5 (Qt 6.2). Change-Id: I4267faa2fb429b20ab0486bf5665e0a585da9574 Reviewed-by: Christian Tismer <tismer@stackless.com>
* PySide6: Fix QtWebEngine documentationFriedemann Kleint2021-07-203-3/+10
| | | | | | | Adapt the paths to the new modules and add TOC entries. Change-Id: Icf5249650db18b113e35d1596c853221348eca20 Reviewed-by: Christian Tismer <tismer@stackless.com>
* PySide6: Add Qt Quick Controls 2 to the documentationFriedemann Kleint2021-07-201-0/+3
| | | | | | | Pick-to: 6.1 Fixes: PYSIDE-1623 Change-Id: I667681f5a419921ddd25e04528b3880b7001214f Reviewed-by: Christian Tismer <tismer@stackless.com>
* Add a linguist exampleFriedemann Kleint2021-07-071-0/+82
| | | | | | | | Add an example and a tutorial section. Task-number: PYSIDE-1252 Change-Id: Ib0f1399abe9b0eb832c0202f54cb83dfad870d17 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* pathlib: support all cases which are found in the examplesChristian Tismer2021-07-063-3/+3
| | | | | | | | | | | | Wherever possible/useful, os.fspath was removed and the according pathlike modification inserted. This is still not the awaited end of the conversion, but a good step forward. Task-number: PYSIDE-1499 Pick-to: 6.1 Change-Id: I0a22ddeec06ada05dc4a97ed104d06f5f1bbf472 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Add a gettext exampleFriedemann Kleint2021-07-062-0/+120
| | | | | | | | | Add a small example along with a German translation using gettext. Add a tutorial. Pick-to: 6.1 Change-Id: I254a5a66521ecc2827a5811469d9d21360f99b81 Reviewed-by: Christian Tismer <tismer@stackless.com>
* pathlib: extend QUrl.fromFilePath to support os.PathLikeChristian Tismer2021-07-021-1/+1
| | | | | | | | | | | [ChangeLog][PySide6] The function QUrl.fromFilePath supports now the os.PathLike structure in addition to string arguments. The new interface was applied, everywhere. Change-Id: I2d888383c54b7f964e448d210264c7e902759f43 Pick-to: 6.1 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* PySide6: Update documentation on Qt Designer and resource filesFriedemann Kleint2021-06-283-15/+27
| | | | | | | | | Link from typesoffiles.rst to the tutorials and flesh them out a bit. Task-number: PYSIDE-1112 Pick-to: 6.1 Change-Id: I67fccb29d880bd2ba5af8e5dd77a4f6406ea55ad Reviewed-by: Christian Tismer <tismer@stackless.com>
* PySide6: Add some information on the toolsFriedemann Kleint2021-06-174-0/+25
| | | | | | Task-number: PYSIDE-1378 Change-Id: I9433fd3b1d4d09c6a7d961d67c103ccd651e5beb Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* examples: add default imageCristian Maureira-Fredes2021-06-121-0/+0
| | | | | | | | | | Adding a default image for examples that have no screenshot yet, or are terminal based. Task-number: PYSIDE-841 Pick-to: 6.1 Change-Id: I771173801218654a99f11d1062df12aa10a64eec Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* examples: tweak css for the galleryCristian Maureira-Fredes2021-06-111-0/+17
| | | | | | | | | - Using cards with buttons - Fit images as a cover for each example Task-number: PYSIDE-841 Change-Id: I1702fbad8fabc9d0f9e2a06d46afcf73b4075c8d Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* PySide6: Extend the porting guideFriedemann Kleint2021-05-281-0/+2
| | | | | | | Pick-to: 6.1 Fixes: PYSIDE-1583 Change-Id: Id2fc50237c8c5256a280f822b4c2e1445a9b9aec Reviewed-by: Christian Tismer <tismer@stackless.com>
* __feature__: Support generation of modified .pyi filesChristian Tismer2021-05-211-0/+17
| | | | | | | | | | | | | | | | We add a possibility to select features before generating the pyi files. This will improve the feature adoption, because common IDEs can use these changed .pyi files. - avoid crashes because of early selection - add an option to generate_pyi - document pyside6-genpyi and shiboken6-genpyi - build a correct display of properties Task-number: PYSIDE-1019 Pick-to: 6.1 Change-Id: Ib75dfcbaccaa969ef47eeb142d9c034a2a6c11d6 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Remove QtX11Extras, QtMacExtrasFriedemann Kleint2021-05-171-5/+1
| | | | | | | Task-number: QTBUG-83251 Task-number: PYSIDE-1568 Change-Id: I36117d83f51b708882c1283c3a16528fcb5384e2 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Purge remaining app.exec_()Friedemann Kleint2021-05-1741-46/+49
| | | | | | | | Add a porting note. Pick-to: 6.1 Change-Id: I4ccb1dc2a3a5925e55e94e7f3d23b1fb199afe4a Reviewed-by: Christian Tismer <tismer@stackless.com>
* Add some hints for trouble-shooting the Qt Designer pluginFriedemann Kleint2021-05-071-0/+13
| | | | | | | Pick-to: 6.1 6.1.0 Task-number: PYSIDE-1455 Change-Id: I7bf6745801dc4747cb7f24144e197bd3059bd493 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* 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>
* doc: snippets_translate make quiet mode by defaultCristian Maureira-Fredes2021-04-281-4/+1
| | | | | | | | | | | | | | | | | Without being 'quiet' the script was generating output to the stdout and stderr, which was triggering the cmake instruction to make the build fail This change makes the quiet mode by default, the old output that summarize each snippet file can be obtained by using the '--verbose' option. A new option called '--debug' was introduced to get even more output related to each translation happening per file. Pick-to: 6.0.4 Change-Id: I7fce09f0b60e626c957efc4fe24948e0eaf3db74 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: fatal error when snippet conversion failsCristian Maureira-Fredes2021-04-261-1/+5
| | | | | | | | | | | | | | | | | | | | | | When the snippets_translate tool fails, the build process continues normally, falling back to use the original C++ snippets. This problem can be dangerous, since we will not notice if something is wrong without checking the full log. This patch make the build process to fail when the tool doesn't exit normally. For builds where the documentation generation is skipped, this change will have no effect. Complementary to this, the patch includes a new Python file to determine if the C++ include have an import counterpart in Python. Fixes: PYSIDE-1527 Pick-to: 6.0.4 Change-Id: I725b623f60dbc540a6e7834502300c39cd22b5a3 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* doc: update cx_Freeze urlElisabeth Ortega2021-04-182-2/+2
| | | | | | Pick-to: 6.0 Change-Id: I9c1cb964e1b9a05f9940382d58ecdf820865d532 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* feature-import: Hide confusing feature frame entryChristian Tismer2021-03-311-0/+26
| | | | | | | | | | | | | | | | | | | | The feature construct adds an extra level of indirection to the import command that shows up in tracebacks. This is quite irritating. To avoid these extra layer and much effort fo fix this in Python, it is more straight-forward to write a C function and - calls our redirection and returns if ok or error - calls the original import when feature not applicable. The change to the import function is made transparent by the builtin variables __orig_import__ and __feature_import__. Task-number: PYSIDE-1338 Task-number: PYSIDE-1019 Change-Id: Iacae6fbc47cf85f366f59ec3f6c5cca66d5ad65e Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: enable snippets translate toolCristian Maureira-Fredes2021-03-25518-40945/+18
| | | | | | | | | | | | | | | | Create snippets directories in case they don't exist. Add "-q" option as the examples directory to keep the "--quiet" option from the build. Something to consider with this patch: Removing all the previous old snippets, which include not only 'cpp' files, but also '.h', '.qdoc', '.qrc', '.png', and '.qml', which might be used in the snippets, but will need to be updated in the generation tool, to not translate, and copy them over. Pick-to: 6.0 Change-Id: Icbef9e1c93a12b90dbcfa990ef055ca6f8868407 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Fix missing doc snippetsFriedemann Kleint2021-03-251-3/+9
| | | | | | | | | | Ensure doc snippets are copied to the build directory by creating a separate target. Amends 93ae3d9b38649e9d683a658a6a19b7623083f5a0. Pick-to: 6.0 Change-Id: Idfd3b55e79769fdceda64ee29bffae801eb9055b Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Improve deployment documentationFriedemann Kleint2021-03-224-0/+54
| | | | | | | | | | | Extend the table by the Qt version. Add some chapter on Qt 6 support. Add some description for py2exe. Task-number: PYSIDE-1112 Pick-to: 6.0 Change-Id: Ic3a9fb76d9c13017a107f083da4c7ed326d64e5c Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Improve Porting documentationFriedemann Kleint2021-03-191-6/+68
| | | | | | | | Task-number: PYSIDE-1112 Task-number: PYSIDE-1482 Pick-to: 6.0 Change-Id: Ic65d86e2567849f26cb28c480937e7fb41ad5856 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* doc: migrate qdoc approach to document examplesCristian Maureira-Fredes2021-03-1712-203/+1
| | | | | | | | | | | | | | | | | There were two previous documented examples using the approach based on qdoc: stardelegate, and classwizard. This patch moves them into the 'doc/' directory for each example, and partially revert the changes from 308157f01260c640e21f6972619d3b380c007acb Additionally, an unrelated screenshot was moved to a new general 'images/' directory. Task-number: PYSIDE-1112 Pick-to: 6.0 Change-Id: I239a24fa4e4f970540857ba8b33b9b13c18142b1 Reviewed-by: Christian Tismer <tismer@stackless.com>
* doc: add sphinx-panels to the documentationCristian Maureira-Fredes2021-03-176-35/+124
| | | | | | | | | | | | | | | | | | | | | | This plugin replaces sphinx-tabs, so that's removed. The panels plugin will add bootstrap responsive cards to the docs allowing us to use them instead of the ad-hoc table we had. Additionally, this changes the example gallery tool too, since the main gallery was built using our own table implementation. Since Panels also provides options to add content in tabs, with CSS instead of JS (from sphinx-tabs), we update the generated examples files. Fixing warning messages related to files that didn't exist, duplicated references, and redundant indexes. Task-number: PYSIDE-1112 Pick-to: 6.0 Change-Id: Id19be92e72f0a18f63b76daf1898080f3e199626 Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* feature: write some documentation that explains featureChristian Tismer2021-03-012-1/+278
| | | | | | | | | | | | | | | | Features were a little bit visible in 5.15 already. In 6.0, they were also mentioned in some tutorial, but the main PySide documentation was lacking official information. This text shall provide exact information about features, what they are and why we wanted them. Task-number: PYSIDE-1019 Change-Id: I86ff36b76b9aef602cff485daf583570f9b7292c Fixes: PYSIDE-1481 Task-number: PYSIDE-1483 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
generated by cgit v1.2.3 (git 2.25.1) at 2025-12-19 03:45:02 +0000