aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside2/doc
Commit message (Collapse)AuthorAgeFilesLines
* Rename PySide2 to PySide6Friedemann Kleint2020-11-02743-57989/+0
| | | | | | | | Adapt CMake files, build scripts, tests and examples. Task-number: PYSIDE-904 Change-Id: I845f7b006e9ad274fed5444ec4c1f9dbe176ff88 Reviewed-by: Christian Tismer <tismer@stackless.com>
* Remove version suffixes from the example documentationFriedemann Kleint2020-11-027-14/+14
| | | | | Change-Id: Ia59b552467a58c1e7b791f5cafee571cd3c867bb Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* pyside/doc: remove python 2 referencesCristian Maureira-Fredes2020-10-287-30/+8
| | | | | | Change-Id: Ife968831c695f1982f9d0ed1157f9128331a700e Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Rename shiboken2 to shiboken6Friedemann Kleint2020-10-287-26/+26
| | | | | | | | Adapt CMake files, build scripts, tests and examples. Task-number: PYSIDE-904 Change-Id: I4cb5ee4c8df539546014b08202a7b1e98ed3ff07 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* QtQml: Implement QmlElementMaximilian Goldstein2020-10-221-0/+28
| | | | | | | | Equivalent to QML_ELEMENT in C++, this enables users to register classes for use in QML by using the QmlElement decorator. Change-Id: I697e486ef58b18cce4c310e4b556e28735a16d45 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* Merge remote-tracking branch 'origin/5.15' into devFriedemann Kleint2020-10-219-181/+229
|\ | | | | | | Change-Id: I8831b840fa7816b8919ecbaab17b41822a0a6012
| * doc: update versions and comandsCristian Maureira-Fredes2020-10-219-181/+229
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * add new way of building rst-only documentation * Updating recommended libclang for 5.15 * recommending python 3.5+ * link commercial license * Show videos as grid * changing title of a tutorial to be more specific * add missing step to build only shiboken * add venv as an option before virtualenv * add problem on windows and python 3.8.0 * add section to create a virtual environment * only show titles of tutorials to avoid having a long page Change-Id: Iebb99d2cd776c3d5b72dc44153f325f74a1626cc Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* | Merge remote-tracking branch 'origin/5.15' into devFriedemann Kleint2020-10-066-6/+6
|\| | | | | | | Change-Id: I7b4ff138799ee81940c36e68a105cb42bb38a3ff
| * Documentation: Fix virtualenv URLFriedemann Kleint2020-10-051-1/+1
| | | | | | | | | | | | Fixes: PYSIDE-1391 Change-Id: I48e8878cca28831eb881383a31d4b4b87236c85d Reviewed-by: Christian Tismer <tismer@stackless.com>
| * doc: remove qApp importCristian Maureira-Fredes2020-10-055-5/+5
| | | | | | | | | | | | | | Fixes: PYSIDE-1382 Change-Id: I84dbd296093f38642922b3642e866e77224a58f2 Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* | Merge remote-tracking branch 'origin/5.15' into devFriedemann Kleint2020-09-302-73/+87
|\| | | | | | | Change-Id: I13721e13d2fab13945385fe529afe4ab431e0532
| * Add command to build rst documentation onlyCristian Maureira-Fredes2020-09-292-73/+87
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Since the process to get the documentation built is to build the whole project, that is too time consuming. Additionally, using qdoc on the Qt API takes a lot of time. This patch introduces the setup.py option called 'build_rst_docs' which skip the general build, and only generates HTML documentation based on all the .rst files we have for shiboken and pyside. To use it: python setup.py build_rst_docs The build will throw warnings related missing directories, and files, which are generated on the 'qdoc' process, but since they are skipped they are not present. Some missing references warnings are skipped due to also come from the qdoc-based step. Task-number: PYSIDE-1106 Fixes: PYSIDE-1390 Change-Id: I4118fd3b64e217717df6cae093138f6951d37094 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* | Merge remote-tracking branch 'origin/5.15' into devFriedemann Kleint2020-09-297-14/+19
|\| | | | | | | Change-Id: Ie6da3938b82f5ebe96dd12bd65a3ccc4180d2fba
| * doc: fix more sphinx warningsCristian Maureira-Fredes2020-09-295-6/+9
| | | | | | | | | | Change-Id: I07a87ad49546534f3492b534b2a2dd4945304de7 Reviewed-by: Christian Tismer <tismer@stackless.com>
| * Fix some sphinx warnings in Pyside2 documentationFriedemann Kleint2020-09-282-8/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | sources/pyside2/doc/deployment-briefcase.rst:163: WARNING: Title underline too short. sources/pyside2/doc/deployment-briefcase.rst:178: WARNING: Title underline too short. sources/pyside2/doc/deployment-briefcase.rst:178: WARNING: Title underline too short. sources/pyside2/doc/modules.rst:4: WARNING: toctree glob pattern 'PySide2/Qt*/index' didn't match any documents sources/pyside2/doc/tutorials/qmlsqlintegration/qmlsqlintegration.rst:103: WARNING: Unexpected indentation. sources/pyside2/doc/tutorials/qmlsqlintegration/qmlsqlintegration.rst:104: WARNING: Block quote ends without a blank line; unexpected unindent. sources/pyside2/doc/tutorials/qmlsqlintegration/qmlsqlintegration.rst:209: WARNING: Unexpected indentation. sources/pyside2/doc/tutorials/qmlsqlintegration/qmlsqlintegration.rst:211: WARNING: Block quote ends without a blank line; unexpected unindent. Change-Id: I06900906584644ed585a386803ff33939fd11103 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* | Merge remote-tracking branch 'origin/5.15' into devFriedemann Kleint2020-09-242-2/+7
|\| | | | | | | Change-Id: I7e4c7f9378706438715362b1e2da9a3cd2794562
| * add wiki link to doc indexJimmy Girardet2020-09-231-0/+4
| | | | | | | | | | | | | | Change-Id: I52f429fcc091d54b4eb409af121a1afa2f0dceae Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> (cherry picked from commit a0a7b1fe8c976683832d0305e7e2cdf02faac928) Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
| * Add user property QLayout::contentsMarginsFriedemann Kleint2020-09-231-2/+3
| | | | | | | | | | | | | | | | This becomes a real Q_PROPERTY only in Qt 6, so, add it here. Task-number: PYSIDE-1019 Change-Id: I98f8c674370c01605270d7c78bc199464e66642d Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* | Merge remote-tracking branch 'origin/5.15' into devFriedemann Kleint2020-09-172-24/+24
|\| | | | | | | Change-Id: I8aa48d07067c45c888c73af87314f6a88c2a6e14
| * feature_select: Implement True PropertiesChristian Tismer2020-09-162-24/+24
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This feature is now almost fully implemented. TODO: Static properties like `QtWidgets.QApplication.platformName` are skipped for now. They need support by the meta class. Maybe this is a reason to use QtCore.Property instead of vanilla Python property and improve it. With the new infrastructure, we can also consider to add properties which have no equivalent in the Qt implementation. A prominent example is "central_widget". Change-Id: Ia0e32e41de8ab72e3bba74878e61bcbac6da50ea Task-number: PYSIDE-1019 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* | Merge remote-tracking branch 'origin/5.15' into devFriedemann Kleint2020-09-101-0/+14
|\| | | | | | | Change-Id: I8a627fd459c3f9601d078a00d3d77c8b3fe04304
| * Implement default __ne__ and __eq__ for all PySide typesAlex Hughes2020-09-081-0/+14
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | PySide types have been following the Qt implementation of comparisons, completely. This is not correct for Python, because the Python default has the operators `==` and `!=` at least. They are needed for tests like `obj in collection`. We fix this by redirecting the default case to `PyBaseObject_Type.tp_richcompare`. This is the correct way to fix it, because for types which do not define `tp_richcompare', this is the default, anyway. From the original patch, the test case is still in use. Old message: Implement __ne__ and __eq__ for QTreeWidgetItem Testing if a QTreeWidgetItem belongs to a list raises a NotImplementedError. I have exposed the operator== and the operator!= from C++ to shiboken which has solved our eq operator issue. Implemented the test from PYSIDE-74 for the QTreeWidgetItem eq operator and the ne operator. This also allows us to have the behavior "QTreeWidgetItem in ['a']" and "QTreeWidgetItem not in ['a']". Adding qtreewidgetitem_test.py to CMakeFiles.txt Fixes: PYSIDE-74 Change-Id: Id221c0163fc8c2d85730c4c26f22db5f61710706 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* | Bump cmake version to 3.16Friedemann Kleint2020-09-041-2/+2
| | | | | | | | | | | | | | | | | | | | Streamline the features list handling in the module CMakeLists to use the list functionality introduced in cmake 3.3. Task-number: PYSIDE-1339 Task-number: PYSIDE-904 Change-Id: I184034cae408c815bd80a09016a21fde2969449e Reviewed-by: Christian Tismer <tismer@stackless.com>
* | Remove QtScript, QtXmlPatternsFriedemann Kleint2020-09-042-6/+0
| | | | | | | | | | | | | | | | | | They are obsolete in Qt 6. Task-number: PYSIDE-1339 Task-number: PYSIDE-904 Change-Id: I70816b3c3270a1db65ad3b3871a09c62d31420e5 Reviewed-by: Christian Tismer <tismer@stackless.com>
* | Merge remote-tracking branch 'origin/5.15' into devFriedemann Kleint2020-08-311-1/+6
|\| | | | | | | Change-Id: Icf4b3535be52b64ef15eced7103bb1280e031e30
| * CSS: Make sidebar stick to the topTopi Reinio2020-08-261-1/+6
| | | | | | | | | | | | | | | | | | With 'position: sticky' we can make the sidebar stick to the top but never go out of bounds to overlap the content or the footer. Fixes: PYSIDE-1148 Change-Id: Id3875d44caf88e070a8abdf7b81ab8e53ad5e4d5 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* | Merge remote-tracking branch 'origin/5.15' into devFriedemann Kleint2020-07-241-0/+209
|\| | | | | | | Change-Id: Ib38f2f4be9f214df79454ff972ccd20fbfc6d1cd
| * feature-select: allow snake_case instead of camelCase for methodsChristian Tismer2020-07-241-0/+209
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This is the implementation of the first of a series of dynamically selectable features. The decision depends of the following setting at the beginning of a module after PySide2 import: from __feature__ import snake_case For more info, see the Jira issue, section The Principle Of Selectable Features In PySide The crucial problems that are now solved were: - it is not sufficient to patch a type dict, instead the whole `tp_mro` must be walked to rename everything. - tp_getattro must be changed for every existing type. This is done either in shiboken by a changed PyObject_GenericGetAttr or PyObject_SenericGetAttr, or in the generated tp_(get|set)attro functions. An example is included in sources/pyside2/doc/tutorial/expenses. Task-number: PYSIDE-1019 Change-Id: I5f103190be2c884b0b4ad806187f3fef8e6598c9 Reviewed-by: Christian Tismer <tismer@stackless.com>
* | doc: Add docs for qmlRegisterUncreatableTypeMaximilian Goldstein2020-07-241-0/+36
| | | | | | | | | | | | Change-Id: I8d46f4f6b82639b417a146a81f84888ce363d5d4 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* | doc: add qmlRegisterType and qmlRegisterSingletonTypeCristian Maureira-Fredes2020-07-242-0/+85
| | | | | | | | | | | | | | | | | | | | | | | | | | when the inject-documentation tag is used inside a namespace or module instead of class, it does not properly work. With this workaround, the data will be rendered on the online/offline documentation. Task-number: PYSIDE-691 Change-Id: I832f43cb1ffba9294a2e282ba002ce4aff07e253 Reviewed-by: Maximilian Goldstein <max.goldstein@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Christian Tismer <tismer@stackless.com>
* | Merge remote-tracking branch 'origin/5.15' into devFriedemann Kleint2020-07-231-24/+24
|\| | | | | | | Change-Id: I478e94aa42c9f79011edf97f19a7abebb7214421
| * doc: fix Property indentationCristian Maureira-Fredes2020-07-221-24/+24
| | | | | | | | | | | | Fixes: PYSIDE-1353 Change-Id: I65630921f02f2a47c8319349ce649e037a0748b5 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* | Merge remote-tracking branch 'origin/5.15' into devFriedemann Kleint2020-07-142-1/+211
|\| | | | | | | Change-Id: Ib984e8fab81ee0cef3c9ab61982ee1a990319d5a
| * Doc: add briefcase deployment docJimmy Girardet2020-07-132-1/+211
| | | | | | | | | | Change-Id: Id0d896330dabee3b5b01aea70f1f15a30797d466 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* | Revert "add wiki link to doc index"Cristian Maureira-Fredes2020-07-061-4/+0
| | | | | | | | | | | | | | | | | | This reverts commit a0a7b1fe8c976683832d0305e7e2cdf02faac928. Reason for revert: <INSERT REASONING HERE> Change-Id: I1c324373696bd6835185add5d51ff7d071a3a2ea Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* | Remove QtWebKitCristián Maureira-Fredes2020-07-066-494/+0
| | | | | | | | | | | | | | | | Since it was deprecated in 5.5, it's time to remove it from the repository. Change-Id: I0835f04d6c34079dfc289be8027985a1dc3674bc Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* | add wiki link to doc indexJimmy Girardet2020-07-061-0/+4
| | | | | | | | | | Change-Id: I52f429fcc091d54b4eb409af121a1afa2f0dceae Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* | Initial port of Core,Gui,Widgets,Network,Qml,Quick to Qt 6Friedemann Kleint2020-07-0316-23/+32
|/ | | | | | | | | | | | | | | | | | | | | | | | | Test failures: shiboken2:testmodifyfunction pyside2:QtCore::qbytearray_test pyside2:QtGui::bug_PYSIDE-41 pyside2:QtGui::deepcopy_test pyside2:QtGui::qfontmetrics_test pyside2:QtGui::qpixmapcache_test pyside2:QtWidgets::api2_test (QTBUG-85417) pyside2:QtWidgets::bug_632 pyside2:QtWidgets::bug_714 pyside2:QtWidgets::bug_785 pyside2:QtWidgets::qshortcut_test pyside2:QtQml::bug_825 pyside2:QtQml::bug_1029 pyside2:QtQml::registertype pyside2:QtQml::qqmlincubator_incubateWhile pyside2:QtQml::signal_arguments Task-number: PYSIDE-1339 Task-number: PYSIDE-904 Change-Id: Ia43d7ed037dfdd07def0edd76bada2243e73d335 Reviewed-by: Christian Tismer <tismer@stackless.com>
* doc: Add widget styling tutorialCristian Maureira-Fredes2020-06-198-0/+288
| | | | | | | | | | Usage of the 'setStyleSheet' function and loading '.qss' files. Task-number: PYSIDE-841 Change-Id: I905025488c75cf379c7d77427da93d217169c604 Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Implement the QEnum/QFlag decorator, V2Christian Tismer2020-06-151-0/+92
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This implementation allows module-level and scoped QEnums which are Python enum types. Scoped types are registered in Qt's meta object system. Usage of QEnum/QFlag with decorator or function call: from enum import Enum, Flag, auto from PySide2.QtCore import QEnum, QFlag, QObject class Compass(QObject): @QEnum class Orientation(Enum): North, East, South, West = range(4) class Color(Flag): RED = auto() BLUE = auto() GREEN = auto() WHITE = RED | BLUE | GREEN QFlag(Color) Fixes: PYSIDE-957 Change-Id: Ie15f45cbd932c816b50724a96eee0c14ae1fdee8 Task-number: PYSIDE-487 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Doc: Add import statement for QIODeviceNico Vertriest2020-06-051-1/+1
| | | | | | Task-number: QTBUG-84270 Change-Id: If196369012fa740b90293ede2f7b2740657fbec9 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Doc: Fix a typo and a broken linkVenugopal Shivashankar2020-06-041-2/+2
| | | | | Change-Id: Ic3515aea317d4b8e2d0286b60a5c3b68bd20bbdf Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Doc: Enable doc builds using the offline templateVenugopal Shivashankar2020-06-0414-40/+2156
| | | | | | | | | | A new command-line option, --doc-build-online, enables to choose online builds, otherwise offline docs are built by default. Change-Id: I34ef8a22ef3bd321bd972c4f2873e4321c9c336a Fixes: PYSIDE-1292 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
* docs: fix item list in tutorial/expensesCristian Maureira-Fredes2020-06-031-6/+6
| | | | | Change-Id: I0f8d6784cfc567ac3a502df52e26413abec92a59 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Doc: Fix typo in the module pageVenugopal Shivashankar2020-06-021-1/+1
| | | | | Change-Id: Icc09814ca6f8c08b6903f2b00fdd95812cfcd54a Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Doc: Document QtUiTools.loadUiType functionVenugopal Shivashankar2020-05-281-0/+36
| | | | | | | | | | | | Removing the old inject-documentation approach from the typesystem, since the function lives in the module but does not belong to any class. Also some changes to the text were done, since there was a wrong statement regarding the PATH of uic. Change-Id: I7c8bf088f58ff9b6731ba66283ee384f6526c64b Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Merge remote-tracking branch 'origin/5.14' into 5.15Friedemann Kleint2020-05-261-1/+1
|\ | | | | | | Change-Id: I9c7163094bc934f481002adcea78ef4928ed26be
| * Implement __qualname__ and correct __module__ for classesChristian Tismer2020-05-161-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | PyType_FromSpec breaks the name "A.B.C.D" in module "A.B.C" and name = qualname = "D". We fix that for PySide: module = "A.B" qualname = "C.D" name = "D" and for other prefixes like Shiboken: module = "A" qualname = "B.C.D" name = "D" This had quite some impact on the signature modules. Change-Id: Ie94971ba737107b15adbfc2517e1ed32b65fda39 Fixes: PYSIDE-1286 Task-number: PYSIDE-15 Reviewed-by: Christian Tismer <tismer@stackless.com>
* | Rename and update some snippetsCristian Maureira-Fredes2020-05-2523-774/+984
| | | | | | | | | | | | | | | | | | | | | | | | | | * Renaming a few .cpp files into .py * Replacing the use of SIGNAL() and SLOT() * Fixing Python syntax * Removing C++-isms from translated Python code * Including the snippets from QStackedLayout Task-number: PYSIDE-691 Fixes: PYSIDE-1309 Change-Id: I431be3d930b2adc36a22118901baa6799581adb2 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* | doc: add tutorial for using qrc filesCristian Maureira-Fredes2020-05-2211-2/+172
| | | | | | | | | | | | | | | | | | We currently have only a tutorial for .ui files, and the .qrc case was missing. Task-number: PYSIDE-841 Change-Id: Ic12e8e77cb1ee042bc118fab74c97b3f6ba54ff4 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
generated by cgit v1.2.3 (git 2.25.1) at 2024-04-20 05:44:23 +0000