aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc/modules.rst
blob: 193e59d372ea787935f63517b5e99830c7544594 (plain)
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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
Qt Modules Supported by Qt for Python
=====================================

.. toctree::
   :hidden:
   :glob:

   PySide6/Qt*/index

.. panels::
    :container: container-lg pb-3
    :column: col-lg-4 col-md-4 col-sm-6 col-xs-12 p-2

    :mod:`QtBluetooth <PySide6.QtBluetooth>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    The Bluetooth API provides connectivity between Bluetooth enabled devices.

    ---

    :mod:`QtCharts <PySide6.QtCharts>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Provides a set of easy to use chart components.

    ---

    :mod:`QtConcurrent <PySide6.QtConcurrent>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Provides high-level APIs that make it possible
    to write multi-threaded programs without using low-level threading
    primitives such as mutexes, read-write locks, wait conditions, or semaphores.

    ---

    :mod:`QtCore <PySide6.QtCore>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Provides core non-GUI functionality.

    ---

    :mod:`QtDataVisualization <PySide6.QtDataVisualization>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Provides a way to visualize data in 3D as bar, scatter, and surface graphs.

    ---

    :mod:`QtDBus <PySide6.QtDBus>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    D-Bus is an Inter-Process Communication (IPC) and Remote Procedure
    Calling (RPC) mechanism originally developed for Linux to replace
    existing and competing IPC solutions with one unified protocol

    ---

    :mod:`QtDesigner <PySide6.QtDesigner>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Provides classes to extend Qt Designer.

    ---

    :mod:`QtGui <PySide6.QtGui>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Extends QtCore with GUI functionality.

    ---

    :mod:`QtHelp <PySide6.QtHelp>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Provides classes for integrating online documentation in applications.

    ---

    :mod:`Qt Multimedia <PySide6.QtMultimedia>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Provides API for multimedia-specific use cases.

    ---

    :mod:`Qt Multimedia Widgets <PySide6.QtMultimediaWidgets>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Provides the widget-based multimedia API.

    ---

    :mod:`QtNetwork <PySide6.QtNetwork>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Offers classes that let you to write TCP/IP clients and servers.

    ---

    :mod:`Qt Network Authorization <PySide6.QtNetworkAuth>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Provides a set of APIs that enable Qt applications to obtain limited
    access to online accounts and HTTP services without exposing users'
    passwords.

    ---

    :mod:`QtNfc <PySide6.QtNfc>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    The NFC API provides connectivity between NFC enabled devices.

    ---

    :mod:`QtOpenGL <PySide6.QtOpenGL>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Offers classes that make it easy to use OpenGL in Qt applications.

    ---

    :mod:`QtOpenGL Widgets <PySide6.QtOpenGLWidgets>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Provides the  OpenGLWidget class enabling OpenGL rendering for a certain
    part of the widget tree.

    ---

    :mod:`Qt Positioning <PySide6.QtPositioning>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Provides access to position, satellite info and area monitoring classes.

    ---

    :mod:`QtPrintSupport <PySide6.QtPrintSupport>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Provides extensive cross-platform support for printing.

    ---

    :mod:`QtQml <PySide6.QtQml>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Python API for Qt QML.

    ---

    :mod:`QtQuick <PySide6.QtQuick>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Provides classes for embedding Qt Quick in Qt applications.

    ---

    :mod:`QtQuickControls2 <PySide6.QtQuickControls2>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Provides classes for setting up the controls from C++.

    ---

    :mod:`QtQuickWidgets <PySide6.QtQuickWidgets>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Provides the QQuickWidget class for embedding Qt Quick in widget-based applications.

    ---

    :mod:`QtRemoteObjects <PySide6.QtRemoteObjects>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Inter-Process Communication (IPC) module developed for Qt. This module
    extends Qt's existing functionalities to enable information exchange
    between processes or computers, easily.

    ---

    :mod:`Qt Scxml <PySide6.QtScxml>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Provides classes to create and use state machines from SCXML files.

    ---

    :mod:`Qt Sensors <PySide6.QtSensors>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Provides access to sensor hardware.

    ---

    :mod:`Qt Serial Port <PySide6.QtSerialPort>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Provides classes to interact with hardware and virtual serial ports.

    ---

    :mod:`Qt Scxml <PySide6.QtScxml>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Provides classes to create and use state machines from SCXML files.

    ---

    :mod:`QtSql <PySide6.QtSql>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Helps you provide seamless database integration to your Qt applications.

    ---

    :mod:`QtStateMachine <PySide6.QtStateMachine>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Provides classes for creating and executing state graphs.

    ---

    :mod:`QtSvg <PySide6.QtSvg>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Provides classes for displaying the contents of SVG files.

    ---

    :mod:`QtSvgWidgets <PySide6.QtSvgWidgets>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Provides a widget that is used to display the contents of SVG files.

    ---

    :mod:`QtTest <PySide6.QtTest>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Provides classes for unit testing Qt applications and libraries.

    ---

    :mod:`QtUiTools <PySide6.QtUiTools>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Provides classes to handle forms created with Qt Designer.

    ---

    :mod:`Qt WebChannel <PySide6.QtWebChannel>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Provides access to QObject or QML objects from HTML clients for seamless
    integration of Qt applications with HTML/JavaScript clients.

    ---

    :mod:`QtWebEngine Core C++ Classes <PySide6.QtWebEngineCore>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Provides public API shared by both QtWebEngine and QtWebEngineWidgets.

    ---

    :mod:`QtWebEngine Widgets C++ Classes <PySide6.QtWebEngineWidgets>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Provides C++ classes for rendering web content in a QWidget based application.

    ---

    :mod:`QtWebEngine QML Types <PySide6.QtWebEngineQuick>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Provides QML types for rendering web content within a QML application.

    ---

    :mod:`Qt WebSockets <PySide6.QtWebSockets>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Provides WebSocket communication compliant with RFC 6455.

    ---

    :mod:`QtWidgets <PySide6.QtWidgets>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Extends Qt GUI with C++ widget functionality.

    ---

    :mod:`QtXml <PySide6.QtXml>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Provides a C++ implementation of DOM.

    ---

    :mod:`Qt3DAnimation <PySide6.Qt3DAnimation>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Provides basic elements required to animate 3D objects.

    ---

    :mod:`Qt3D Core <PySide6.Qt3DCore>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Contains functionality to support near-realtime simulation systems.

    ---

    :mod:`Qt3D Extras <PySide6.Qt3DExtras>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Provides a set of prebuilt elements to help you get started with Qt 3D.

    ---

    :mod:`Qt3D Input <PySide6.Qt3DInput>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Provides classes for handling user input in applications using Qt 3D.

    ---

    :mod:`Qt3D Logic <PySide6.Qt3DLogic>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Enables synchronizing frames with the Qt 3D backend.

    ---

    :mod:`Qt3D Render <PySide6.Qt3DRender>`
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    Contains functionality to support 2D and 3D rendering using Qt 3D.