diff options
Diffstat (limited to 'sources/pyside2/doc/extras')
24 files changed, 0 insertions, 552 deletions
diff --git a/sources/pyside2/doc/extras/QtCore.ClassInfo.rst b/sources/pyside2/doc/extras/QtCore.ClassInfo.rst deleted file mode 100644 index 89ca926c7..000000000 --- a/sources/pyside2/doc/extras/QtCore.ClassInfo.rst +++ /dev/null @@ -1,23 +0,0 @@ -.. currentmodule:: PySide2.QtCore -.. _ClassInfo: - -ClassInfo -********* - -This class is used to associates extra information to the class, which is available -using QObject.metaObject(). Qt and PySide doesn't use this information. - -The extra information takes the form of a dictionary with key and value in a literal string. - -.. note:: This Class is a implementation of Q_CLASSINFO macro. - - -Example -------- - -:: - - @ClassInfo(Author='PySide Team', URL='http://www.pyside.org') - class MyObject(QObject): - ... - diff --git a/sources/pyside2/doc/extras/QtCore.Property.rst b/sources/pyside2/doc/extras/QtCore.Property.rst deleted file mode 100644 index a10c9f807..000000000 --- a/sources/pyside2/doc/extras/QtCore.Property.rst +++ /dev/null @@ -1,62 +0,0 @@ -.. currentmodule:: PySide2.QtCore -.. _Property: -Property -******** - -Detailed Description --------------------- - -The Property function lets you declare properties that -behave both as Qt and Python properties, and have their -setters and getters defined as Python functions. - -Here is an example that illustrates how to use this -function: - -.. code-block:: - :linenos: - - from PySide2.QtCore import QObject, Property - - class MyObject(QObject): - def __init__(self,startval=42): - QObject.__init__(self) - self.ppval = startval - - def readPP(self): - return self.ppval - - def setPP(self,val): - self.ppval = val - - pp = Property(int, readPP, setPP) - - obj = MyObject() - obj.pp = 47 - print(obj.pp) - -Properties in QML expressions ------------------------------ - -If you are using properties of your objects in QML expressions, -QML requires that the property changes are notified. Here is an -example illustrating how to do this: - -.. code-block:: - :linenos: - - from PySide2.QtCore import QObject, Signal, Property - - class Person(QObject): - def __init__(self, name): - QObject.__init__(self) - self._person_name = name - - def _name(self): - return self._person_name - - @Signal - def name_changed(self): - pass - - name = Property(str, _name, notify=name_changed) diff --git a/sources/pyside2/doc/extras/QtCore.QEnum.rst b/sources/pyside2/doc/extras/QtCore.QEnum.rst deleted file mode 100644 index a5a2e31fd..000000000 --- a/sources/pyside2/doc/extras/QtCore.QEnum.rst +++ /dev/null @@ -1,92 +0,0 @@ -.. currentmodule:: PySide2.QtCore -.. _QEnum: - -QEnum/QFlag -*********** - -This class decorator is equivalent to the `Q_ENUM` macro from Qt. -The decorator is used to register an Enum to the meta-object system, -which is available via `QObject.staticMetaObject`. -The enumerator must be in a QObject derived class to be registered. - - -Example -------- - -:: - - from enum import Enum, Flag, auto - - from PySide2.QtCore import QEnum, QFlag, QObject - - class Demo(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) # identical to @QFlag usage - - -Caution: --------- - -QEnum registers a Python Enum derived class. -QFlag treats a variation of the Python Enum, the Flag class. - -Please do not confuse that with the Qt QFlags concept. Python does -not use that concept, it has its own class hierarchy, instead. -For more details, see the `Python enum documentation <https://docs.python.org/3/library/enum.html>`_. - - -Details about Qt Flags: ------------------------ - -There are some small differences between Qt flags and Python flags. -In Qt, we have for instance these declarations: - -:: - - enum QtGui::RenderHint { Antialiasing, TextAntialiasing, SmoothPixmapTransform, - HighQualityAntialiasing, NonCosmeticDefaultPen } - flags QtGui::RenderHints - -The equivalent Python notation would look like this: - -:: - - @QFlag - class RenderHints(enum.Flag) - Antialiasing = auto() - TextAntialiasing = auto() - SmoothPixmapTransform = auto() - HighQualityAntialiasing = auto() - NonCosmeticDefaultPen = auto() - - -As another example, the Qt::AlignmentFlag flag has 'AlignmentFlag' as the enum -name, but 'Alignment' as the type name. Non flag enums have the same type and -enum names. - -:: - - enum Qt::AlignmentFlag - flags Qt::Alignment - -The Python way to specify this would be - -:: - - @QFlag - class Alignment(enum.Flag): - ... - -We are considering to map all builtin enums and flags to Python enums as well -in a later release. - diff --git a/sources/pyside2/doc/extras/QtCore.Signal.rst b/sources/pyside2/doc/extras/QtCore.Signal.rst deleted file mode 100644 index a0660f88f..000000000 --- a/sources/pyside2/doc/extras/QtCore.Signal.rst +++ /dev/null @@ -1,39 +0,0 @@ -.. currentmodule:: PySide2.QtCore -.. _Signal: - -Signal -****** - -Synopsis --------- - -Functions -^^^^^^^^^ - -+---------------------------------------------------------------------------------------------+ -|def :meth:`connect<Signal.connect>` (receiver) | -+---------------------------------------------------------------------------------------------+ -|def :meth:`disconnect<Signal.disconnect>` (receiver) | -+---------------------------------------------------------------------------------------------+ -|def :meth:`emit<Signal.disconnect>` (\*args) | -+---------------------------------------------------------------------------------------------+ - -Detailed Description --------------------- - - The :class:`~.Signal` class provides a way to declare and connect Qt signals in a pythonic way. - - PySide adopt PyQt's new signal and slot syntax as-is. The PySide implementation is functionally compatible with the PyQt 4.5 one, with the exceptions listed bellow. - -.. method:: Signal.connect(receiver[, type=Qt.AutoConnection]) - - Create a connection between this signal and a `receiver`, the `receiver` can be a Python callable, a :class:`Slot` or a :class:`Signal`. - -.. method:: Signal.disconnect(receiver) - - Disconnect this signal from a `receiver`, the `receiver` can be a Python callable, a :class:`Slot` or a :class:`Signal`. - -.. method:: Signal.emit(*args) - - `args` is the arguments to pass to any connected slots, if any. - diff --git a/sources/pyside2/doc/extras/QtCore.Slot.rst b/sources/pyside2/doc/extras/QtCore.Slot.rst deleted file mode 100644 index 5a59a2ae3..000000000 --- a/sources/pyside2/doc/extras/QtCore.Slot.rst +++ /dev/null @@ -1,39 +0,0 @@ -.. currentmodule:: PySide2.QtCore -.. _Slot: - -Slot -**** - -Detailed Description --------------------- - - PySide2 adopt PyQt5's new signal and slot syntax as-is. The PySide2 - implementation is functionally compatible with the PyQt5 one, with the - exceptions listed below. - - PyQt5's new signal and slot style utilizes method and decorator names - specific to their implementation. These will be generalized according to - the table below: - - ======= ======================= ============= - Module PyQt5 factory function PySide2 class - ======= ======================= ============= - QtCore pyqtSignal Signal - QtCore pyqtSlot Slot - ======= ======================= ============= - -Q_INVOKABLE ------------ - - There is no equivalent of the Q_INVOKABLE macro of Qt - since PySide2 slots can actually have return values. - If you need to create a invokable method that returns some value, - declare it as a slot, e.g.: - - :: - - class Foo(QObject): - - @Slot(float, result=int) - def getFloatReturnInt(self, f): - return int(f) diff --git a/sources/pyside2/doc/extras/QtCore.rst b/sources/pyside2/doc/extras/QtCore.rst deleted file mode 100644 index d3277a418..000000000 --- a/sources/pyside2/doc/extras/QtCore.rst +++ /dev/null @@ -1,5 +0,0 @@ -All other Qt modules rely on this module. To include the definitions of the module's classes, use the following directive: - -:: - - import PySide2.QtCore diff --git a/sources/pyside2/doc/extras/QtGui.rst b/sources/pyside2/doc/extras/QtGui.rst deleted file mode 100644 index e16329c38..000000000 --- a/sources/pyside2/doc/extras/QtGui.rst +++ /dev/null @@ -1,7 +0,0 @@ -To include the definitions of modules classes, use the following directive: - -:: - - import PySide2.QtGui - -.. seealso:: :mod:`PySide2.QtCore` diff --git a/sources/pyside2/doc/extras/QtHelp.rst b/sources/pyside2/doc/extras/QtHelp.rst deleted file mode 100644 index 239f4faa6..000000000 --- a/sources/pyside2/doc/extras/QtHelp.rst +++ /dev/null @@ -1,5 +0,0 @@ -To include the definitions of the module's classes, use the following directive: - -:: - - import PySide2.QtHelp diff --git a/sources/pyside2/doc/extras/QtMultimedia.rst b/sources/pyside2/doc/extras/QtMultimedia.rst deleted file mode 100644 index 5088db4d0..000000000 --- a/sources/pyside2/doc/extras/QtMultimedia.rst +++ /dev/null @@ -1,7 +0,0 @@ -To include the definitions of the module's classes, use the following directive: - -:: - - import PySide2.QtMultimedia - - diff --git a/sources/pyside2/doc/extras/QtNetwork.rst b/sources/pyside2/doc/extras/QtNetwork.rst deleted file mode 100644 index 07303b157..000000000 --- a/sources/pyside2/doc/extras/QtNetwork.rst +++ /dev/null @@ -1,5 +0,0 @@ -To include the definitions of the module's classes, use the following directive: - -:: - - import PySide2.QtNetwork diff --git a/sources/pyside2/doc/extras/QtOpenGL.rst b/sources/pyside2/doc/extras/QtOpenGL.rst deleted file mode 100644 index 38783d9fd..000000000 --- a/sources/pyside2/doc/extras/QtOpenGL.rst +++ /dev/null @@ -1,14 +0,0 @@ -OpenGL is a standard API for rendering 3D graphics. OpenGL only deals with 3D rendering and provides little or no support for GUI programming issues. The user interface for an OpenGL application must be created with another toolkit, such as Motif on the X platform, Microsoft Foundation Classes (MFC) under Windows, or Qt on both platforms. - -.. note:: OpenGL is a trademark of Silicon Graphics, Inc. in the United States and other countries. - -The Qt OpenGL module makes it easy to use OpenGL in Qt applications. It provides an OpenGL widget class that can be used just like any other Qt widget, except that it opens an OpenGL display buffer where you can use the OpenGL API to render the contents. -To include the definitions of the module's classes, use the following directive: - -:: - - import PySide2.QtOpenGL - -The Qt OpenGL module is implemented as a platform-independent wrapper around the platform-dependent GLX (version 1.3 or later), WGL, or AGL C APIs. Although the basic functionality provided is very similar to Mark Kilgard's GLUT library, applications using the Qt OpenGL module can take advantage of the whole Qt API for non-OpenGL-specific GUI functionality. - -The QtOpenGL module is available on Windows, X11 and Mac OS X. Qt for Embedded Linux and OpenGL supports OpenGL ES (OpenGL for Embedded Systems).
\ No newline at end of file diff --git a/sources/pyside2/doc/extras/QtQml.QmlElement.rst b/sources/pyside2/doc/extras/QtQml.QmlElement.rst deleted file mode 100644 index 90a5134c1..000000000 --- a/sources/pyside2/doc/extras/QtQml.QmlElement.rst +++ /dev/null @@ -1,28 +0,0 @@ -.. currentmodule:: PySide2.QtQml -.. _QmlElement: - -QmlElement -********** - -.. py:decorator:: QmlElement - - This decorator registers a class it is attached to for use in QML, using - global variables to specify the import name and version. - - :: - QML_IMPORT_NAME = "com.library.name" - QML_IMPORT_MAJOR_VERSION = 1 - QML_IMPORT_MINOR_VERSION = 0 # Optional - - @QmlElement - class ClassForQml(QObject): - # ... - - Afterwards the class may be used in QML: - - :: - import com.library.name 1.0 - - ClassForQml { - // ... - } diff --git a/sources/pyside2/doc/extras/QtQml.qmlRegisterSingletonType.rst b/sources/pyside2/doc/extras/QtQml.qmlRegisterSingletonType.rst deleted file mode 100644 index 2e0f80762..000000000 --- a/sources/pyside2/doc/extras/QtQml.qmlRegisterSingletonType.rst +++ /dev/null @@ -1,44 +0,0 @@ -.. currentmodule:: PySide2.QtQml -.. _qmlRegisterSingletonType: - -qmlRegisterSingletonType -************************ - -.. py:function:: qmlRegisterSingletonType(pytype: type, uri: str, versionMajor: int, versionMinor: int, typeName: str) -> int - - :param type pytype: Python class - :param str uri: uri to use while importing the component in QML - :param int versionMajor: major version - :param int versionMinor: minor version - :param str typeName: name exposed to QML - :return: int (the QML type id) - - This function registers a Python type as a singleton in the QML system. - -.. py:function:: qmlRegisterSingletonType(pytype: type, uri: str, versionMajor: int, versionMinor: int, typeName: str, callback: object) -> int - - :param type pytype: Python class - :param str uri: uri to use while importing the component in QML - :param int versionMajor: major version - :param int versionMinor: minor version - :param str typeName: name exposed to QML - :param object callback: Python callable (to handle Python type) - :return: int (the QML type id) - - This function registers a Python type as a singleton in the QML system using - the provided callback (which gets a QQmlEngine as a parameter) to generate - the singleton. - - -.. py:function:: qmlRegisterSingletonType(uri: str, versionMajor: int, versionMinor: int, typeName: str, callback: object) -> int - - :param str uri: uri to use while importing the component in QML - :param int versionMajor: major version - :param int versionMinor: minor version - :param str typeName: name exposed to QML - :param object callback: Python callable (to handle QJSValue) - :return: int (the QML type id) - - This function registers a QJSValue as a singleton in the QML system using - the provided callback (which gets a QQmlEngine as a parameter) to - generate the singleton. diff --git a/sources/pyside2/doc/extras/QtQml.qmlRegisterType.rst b/sources/pyside2/doc/extras/QtQml.qmlRegisterType.rst deleted file mode 100644 index d8bd3acb1..000000000 --- a/sources/pyside2/doc/extras/QtQml.qmlRegisterType.rst +++ /dev/null @@ -1,41 +0,0 @@ -.. currentmodule:: PySide2.QtQml -.. _qmlRegisterType: - -qmlRegisterType -*************** - -.. py:function:: qmlRegisterType(pytype: type, uri: str, versionMajor: int, versionMinor: int, qmlName: str) -> int - - :param type pytype: Python class - :param str uri: uri to use while importing the component in QML - :param int versionMajor: major version - :param int versionMinor: minor version - :param str qmlName: name exposed to QML - :return: int (the QML type id) - - This function registers the Python *type* in the QML system with the - name *qmlName*, in the library imported from *uri* having the - version number composed from *versionMajor* and *versionMinor*. - - For example, this registers a Python class 'MySliderItem' as a QML - type named 'Slider' for version '1.0' of a module called - 'com.mycompany.qmlcomponents': - - :: - - qmlRegisterType(MySliderItem, "com.mycompany.qmlcomponents", 1, 0, "Slider") - - Once this is registered, the type can be used in QML by importing - the specified module name and version number: - - :: - - import com.mycompany.qmlcomponents 1.0 - - Slider { ... } - - Note that it's perfectly reasonable for a library to register types - to older versions than the actual version of the library. - Indeed, it is normal for the new library to allow QML written to - previous versions to continue to work, even if more advanced - versions of some of its types are available. diff --git a/sources/pyside2/doc/extras/QtQml.qmlRegisterUncreatableType.rst b/sources/pyside2/doc/extras/QtQml.qmlRegisterUncreatableType.rst deleted file mode 100644 index 0e73f3d97..000000000 --- a/sources/pyside2/doc/extras/QtQml.qmlRegisterUncreatableType.rst +++ /dev/null @@ -1,36 +0,0 @@ -.. currentmodule:: PySide2.QtQml -.. _qmlRegisterUncreatableType: - - -qmlRegisterUncreatableType -************************** - - -.. py:function:: qmlRegisterUncreatableType(pytype: type, uri: str, versionMajor: int, versionMinor: int, qmlName: str, noCreationReason: str) -> int - - - :param type pytype: Python class - :param str uri: uri to use while importing the component in QML - :param int versionMajor: major version - :param int versionMinor: minor version - :param str qmlName: name exposed to QML - :param str noCreationReason: Error message shown when trying to create the QML type - :return: int (the QML type id) - - This function registers the Python *type* in the QML system as an uncreatable type with the - name *qmlName*, in the library imported from *uri* having the - version number composed from *versionMajor* and *versionMinor*, - showing *noCreationReason* as an error message when creating the type is attempted. - - For example, this registers a Python class 'MySliderItem' as a QML - type named 'Slider' for version '1.0' of a module called - 'com.mycompany.qmlcomponents': - - :: - qmlRegisterUncreatableType(MySliderItem, "com.mycompany.qmlcomponents", 1, 0, "Slider", "Slider cannot be created.") - - Note that it's perfectly reasonable for a library to register types - to older versions than the actual version of the library. - Indeed, it is normal for the new library to allow QML written to - previous versions to continue to work, even if more advanced - versions of some of its types are available. diff --git a/sources/pyside2/doc/extras/QtScript.rst b/sources/pyside2/doc/extras/QtScript.rst deleted file mode 100644 index 8ce7681ec..000000000 --- a/sources/pyside2/doc/extras/QtScript.rst +++ /dev/null @@ -1,21 +0,0 @@ -The QtScript module only provides core scripting facilities; the QtScriptTools module provides additional Qt Script-related components that application developers may find useful. - -To include the definitions of the module's classes, use the following directive: - -:: - - import PySide2.QtScript - -License Information -------------------- - -Qt Commercial Edition licensees that wish to distribute applications that use the QtScript module need to be aware of their obligations under the GNU Library General Public License (LGPL). - -Developers using the Open Source Edition can choose to redistribute the module under the appropriate version of the GNU LGPL. -QtScript is licensed under the GNU Library General Public License. Individual contributor names and copyright dates can be found inline in the code. - -This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. - -This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License for more details. - -You should have received a copy of the GNU Library General Public License along with this library; see the file COPYING.LIB. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. diff --git a/sources/pyside2/doc/extras/QtScriptTools.rst b/sources/pyside2/doc/extras/QtScriptTools.rst deleted file mode 100644 index a54ed914b..000000000 --- a/sources/pyside2/doc/extras/QtScriptTools.rst +++ /dev/null @@ -1,5 +0,0 @@ -Applications that use the Qt Script Tools classes need to be configured to be built against the QtScriptTools module. To include the definitions of the module's classes, use the following directive: - -:: - - import PySide2.QtScriptTools diff --git a/sources/pyside2/doc/extras/QtSql.rst b/sources/pyside2/doc/extras/QtSql.rst deleted file mode 100644 index fcdd6ba02..000000000 --- a/sources/pyside2/doc/extras/QtSql.rst +++ /dev/null @@ -1,5 +0,0 @@ -To include the definitions of the module's classes, use the following directive: - -:: - - import PySide2.QtSql diff --git a/sources/pyside2/doc/extras/QtSvg.rst b/sources/pyside2/doc/extras/QtSvg.rst deleted file mode 100644 index 7817e532f..000000000 --- a/sources/pyside2/doc/extras/QtSvg.rst +++ /dev/null @@ -1,5 +0,0 @@ -To include the definitions of the module's classes, use the following directive: - -:: - - import PySide2.QtSvg diff --git a/sources/pyside2/doc/extras/QtTest.rst b/sources/pyside2/doc/extras/QtTest.rst deleted file mode 100644 index 0b89a22d4..000000000 --- a/sources/pyside2/doc/extras/QtTest.rst +++ /dev/null @@ -1,7 +0,0 @@ -To include the definitions of the module's classes, use the following directive: - -:: - - import PySide2.QtTest - -.. note:: All macros in the C++ version of QtTest were not binded in PySide, this module is useful only for GUI testing and benchmarking, for ordinary unit testing you should use the ``unittest`` Python module. diff --git a/sources/pyside2/doc/extras/QtUiTools.loadUiType.rst b/sources/pyside2/doc/extras/QtUiTools.loadUiType.rst deleted file mode 100644 index 9ca330dea..000000000 --- a/sources/pyside2/doc/extras/QtUiTools.loadUiType.rst +++ /dev/null @@ -1,36 +0,0 @@ -.. currentmodule:: PySide2.QtUiTools -.. _loadUiType: - -loadUiType -*********** - -.. py:function:: loadUiType(uifile: str) -> tuple(object, object) - - :param str uifile: The name of the `.ui` file - :return: tuple(object, object) - - This function generates and loads a `.ui` file at runtime, and it returns - a `tuple` containing the reference to the Python class, and the base class. - - We recommend not to use this approach as the workflow should be to generate a Python file - from the `.ui` file, and then import and load it to use it, but we do understand that - there are some corner cases when such functionality is required. - - The internal process relies on `uic` being in the PATH. - The `pyside2-uic` wrapper uses a shipped `uic` that is located in the - `site-packages/PySide2/uic`, so PATH needs to be updated to use that if there - is no `uic` in the system. - - A simple use case is:: - - from PySide2.QtUiTools import loadUiType - - generated_class, base_class = loadUiType("themewidget.ui") - # the values will be: - # (<class '__main__.Ui_ThemeWidgetForm'>, <class 'PySide2.QtWidgets.QWidget'>) - - widget = base_class() - form = generated_class() - form.setupUi(widget) - # form.a_widget_member.a_method_of_member() - widget.show() diff --git a/sources/pyside2/doc/extras/QtUiTools.rst b/sources/pyside2/doc/extras/QtUiTools.rst deleted file mode 100644 index 598d69dda..000000000 --- a/sources/pyside2/doc/extras/QtUiTools.rst +++ /dev/null @@ -1,9 +0,0 @@ -These forms are processed at run-time to produce dynamically-generated user interfaces. In order to generate a form at run-time, a resource file containing a UI file is needed. - -A form loader object, provided by the QUiLoader class, is used to construct the user interface. This user interface can be retrieved from any QIODevice; for example, a QFile object can be used to obtain a form stored in a project's resources. The :meth:`PySide2.QtUiTools.QUiLoader.load` function takes the user interface description contained in the file and constructs the form widget. - -To include the definitions of the module's classes, use the following directive: - -:: - - import PySide.QtUiTools diff --git a/sources/pyside2/doc/extras/QtXml.rst b/sources/pyside2/doc/extras/QtXml.rst deleted file mode 100644 index 4b48ef21e..000000000 --- a/sources/pyside2/doc/extras/QtXml.rst +++ /dev/null @@ -1,5 +0,0 @@ -To include the definitions of the module's classes, use the following directive: - -:: - - import PySide2.QtXml diff --git a/sources/pyside2/doc/extras/QtXmlPatterns.rst b/sources/pyside2/doc/extras/QtXmlPatterns.rst deleted file mode 100644 index 99254ad62..000000000 --- a/sources/pyside2/doc/extras/QtXmlPatterns.rst +++ /dev/null @@ -1,12 +0,0 @@ -To include the definitions of the module's classes, use the following directive: - -:: - - import PySide2.QtXmlPatterns - -Further Reading ---------------- - -General overviews of XQuery and XSchema can be found in the XQuery document. - -An introduction to the XQuery language can be found in A Short Path to XQuery. |