diff options
author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2024-03-01 10:51:27 +0100 |
---|---|---|
committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2024-03-01 13:02:50 +0100 |
commit | 019a1932c559f0d73d2d8bcd4b3b26ba03dbccb8 (patch) | |
tree | 94a1bae717774cee430f9a5d7e6cc53a4cf44e97 /sources/pyside6/doc | |
parent | 3a28afe3229e331c410045729508477cb9f2d53e (diff) |
Documentation: List loadUiType() as a function instead a class
Move the loadUiType() documentation into a doc snippet.
Task-number: PYSIDE-1106
Change-Id: I3f878e054f2e6c3a0570f06a340d87661f27cd11
Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
Diffstat (limited to 'sources/pyside6/doc')
-rw-r--r-- | sources/pyside6/doc/extras/QtUiTools.loadUiType.rst | 35 |
1 files changed, 0 insertions, 35 deletions
diff --git a/sources/pyside6/doc/extras/QtUiTools.loadUiType.rst b/sources/pyside6/doc/extras/QtUiTools.loadUiType.rst deleted file mode 100644 index 48879d263..000000000 --- a/sources/pyside6/doc/extras/QtUiTools.loadUiType.rst +++ /dev/null @@ -1,35 +0,0 @@ -.. currentmodule:: PySide6.QtUiTools - -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 `pyside6-uic` wrapper uses a shipped `uic` that is located in the - `site-packages/PySide6/uic`, so PATH needs to be updated to use that if there - is no `uic` in the system. - - A simple use case is:: - - from PySide6.QtUiTools import loadUiType - - generated_class, base_class = loadUiType("themewidget.ui") - # the values will be: - # (<class '__main__.Ui_ThemeWidgetForm'>, <class 'PySide6.QtWidgets.QWidget'>) - - widget = base_class() - form = generated_class() - form.setupUi(widget) - # form.a_widget_member.a_method_of_member() - widget.show() |