aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc/tutorials/index.rst
blob: a57aecf6eae97e96e3a7caeb166f98fffebac541 (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
.. _pyside6_tutorials:

Tutorials
=========

A collection of tutorials with walkthrough guides are
provided with |project| to help new users get started.

Some of these documents were ported from C++ to Python and cover a range of
topics, from basic use of widgets to step-by-step tutorials that show how an
application is put together.

Qt Widgets: Basic tutorials
---------------------------

If you want to see the available widgets in action, you can check the
`Qt Widget Gallery <https://doc.qt.io/qt-6/gallery.html>`_ to learn their
names and how they look like.

.. grid:: 1 3 3 3
    :gutter: 2

    .. grid-item-card:: Basic Widget
        :class-item: cover-img
        :link: tutorial_widgets
        :link-type: ref
        :img-top: basictutorial/widgets.png

        Your first QtWidgets Application

    .. grid-item-card:: Basic Button
        :class-item: cover-img
        :link: tutorial_clickablebutton
        :link-type: ref
        :img-top: basictutorial/clickablebutton.png

        Using a Simple Button

    .. grid-item-card:: Basic Connections
        :class-item: cover-img
        :link: tutorial_signals_and_slots
        :link-type: ref
        :img-top: basictutorial/signals_slots.png

        Signals and Slots

    .. grid-item-card:: Basic Dialog
        :class-item: cover-img
        :link: tutorial_dialog
        :link-type: ref
        :img-top: basictutorial/dialog.png

        Creating a Dialog Application

    .. grid-item-card:: Basic Table
        :class-item: cover-img
        :link: tutorial_tablewidget
        :link-type: ref
        :img-top: basictutorial/tablewidget.png

        Displaying Data Using a Table Widget

    .. grid-item-card:: Basic Tree
        :class-item: cover-img
        :link: tutorial_treewidget
        :link-type: ref
        :img-top: basictutorial/treewidget.png

        Displaying Data Using a Tree Widget

    .. grid-item-card:: Basic ``ui`` files
        :class-item: cover-img
        :link: tutorial_uifiles
        :link-type: ref
        :img-top: basictutorial/uifiles.png

        Using .ui files from Designer or QtCreator with QUiLoader and pyside6-uic

    .. grid-item-card:: Basic ``qrc`` files
        :class-item: cover-img
        :link: tutorial_qrcfiles
        :link-type: ref
        :img-top: basictutorial/player-new.png

        Using .qrc Files (pyside6-rcc)

    .. grid-item-card:: Basic Translations
        :class-item: cover-img
        :link: tutorial_translations
        :link-type: ref
        :img-top: basictutorial/translations.png

        Translating Applications

    .. grid-item-card:: Basic Widget Style
        :class-item: cover-img
        :link: tutorial_widgetstyling
        :link-type: ref
        :img-top: basictutorial/widgetstyling-yes.png

        Styling the Widgets Application

.. toctree::
    :hidden:

    basictutorial/widgets.rst
    basictutorial/clickablebutton.rst
    basictutorial/signals_and_slots.rst
    basictutorial/dialog.rst
    basictutorial/tablewidget.rst
    basictutorial/treewidget.rst
    basictutorial/uifiles.rst
    basictutorial/qrcfiles.rst
    basictutorial/translations.rst
    basictutorial/widgetstyling.rst


Quick/QML: Basic tutorials
--------------------------

.. grid:: 1 3 3 3
    :gutter: 2

    .. grid-item-card:: Basic Quick
        :class-item: cover-img
        :link: tutorial_qml
        :link-type: ref
        :img-top: basictutorial/greenapplication.png

        Your First QtQuick/QML Application

    .. grid-item-card:: Basic QML Integration
        :class-item: cover-img
        :link: tutorial_qmlintegration
        :link-type: ref
        :img-top: qmlintegration/textproperties_material.png

        Python-QML integration

    .. grid-item-card:: QML Application
        :class-item: cover-img
        :link: tutorial_qmlapplication
        :link-type: ref
        :img-top: qmlapp/qmlapplication.png

        QML Application Tutorial (QtCreator)

    .. grid-item-card:: Advanced QML Integration
        :class-item: cover-img
        :link: tutorial_qmlsqlintegration
        :link-type: ref
        :img-top: qmlsqlintegration/example_list_view.png

        QML, SQL and PySide Integration Tutorial

    .. grid-item-card:: Extended Explorer
        :class-item: cover-img
        :link: tutorial_extendedexplorer
        :link-type: ref
        :img-top: extendedexplorer/resources/extendedexplorer.webp

        Extending an Qt Quick Controls example

    .. grid-item-card:: Finance Manager Tutorial
        :class-item: cover-img
        :link: tutorial_financemanager
        :link-type: ref
        :img-top: finance_manager/part1/resources/finance_manager.webp

        Finance Manager Tutorial using QtQuick, SQLAlchemy, and FastAPI demonstrating how
        PySide6 can be used to interact with other popular packages in the Python ecosystem.

.. toctree::
    :maxdepth: 1
    :hidden:

    basictutorial/qml.rst
    qmlintegration/qmlintegration.rst
    qmlapp/qmlapplication.rst
    qmlsqlintegration/qmlsqlintegration.rst
    extendedexplorer/extendedexplorer.md
    finance_manager/index.md

General Applications
--------------------

.. grid:: 1 3 3 3
    :gutter: 2

    .. grid-item-card:: Data Visualization
        :class-item: cover-img
        :link: datavisualize_index
        :link-type: ref
        :img-top: datavisualize/images/datavisualization_app.png

        Data Visualization Tool

    .. grid-item-card:: Expenses Application
        :class-item: cover-img
        :link: tutorial_expenses
        :link-type: ref
        :img-top: expenses/expenses_tool.png

        Expenses administration tool

    .. grid-item-card:: Deploying PySide6 Applications to Boot to Qt
        :class-item: cover-img
        :link: tutorial_boottoqt_raspberrypi
        :link-type: ref
        :img-top: embedded/boot2qt_launcher.png

        Deploying PySide6 Applications to Boot to Qt OS on Raspberry Pi

.. toctree::
    :hidden:

    datavisualize/index.rst
    expenses/expenses.rst
    embedded/boot2qt.md

Qt Design Studio
----------------

.. grid:: 1 3 3 3
    :gutter: 2

    .. grid-item-card:: Qt Design Studio integration tutorial
        :class-item: cover-img
        :link: tutorial_qt_design_studio_integration
        :link-type: ref
        :img-top: drumpad/resources/drumpad.png

        Export a Qt Design Studio project to create a PySide6 application

.. toctree::
    :hidden:

    drumpad/index.rst

Qt Overviews
------------

.. toctree::
    :maxdepth: 1

    ../overviews/qtdoc-overviews-main.rst

C++ and Python
--------------

.. toctree::
    :maxdepth: 1

    portingguide/index.rst

Debug a PySide6 Application
---------------------------
.. toctree::
    :maxdepth: 1

    debugging/mixed_debugging.rst
    debugging/qml_debugging.rst