diff options
author | Shyamnath Premnadh <[email protected]> | 2024-12-11 13:02:23 +0100 |
---|---|---|
committer | Shyamnath Premnadh <[email protected]> | 2024-12-12 13:47:55 +0100 |
commit | f6069b9330fc01b68296ef4dffd474ed98784ec6 (patch) | |
tree | d3f504d8070430e9f7dfe68e614cc11729420950 | |
parent | 31a9db93d3c355d8e6be4d31eacc02b93d41ffd3 (diff) |
Documentation/Examples: Add missing docs
Some examples did not have any documentation. This patch adds
the respective documentation.
Pick-to: 6.8
Change-Id: I9698752b654c2df29fd3572f6bc66a9df56f9903
Reviewed-by: Friedemann Kleint <[email protected]>
56 files changed, 321 insertions, 0 deletions
diff --git a/examples/corelib/ipc/sharedmemory/doc/sharedmemory.png b/examples/corelib/ipc/sharedmemory/doc/sharedmemory.png Binary files differnew file mode 100644 index 000000000..53244d3f5 --- /dev/null +++ b/examples/corelib/ipc/sharedmemory/doc/sharedmemory.png diff --git a/examples/corelib/ipc/sharedmemory/doc/sharedmemory.rst b/examples/corelib/ipc/sharedmemory/doc/sharedmemory.rst new file mode 100644 index 000000000..01f8a320e --- /dev/null +++ b/examples/corelib/ipc/sharedmemory/doc/sharedmemory.rst @@ -0,0 +1,11 @@ +IPC: Shared Memory +================== + +Demonstrates how to share image data between different processes using the +Shared Memory IPC mechanism. It corresponds to the Qt example +`Shared Memory Example <https://doc.qt.io/qt-6/qtcore-ipc-sharedmemory-example.html>`_. + +.. image:: sharedmemory.png + :align: center + :alt: sharedmemory screenshot + :width: 400 diff --git a/examples/dbus/listnames/doc/listnames.rst b/examples/dbus/listnames/doc/listnames.rst new file mode 100644 index 000000000..3cae6b953 --- /dev/null +++ b/examples/dbus/listnames/doc/listnames.rst @@ -0,0 +1,7 @@ +D-Bus List Names Example +======================== + +Shows how to access the D-Bus bus daemon service. + +List Names is a command-line example which shows how to access the Qt D-Bus bus +daemon service. The example prints various information about the bus daemon service diff --git a/examples/dbus/pingpong/doc/pingpong.rst b/examples/dbus/pingpong/doc/pingpong.rst new file mode 100644 index 000000000..1531920ea --- /dev/null +++ b/examples/dbus/pingpong/doc/pingpong.rst @@ -0,0 +1,8 @@ +D-Bus Ping Pong Example +======================= + +Demonstrates a simple message system using D-Bus. + +Ping Pong is a command-line example that demonstrates the basics of Qt D-Bus. +A message is sent to another application and there is a confirmation of the +message. diff --git a/examples/network/blockingfortuneclient/doc/blockingfortuneclient.png b/examples/network/blockingfortuneclient/doc/blockingfortuneclient.png Binary files differnew file mode 100644 index 000000000..ab918e791 --- /dev/null +++ b/examples/network/blockingfortuneclient/doc/blockingfortuneclient.png diff --git a/examples/network/blockingfortuneclient/doc/blockingfortuneclient.rst b/examples/network/blockingfortuneclient/doc/blockingfortuneclient.rst new file mode 100644 index 000000000..661153dbe --- /dev/null +++ b/examples/network/blockingfortuneclient/doc/blockingfortuneclient.rst @@ -0,0 +1,11 @@ +Blocking Fortune Client Example +=============================== + +Demonstrates how to create a client for a network service. It corresponds to the +Qt example `Blocking Fortune Client Example +<https://doc.qt.io/qt-6/qtnetwork-blockingfortuneclient-example.html>`_. + +.. image:: blockingfortuneclient.png + :align: center + :alt: blockingfortuneclient screenshot + :width: 400 diff --git a/examples/network/fortuneclient/doc/fortuneclient.png b/examples/network/fortuneclient/doc/fortuneclient.png Binary files differnew file mode 100644 index 000000000..cae0b066d --- /dev/null +++ b/examples/network/fortuneclient/doc/fortuneclient.png diff --git a/examples/network/fortuneclient/doc/fortuneclient.rst b/examples/network/fortuneclient/doc/fortuneclient.rst new file mode 100644 index 000000000..e9719c877 --- /dev/null +++ b/examples/network/fortuneclient/doc/fortuneclient.rst @@ -0,0 +1,11 @@ +Fortune Client Example +====================== + +Demonstrates how to create a client for a network service. It corresponds to the +Qt example `Fortune Client Example +<https://doc.qt.io/qt-6/qtnetwork-fortuneclient-example.html>`_. + +.. image:: fortuneclient.png + :align: center + :alt: fortuneclient screenshot + :width: 400 diff --git a/examples/network/fortuneserver/doc/fortuneserver.png b/examples/network/fortuneserver/doc/fortuneserver.png Binary files differnew file mode 100644 index 000000000..55ea8b1c2 --- /dev/null +++ b/examples/network/fortuneserver/doc/fortuneserver.png diff --git a/examples/network/fortuneserver/doc/fortuneserver.rst b/examples/network/fortuneserver/doc/fortuneserver.rst new file mode 100644 index 000000000..fd21340ca --- /dev/null +++ b/examples/network/fortuneserver/doc/fortuneserver.rst @@ -0,0 +1,11 @@ +Fortune Server Example +====================== + +Demonstrates how to create a server for a network service. It corresponds to the +Qt example `Fortune Server Example +<https://doc.qt.io/qt-6/qtnetwork-fortuneserver-example.html>`_. + +.. image:: fortuneserver.png + :align: center + :alt: fortuneserver screenshot + :width: 400 diff --git a/examples/network/threadedfortuneserver/doc/threadedfortuneserver.png b/examples/network/threadedfortuneserver/doc/threadedfortuneserver.png Binary files differnew file mode 100644 index 000000000..72315e0b7 --- /dev/null +++ b/examples/network/threadedfortuneserver/doc/threadedfortuneserver.png diff --git a/examples/network/threadedfortuneserver/doc/threadedfortuneserver.rst b/examples/network/threadedfortuneserver/doc/threadedfortuneserver.rst new file mode 100644 index 000000000..3f6606653 --- /dev/null +++ b/examples/network/threadedfortuneserver/doc/threadedfortuneserver.rst @@ -0,0 +1,12 @@ +Threaded Fortune Server Example +=============================== + +The Threaded Fortune Server example shows how to create a server for a simple +network service that uses threads to handle requests from different clients. +It corresponds to the Qt example `Threaded Fortune Server Example +<https://doc.qt.io/qt-6/qtnetwork-threadedfortuneserver-example.html>`_. + +.. image:: threadedfortuneserver.png + :align: center + :alt: threadedfortuneserver screenshot + :width: 400 diff --git a/examples/remoteobjects/modelview/doc/modelview.rst b/examples/remoteobjects/modelview/doc/modelview.rst new file mode 100644 index 000000000..8fc6780e4 --- /dev/null +++ b/examples/remoteobjects/modelview/doc/modelview.rst @@ -0,0 +1,12 @@ +Model-View Server Example +========================= + +Developing a simple server program that displays and makes changes to a +QTreeView which is made available on a Remote Objects network. It +corresponds to the Qt example `Model-View Server Example +<https://doc.qt.io/qt-6/qtremoteobjects-modelviewserver-example.html>`_. + +.. image:: modelview.png + :align: center + :alt: modelview screenshot + :width: 400 diff --git a/examples/statemachine/ping_pong/doc/ping_pong.rst b/examples/statemachine/ping_pong/doc/ping_pong.rst new file mode 100644 index 000000000..43a3178fb --- /dev/null +++ b/examples/statemachine/ping_pong/doc/ping_pong.rst @@ -0,0 +1,12 @@ +StateMachine Ping Pong Example +============================== + +The Ping Pong States example shows how to use parallel states together +with custom events and transitions in The State Machine Framework. +It corresponds to the Qt example `Ping Pong States Example +<https://doc.qt.io/qt-5/qtwidgets-statemachine-pingpong-example.html>`_. + +.. image:: ping_pong.png + :align: center + :alt: ping_pong screenshot + :width: 400 diff --git a/examples/statemachine/ping_pong/doc/pingpong.png b/examples/statemachine/ping_pong/doc/pingpong.png Binary files differnew file mode 100644 index 000000000..af707e463 --- /dev/null +++ b/examples/statemachine/ping_pong/doc/pingpong.png diff --git a/examples/statemachine/rogue/doc/rogue.png b/examples/statemachine/rogue/doc/rogue.png Binary files differnew file mode 100644 index 000000000..7aeb0e54f --- /dev/null +++ b/examples/statemachine/rogue/doc/rogue.png diff --git a/examples/statemachine/rogue/doc/rogue.rst b/examples/statemachine/rogue/doc/rogue.rst new file mode 100644 index 000000000..e8d203128 --- /dev/null +++ b/examples/statemachine/rogue/doc/rogue.rst @@ -0,0 +1,11 @@ +StateMachine Rogue Example +========================== + +The Rogue example shows how to use the Qt state machine for event handling +It corresponds to the Qt example `Rogue Example +<https://doc.qt.io/qt-5/qtwidgets-statemachine-rogue-example.html>`_. + +.. image:: rogue.png + :align: center + :alt: rogue screenshot + :width: 400 diff --git a/examples/uitools/uiloader/doc/uiloader.rst b/examples/uitools/uiloader/doc/uiloader.rst new file mode 100644 index 000000000..df02c9b9b --- /dev/null +++ b/examples/uitools/uiloader/doc/uiloader.rst @@ -0,0 +1,7 @@ +UILoader Example +================ + +This example demonstrates how to dynamically load and display a user interface +designed with Qt Designer using PySide6's `QUiLoader`. It shows how to load a +`.ui` file at runtime, allowing for flexible and dynamic UI design and +modification without recompiling the application. diff --git a/examples/webenginewidgets/markdowneditor/doc/markdowneditor.png b/examples/webenginewidgets/markdowneditor/doc/markdowneditor.png Binary files differnew file mode 100644 index 000000000..9f456c4db --- /dev/null +++ b/examples/webenginewidgets/markdowneditor/doc/markdowneditor.png diff --git a/examples/webenginewidgets/markdowneditor/doc/markdowneditor.rst b/examples/webenginewidgets/markdowneditor/doc/markdowneditor.rst new file mode 100644 index 000000000..d54aafafc --- /dev/null +++ b/examples/webenginewidgets/markdowneditor/doc/markdowneditor.rst @@ -0,0 +1,11 @@ +WebEngine Markdown Editor Example +================================= + +Demonstrates how to integrate a web engine in a hybrid desktop application. +It corresponds to the Qt example `WebEngine Markdown Editor Example +<https://doc.qt.io/qt-5/qtwebengine-webenginewidgets-markdowneditor-example.html>`_. + +.. image:: markdowneditor.png + :align: center + :alt: markdowneditor screenshot + :width: 400 diff --git a/examples/widgets/desktop/systray/doc/systray.png b/examples/widgets/desktop/systray/doc/systray.png Binary files differnew file mode 100644 index 000000000..5537c09fd --- /dev/null +++ b/examples/widgets/desktop/systray/doc/systray.png diff --git a/examples/widgets/desktop/systray/doc/systray.rst b/examples/widgets/desktop/systray/doc/systray.rst new file mode 100644 index 000000000..364e7c9df --- /dev/null +++ b/examples/widgets/desktop/systray/doc/systray.rst @@ -0,0 +1,10 @@ +System Tray Icon Example +======================== + +The System Tray Icon example shows how to add an icon with a menu and popup +messages to a desktop environment's system tray. It demonstrates the analogous +Qt example `System Tray Icon Example +<https://doc.qt.io/qt-6/qtwidgets-desktop-systray-example.html>`_. + +.. image:: systray.png + :align: center diff --git a/examples/widgets/dialogs/extension/doc/extension.png b/examples/widgets/dialogs/extension/doc/extension.png Binary files differnew file mode 100644 index 000000000..407af27ca --- /dev/null +++ b/examples/widgets/dialogs/extension/doc/extension.png diff --git a/examples/widgets/dialogs/extension/doc/extension.rst b/examples/widgets/dialogs/extension/doc/extension.rst new file mode 100644 index 000000000..d64db2335 --- /dev/null +++ b/examples/widgets/dialogs/extension/doc/extension.rst @@ -0,0 +1,11 @@ +Extension Example +================= + +This example demonstrates a PySide6 application that creates a find dialog with +an extendable interface, showcasing how to add and manage additional options +dynamically within a dialog. It demonstrates the analogous Qt example +`Extension Example <https://doc.qt.io/qt-6.2/qtwidgets-dialogs-extension-example.html>`_. + +.. image:: extension.png + :width: 400 + :alt: extension screenshot diff --git a/examples/widgets/dialogs/standarddialogs/doc/standarddialogs.png b/examples/widgets/dialogs/standarddialogs/doc/standarddialogs.png Binary files differnew file mode 100644 index 000000000..6598710f7 --- /dev/null +++ b/examples/widgets/dialogs/standarddialogs/doc/standarddialogs.png diff --git a/examples/widgets/dialogs/standarddialogs/doc/standarddialogs.rst b/examples/widgets/dialogs/standarddialogs/doc/standarddialogs.rst new file mode 100644 index 000000000..83bc6ca4d --- /dev/null +++ b/examples/widgets/dialogs/standarddialogs/doc/standarddialogs.rst @@ -0,0 +1,8 @@ +Standard Dialogs Example +======================== + +The Standard Dialogs example shows the standard dialogs that are provided by +Qt. + +.. image:: standarddialogs.png + :align: center diff --git a/examples/widgets/dialogs/trivialwizard/doc/trivialwizard.png b/examples/widgets/dialogs/trivialwizard/doc/trivialwizard.png Binary files differnew file mode 100644 index 000000000..02291df79 --- /dev/null +++ b/examples/widgets/dialogs/trivialwizard/doc/trivialwizard.png diff --git a/examples/widgets/dialogs/trivialwizard/doc/trivialwizard.rst b/examples/widgets/dialogs/trivialwizard/doc/trivialwizard.rst new file mode 100644 index 000000000..24b97b0b4 --- /dev/null +++ b/examples/widgets/dialogs/trivialwizard/doc/trivialwizard.rst @@ -0,0 +1,11 @@ +Trivial Wizard Example +====================== + +The Trivial Wizard example illustrates how to create a linear three-page +registration wizard using three instances of `QWizardPage` and one instance of +`QWizard`. This example demonstrates the analogous Qt example `Trivial Wizard +Example <https://doc.qt.io/qt-6/qtwidgets-dialogs-trivialwizard-example.html>`_. + +.. image:: trivialwizard.png + :width: 400 + :alt: trivialwizard screenshot diff --git a/examples/widgets/draganddrop/draggabletext/doc/draggabletext.png b/examples/widgets/draganddrop/draggabletext/doc/draggabletext.png Binary files differnew file mode 100644 index 000000000..8fe5ae4b1 --- /dev/null +++ b/examples/widgets/draganddrop/draggabletext/doc/draggabletext.png diff --git a/examples/widgets/draganddrop/draggabletext/doc/draggabletext.rst b/examples/widgets/draganddrop/draggabletext/doc/draggabletext.rst new file mode 100644 index 000000000..2da12e51c --- /dev/null +++ b/examples/widgets/draganddrop/draggabletext/doc/draggabletext.rst @@ -0,0 +1,8 @@ +Draggable Text Example +====================== + +Illustrates how to drag and drop text between widgets. + +.. image:: draggabletext.png + :width: 400 + :alt: draggabletext screenshot diff --git a/examples/widgets/effects/lighting/doc/lighting.rst b/examples/widgets/effects/lighting/doc/lighting.rst new file mode 100644 index 000000000..95adb468c --- /dev/null +++ b/examples/widgets/effects/lighting/doc/lighting.rst @@ -0,0 +1,11 @@ +Lighting Example +================ + +This example demonstrates a PySide6 application that creates a dynamic scene with lighting and +shadow effects using `QGraphicsView` and `QGraphicsScene`. It features animated light sources and +graphical items with drop shadows that respond to the light, showcasing advanced rendering and +animation techniques. + +.. image:: lighting.webp + :width: 400 + :alt: lighting screenshot diff --git a/examples/widgets/effects/lighting/doc/lighting.webp b/examples/widgets/effects/lighting/doc/lighting.webp Binary files differnew file mode 100644 index 000000000..fbae74d3b --- /dev/null +++ b/examples/widgets/effects/lighting/doc/lighting.webp diff --git a/examples/widgets/graphicsview/anchorlayout/doc/anchorlayout.rst b/examples/widgets/graphicsview/anchorlayout/doc/anchorlayout.rst new file mode 100644 index 000000000..8eef329c9 --- /dev/null +++ b/examples/widgets/graphicsview/anchorlayout/doc/anchorlayout.rst @@ -0,0 +1,12 @@ +Anchor Layout Example +===================== + +This application demonstrates the use of `QGraphicsAnchorLayout` in a PySide6 Widget application. +It creates a graphical scene with several `QPushButton` widgets arranged using anchor constraints, +allowing for dynamic and flexible layout management within a `QGraphicsView`. It demonstrates +the analogous Qt example +`Anchor Layout Example <https://doc.qt.io/qt-6.2/qtwidgets-graphicsview-anchorlayout-example.html>`_ + +.. image:: anchorlayout.webp + :width: 400 + :alt: anchorlayout screenshot diff --git a/examples/widgets/graphicsview/anchorlayout/doc/anchorlayout.webp b/examples/widgets/graphicsview/anchorlayout/doc/anchorlayout.webp Binary files differnew file mode 100644 index 000000000..cfc89c667 --- /dev/null +++ b/examples/widgets/graphicsview/anchorlayout/doc/anchorlayout.webp diff --git a/examples/widgets/graphicsview/collidingmice/doc/collidingmice.rst b/examples/widgets/graphicsview/collidingmice/doc/collidingmice.rst new file mode 100644 index 000000000..449015926 --- /dev/null +++ b/examples/widgets/graphicsview/collidingmice/doc/collidingmice.rst @@ -0,0 +1,15 @@ +Colliding Mice Example +====================== + +This application, is a graphical simulation built using PySide6. It creates a +scene with multiple animated mouse objects that move around and interact with +each other within a `QGraphicsView`. The mice change direction to avoid +collisions and exhibit random movements, demonstrating the use of +`QGraphicsItem`, `QGraphicsScene`, and `QGraphicsView` for creating dynamic and +interactive graphics in a PySide6 application. This example demonstrates the +analogous Qt example `Colliding Mice Example +<https://doc.qt.io/qt-6/qtwidgets-graphicsview-collidingmice-example.html>`_. + +.. image:: collidingmice.webp + :width: 400 + :alt: collidingmice screenshot diff --git a/examples/widgets/graphicsview/collidingmice/doc/collidingmice.webp b/examples/widgets/graphicsview/collidingmice/doc/collidingmice.webp Binary files differnew file mode 100644 index 000000000..aafd2b15f --- /dev/null +++ b/examples/widgets/graphicsview/collidingmice/doc/collidingmice.webp diff --git a/examples/widgets/graphicsview/diagramscene/doc/diagramscene.rst b/examples/widgets/graphicsview/diagramscene/doc/diagramscene.rst new file mode 100644 index 000000000..828e14a39 --- /dev/null +++ b/examples/widgets/graphicsview/diagramscene/doc/diagramscene.rst @@ -0,0 +1,11 @@ +Diagram Scene Example +===================== + +This example demonstrates how to create an interactive diagram editor using +PySide6, featuring various diagram shapes, connectors, and customizable +properties. It demonstrates the analogous Qt example `Diagram Scene Example +<https://doc.qt.io/qt-6/qtwidgets-graphicsview-diagramscene-example.html>`_. + +.. image:: diagramscene.webp + :width: 400 + :alt: diagramscene screenshot diff --git a/examples/widgets/graphicsview/diagramscene/doc/diagramscene.webp b/examples/widgets/graphicsview/diagramscene/doc/diagramscene.webp Binary files differnew file mode 100644 index 000000000..e94a8393c --- /dev/null +++ b/examples/widgets/graphicsview/diagramscene/doc/diagramscene.webp diff --git a/examples/widgets/graphicsview/dragdroprobot/doc/dragdroprobot.png b/examples/widgets/graphicsview/dragdroprobot/doc/dragdroprobot.png Binary files differnew file mode 100644 index 000000000..b8eff6ff8 --- /dev/null +++ b/examples/widgets/graphicsview/dragdroprobot/doc/dragdroprobot.png diff --git a/examples/widgets/graphicsview/dragdroprobot/doc/dragdroprobot.rst b/examples/widgets/graphicsview/dragdroprobot/doc/dragdroprobot.rst new file mode 100644 index 000000000..f2e6b7e71 --- /dev/null +++ b/examples/widgets/graphicsview/dragdroprobot/doc/dragdroprobot.rst @@ -0,0 +1,12 @@ +Drag and Drop Robot Example +=========================== + +This example demonstrates a PySide6 application where users can drag and drop +color items onto a robot graphic, showcasing interactive drag-and-drop +functionality within a `QGraphicsView`. It demonstrates the analogous Qt example +`Drag and Drop Robot Example +<https://doc.qt.io/qt-6/qtwidgets-graphicsview-dragdroprobot-example.html>`_. + +.. image:: dragdroprobot.png + :width: 400 + :alt: dragdroprobot screenshot diff --git a/examples/widgets/graphicsview/elasticnodes/doc/elasticnodes.png b/examples/widgets/graphicsview/elasticnodes/doc/elasticnodes.png Binary files differnew file mode 100644 index 000000000..840f74fe1 --- /dev/null +++ b/examples/widgets/graphicsview/elasticnodes/doc/elasticnodes.png diff --git a/examples/widgets/graphicsview/elasticnodes/doc/elasticnodes.rst b/examples/widgets/graphicsview/elasticnodes/doc/elasticnodes.rst new file mode 100644 index 000000000..91afe0bac --- /dev/null +++ b/examples/widgets/graphicsview/elasticnodes/doc/elasticnodes.rst @@ -0,0 +1,15 @@ +Elastic Nodes Example +===================== + +This example demonstrates a PySide6 application that creates a dynamic and +interactive graphical scene with nodes connected by elastic edges. The nodes +and edges respond to user interactions and physics-based movements, showcasing +the use of `QGraphicsItem`, `QGraphicsScene`, and `QGraphicsView` for creating +complex animations and interactions. + +It demonstrates the analogous Qt example `Elastic Nodes Example +<https://doc.qt.io/qt-6/qtwidgets-graphicsview-elasticnodes-example.html>`_. + +.. image:: elasticnodes.png + :width: 400 + :alt: elasticnodes screenshot diff --git a/examples/widgets/imageviewer/doc/imageviewer.rst b/examples/widgets/imageviewer/doc/imageviewer.rst new file mode 100644 index 000000000..5a3001734 --- /dev/null +++ b/examples/widgets/imageviewer/doc/imageviewer.rst @@ -0,0 +1,12 @@ +Image Viewer Example +==================== + +This example demonstrates an image viewer application built using PySide6, +featuring functionalities such as opening, saving, printing, copying, pasting, +and zooming images within a scrollable area. This example demonstrates the +analogous Qt example `Image Viewer Example +<https://doc.qt.io/qt-6.2/qtwidgets-widgets-imageviewer-example.html>`_. + +.. image:: imageviewer.webp + :width: 400 + :alt: imageviewer screenshot diff --git a/examples/widgets/imageviewer/doc/imageviewer.webp b/examples/widgets/imageviewer/doc/imageviewer.webp Binary files differnew file mode 100644 index 000000000..ecc2f6acc --- /dev/null +++ b/examples/widgets/imageviewer/doc/imageviewer.webp diff --git a/examples/widgets/itemviews/basicfiltermodel/doc/basicfiltermodel.rst b/examples/widgets/itemviews/basicfiltermodel/doc/basicfiltermodel.rst new file mode 100644 index 000000000..a8aa5f33e --- /dev/null +++ b/examples/widgets/itemviews/basicfiltermodel/doc/basicfiltermodel.rst @@ -0,0 +1,11 @@ +Basic Sort/Filter Model Example +=============================== + +The Basic Sort/Filter Model example illustrates how to use `QSortFilterProxyModel` +to perform basic sorting and filtering. This example demonstrates the analogous +Qt example `Basic Sort/Filter Model Example +<https://doc.qt.io/qt-6/qtwidgets-itemviews-basicsortfiltermodel-example.html>`_. + +.. image:: basicfiltermodel.webp + :width: 400 + :alt: basicsortfiltermodel screenshot diff --git a/examples/widgets/itemviews/basicfiltermodel/doc/basicfiltermodel.webp b/examples/widgets/itemviews/basicfiltermodel/doc/basicfiltermodel.webp Binary files differnew file mode 100644 index 000000000..6d290cba3 --- /dev/null +++ b/examples/widgets/itemviews/basicfiltermodel/doc/basicfiltermodel.webp diff --git a/examples/widgets/itemviews/fetchmore/doc/fetchmore.png b/examples/widgets/itemviews/fetchmore/doc/fetchmore.png Binary files differnew file mode 100644 index 000000000..e3b47b8a8 --- /dev/null +++ b/examples/widgets/itemviews/fetchmore/doc/fetchmore.png diff --git a/examples/widgets/itemviews/fetchmore/doc/fetchmore.rst b/examples/widgets/itemviews/fetchmore/doc/fetchmore.rst new file mode 100644 index 000000000..08fa60a0c --- /dev/null +++ b/examples/widgets/itemviews/fetchmore/doc/fetchmore.rst @@ -0,0 +1,10 @@ +Fetch More Example +================== + +The Fetch More example shows how to add items to an item view model on demand. +This example demonstrates the analogous Qt example `Fetch More Example +<https://doc.qt.io/qt-6/qtwidgets-itemviews-fetchmore-example.html>`_. + +.. image:: fetchmore.png + :width: 400 + :alt: fetchmore screenshot diff --git a/examples/widgets/mainwindows/application/doc/application.png b/examples/widgets/mainwindows/application/doc/application.png Binary files differnew file mode 100644 index 000000000..b5fd4597d --- /dev/null +++ b/examples/widgets/mainwindows/application/doc/application.png diff --git a/examples/widgets/mainwindows/application/doc/application.rst b/examples/widgets/mainwindows/application/doc/application.rst new file mode 100644 index 000000000..0f56174d2 --- /dev/null +++ b/examples/widgets/mainwindows/application/doc/application.rst @@ -0,0 +1,13 @@ +Application Example +=================== + +This application is a simple text editor built using PySide6, demonstrating +how to create a modern GUI application with a menu bar, toolbars, and a status +bar. It supports basic file operations such as creating, opening, saving, and +editing text files. It demonstrates the analogous Qt example `Application Example +<https://doc.qt.io/qt-6.2/qtwidgets-mainwindows-application-example.html>`_. + +.. image:: application.png + :width: 400 + :alt: application screenshot + diff --git a/examples/widgets/mainwindows/mdi/doc/mdi.png b/examples/widgets/mainwindows/mdi/doc/mdi.png Binary files differnew file mode 100644 index 000000000..240f9e222 --- /dev/null +++ b/examples/widgets/mainwindows/mdi/doc/mdi.png diff --git a/examples/widgets/mainwindows/mdi/doc/mdi.rst b/examples/widgets/mainwindows/mdi/doc/mdi.rst new file mode 100644 index 000000000..dbbd747d7 --- /dev/null +++ b/examples/widgets/mainwindows/mdi/doc/mdi.rst @@ -0,0 +1,9 @@ +MDI Example +=========== + +The MDI example shows how to implement a Multiple Document Interface using +Qt's `QMdiArea` class. + +.. image:: mdi.png + :width: 400 + :alt: mdi screenshot diff --git a/examples/widgets/richtext/orderform/doc/orderform.rst b/examples/widgets/richtext/orderform/doc/orderform.rst new file mode 100644 index 000000000..ce5e53fae --- /dev/null +++ b/examples/widgets/richtext/orderform/doc/orderform.rst @@ -0,0 +1,9 @@ +Order Form Example +================== + +The Order Form example shows how to generate rich text documents by combining a +simple template with data input by the user in a dialog + +.. image:: orderform.webp + :width: 400 + :alt: orderform screenshot diff --git a/examples/widgets/richtext/orderform/doc/orderform.webp b/examples/widgets/richtext/orderform/doc/orderform.webp Binary files differnew file mode 100644 index 000000000..501ea16f4 --- /dev/null +++ b/examples/widgets/richtext/orderform/doc/orderform.webp diff --git a/examples/widgets/thread_signals/doc/thread_signals.png b/examples/widgets/thread_signals/doc/thread_signals.png Binary files differnew file mode 100644 index 000000000..ac13aa8e9 --- /dev/null +++ b/examples/widgets/thread_signals/doc/thread_signals.png diff --git a/examples/widgets/thread_signals/doc/thread_signals.rst b/examples/widgets/thread_signals/doc/thread_signals.rst new file mode 100644 index 000000000..e841ec363 --- /dev/null +++ b/examples/widgets/thread_signals/doc/thread_signals.rst @@ -0,0 +1,9 @@ +Thread Signals Examples +======================= + +This example demonstrates a PySide6 application that uses threads and signals +to perform background tasks. + +.. image:: thread_signals.png + :width: 400 + :alt: thread_signals screenshot |