1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
//! [python project wizards]
\section2 Creating Widget-Based Qt for Python Applications
The Qt for Python Application wizards generate a \c {.pyproject} file that
lists the files in the \l{Developing Qt for Python Applications}{Python}
project and a \c {.py} file that has some boilerplate code. In addition, the
widget-based UI wizard creates a \c {.ui} file that has a \QD form, and the
Qt Quick Application wizard creates a \c {.qml} file that imports Qt Quick
controls.
The \c{.pyproject} files are JSON-based configuration files that replace
the previously used \c {.pyqtc} configuration files. You can still open and
use \c {.pyqtc} files, but we recommend that you choose \c{.pyproject} files
for new projects.
The \uicontrol {Window UI} wizard enables you to
create a Python project that has the source file for a class. Specify
the PySide version, class name, base class, and source file for the
class.
\image qtcreator-python-wizard-app-window.png {Define Class wizard page}
The wizard adds the imports to the source file for
access to the QApplication, the base class you selected in the Qt
Widgets module, and Qt UI tools:
\badcode
import sys
from PySide6.QtWidgets import QApplication, QWidget
\endcode
\note It is important that you first create the Python code
from your UI form. In PySide6, you can do this by executing
\c{pyside6-uic form.ui -o ui_form.py} on a terminal. This
enables you to import the class that represents your UI
from that Python file.
Once you generate the Python code from the UI file,
you can import the class:
\badcode
from ui_form import Ui_Widget
\endcode
The wizard also adds a main class with the specified name that
inherits from the specified base class:
\badcode
class Widget(QWidget):
def __init__(self, parent=None):
super().__init__(parent)
\endcode
The following lines in the main class instantiate the generated Python class from
your UI file, and set up the interface for the current class.
\badcode
self.ui = Ui_Widget()
self.ui.setupUi(self)
\endcode
\note You can access the UI elements of the new class as member variables.
For example, if you have a button called \e{button1}, you
can interact with it using \c{self.ui.button1}.
Next, the wizard adds a main function, where it creates a
QApplication instance. As Qt can receive arguments from the command line,
you can pass any arguments to the QApplication object. Usually, you do not
need to pass any arguments, and you can use the following approach:
\badcode
if __name__ == "__main__":
app = QApplication(sys.argv)
\endcode
Next, the wizard instantiates the \c MainWindow class and shows it:
\badcode
widget = Widget()
widget.show()
...
\endcode
Finally, the wizard calls the \c app.exec() method to enter the Qt
main loop and start executing the Qt code:
\badcode
sys.exit(app.exec())
\endcode
You can now modify the boilerplate code in the Edit mode to develop your
Python application. Always regenerate the Python code after modifying a
UI file.
Open the .ui file in the \uicontrol Design mode to create a widget-based UI
in \QD.
The \uicontrol Window wizard adds similar code to the source file, without
the UI bits.
The \uicontrol Empty wizard adds similar code to the source file, but it
does not add any classes, so you need to add and instantiate them yourself.
For more information about the
\uicontrol {Qt for Python - Qt Quick Application - Empty} wizard, see
\l {Qt Quick Based Python Applications}.
For examples of creating Qt for Python applications, see
\l {https://doc.qt.io/qtforpython/tutorials/index.html}
{Qt for Python Examples and Tutorials}.
//! [python project wizards]
//! [python qml project wizards]
\section1 Qt Quick Based Python Applications
The \uicontrol {Qt for Python - Qt Quick Application - Empty} wizard enables
you to create a Python project that has a main QML file. Specify the
minimum PySide version to run the application.
\image qtcreator-python-wizard-qml.png {Qt for Python wizard for creating an empty Qt Quick application}
The wizard adds the following imports to the source file for access
to QGuiApplication and QQmlApplicationEngine:
\badcode
import sys
from pathlib import Path
from PySide6.QtGui import QGuiApplication
from PySide6.QtQml import QQmlApplicationEngine
\endcode
The wizard also adds a main function, where it creates a QGuiApplication
instance and passes system arguments to the QGuiApplication object:
\badcode
if __name__ == "__main__":
app = QGuiApplication(sys.argv)
...
\endcode
The following lines in the main class create a QQmlApplicationEngine
instance and load the generated QML file to the engine object:
\badcode
engine = QQmlApplicationEngine()
qml_file = Path(__file__).resolve().parent / "main.qml"
engine.load(qml_file)
\endcode
Finally, the wizard adds code that checks whether the file was successfully
loaded. If loading the file fails, the application exits with an error code.
If loading succeeds, the wizard calls the \c app.exec() method to enter the
Qt main loop and start executing the Qt code:
\badcode
if not engine.rootObjects():
sys.exit(-1)
sys.exit(app.exec())
\endcode
Open the .qml file in the \uicontrol Edit mode to design a Qt Quick UI, or
use \l{Qt Design Studio Manual}{\QDS}.
//! [python qml project wizards]
*/
|
