aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside2/doc/examples
diff options
context:
space:
mode:
Diffstat (limited to 'sources/pyside2/doc/examples')
-rw-r--r--sources/pyside2/doc/examples/images/tabbedbrowser.pngbin0 -> 37147 bytes
-rw-r--r--sources/pyside2/doc/examples/index.rst14
-rw-r--r--sources/pyside2/doc/examples/tabbedbrowser.rst58
3 files changed, 72 insertions, 0 deletions
diff --git a/sources/pyside2/doc/examples/images/tabbedbrowser.png b/sources/pyside2/doc/examples/images/tabbedbrowser.png
new file mode 100644
index 000000000..27c3daa09
--- /dev/null
+++ b/sources/pyside2/doc/examples/images/tabbedbrowser.png
Binary files differ
diff --git a/sources/pyside2/doc/examples/index.rst b/sources/pyside2/doc/examples/index.rst
new file mode 100644
index 000000000..6d2b56dca
--- /dev/null
+++ b/sources/pyside2/doc/examples/index.rst
@@ -0,0 +1,14 @@
+|project| Examples
+===================
+
+A collection of examples are provided with |project| to help new users
+to understand different use cases of the module.
+You can find all the examples inside the ``pyside-setup`` on the ``examples``
+directory, or you can access them after installing |pymodname| from ``pip``
+inside the ``site-packages/PySide2/examples`` directory.
+
+.. toctree::
+ :maxdepth: 1
+
+ tabbedbrowser.rst
+ ../pyside-examples/all-pyside-examples.rst
diff --git a/sources/pyside2/doc/examples/tabbedbrowser.rst b/sources/pyside2/doc/examples/tabbedbrowser.rst
new file mode 100644
index 000000000..c34c50647
--- /dev/null
+++ b/sources/pyside2/doc/examples/tabbedbrowser.rst
@@ -0,0 +1,58 @@
+**********************
+Web Browser Example
+**********************
+
+The example demonstrates the power and simplicity offered by |project| to developers.
+It uses several |pymodname| submodules to offer a fluid and modern-looking UI that
+is apt for a web browser. The application offers the following features:
+
+ * Tab-based browsing experience using QTabWidget.
+ * Download manager using a QProgressBar and QWebEngineDownloadItem.
+ * Bookmark manager using QTreeView.
+
+.. image:: images/tabbedbrowser.png
+
+The application's code is organized in several parts for ease of maintenance. For example,
+:code:`DownloadWidget` provides a widget to track progress of a download item. In the following
+sections, these different parts are discussed briefly to help you understand the Python code behind
+them a little better.
+
+BookmarkWidget or :code:`bookmarkwidget.py`
+===========================================
+
+This widget docks to the left of the main window by default. It inherits QTreeView and
+loads a default set of bookmarks using a QStandardItemModel. The model is populated at startup
+from a JSON file, which is updated when you add or remove bookmarks from the tree view.
+
+.. automodule:: bookmarkwidget
+ :members:
+
+DownloadWidget or :code:`downloadwidget.py`
+=============================================
+
+The widget tracks progress of the download item. It inherits QProgressBar to display
+progress of the QWebEngineDownloadItem instance, and offers a context-menu with actions such as Launch,
+Show in folder, Cancel, and Remove.
+
+.. automodule:: downloadwidget
+ :members:
+
+BrowserTabWidget or :code:`browsertabwidget.py`
+===============================================
+
+The widget includes a QWebEngineView to enable viewing web content. It docks to the right
+of BookmarkWidget in the main window.
+
+.. automodule:: browsertabwidget
+ :members:
+
+MainWindow or :code:`main.py`
+=============================
+
+This is the parent window that collates all the other widgets together to offer the complete package.
+
+.. automodule:: main
+ :members:
+
+
+Try running the example to explore it further.