Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorShyamnath Premnadh <Shyamnath.Premnadh@qt.io>2024-12-11 13:02:23 +0100
committerShyamnath Premnadh <Shyamnath.Premnadh@qt.io>2024-12-12 13:47:55 +0100
commitf6069b9330fc01b68296ef4dffd474ed98784ec6 (patch)
treed3f504d8070430e9f7dfe68e614cc11729420950 /examples/widgets/mainwindows
parent31a9db93d3c355d8e6be4d31eacc02b93d41ffd3 (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 <Friedemann.Kleint@qt.io>
Diffstat (limited to 'examples/widgets/mainwindows')
-rw-r--r--examples/widgets/mainwindows/application/doc/application.pngbin0 -> 39984 bytes
-rw-r--r--examples/widgets/mainwindows/application/doc/application.rst13
-rw-r--r--examples/widgets/mainwindows/mdi/doc/mdi.pngbin0 -> 33375 bytes
-rw-r--r--examples/widgets/mainwindows/mdi/doc/mdi.rst9
4 files changed, 22 insertions, 0 deletions
diff --git a/examples/widgets/mainwindows/application/doc/application.png b/examples/widgets/mainwindows/application/doc/application.png
new file mode 100644
index 000000000..b5fd4597d
--- /dev/null
+++ b/examples/widgets/mainwindows/application/doc/application.png
Binary files differ
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
new file mode 100644
index 000000000..240f9e222
--- /dev/null
+++ b/examples/widgets/mainwindows/mdi/doc/mdi.png
Binary files differ
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