diff options
Diffstat (limited to 'sources')
-rw-r--r-- | sources/pyside6/doc/CMakeLists.txt | 5 | ||||
-rw-r--r-- | sources/pyside6/doc/additionaldocs.lst | 12 | ||||
-rw-r--r-- | sources/pyside6/doc/examples/images/tabbedbrowser.png | bin | 37147 -> 0 bytes | |||
-rw-r--r-- | sources/pyside6/doc/examples/tabbedbrowser.rst | 58 | ||||
-rw-r--r-- | sources/pyside6/doc/images/screenshot_hello.png (renamed from sources/pyside6/doc/pyside-examples/images/screenshot_hello.png) | bin | 21193 -> 21193 bytes | |||
-rw-r--r-- | sources/pyside6/doc/pyside-examples/examples.qdoc | 37 | ||||
-rw-r--r-- | sources/pyside6/doc/pyside-examples/images/pysideexample-classwizard.png | bin | 57931 -> 0 bytes | |||
-rw-r--r-- | sources/pyside6/doc/pyside-examples/images/pysideexample-stardelegate.png | bin | 22482 -> 0 bytes | |||
-rw-r--r-- | sources/pyside6/doc/pyside-examples/pyside-classwizard.qdoc | 39 | ||||
-rw-r--r-- | sources/pyside6/doc/pyside-examples/pyside-stardelegate.qdoc | 39 | ||||
-rw-r--r-- | sources/pyside6/doc/qtmodules/pyside-examples.qdocconf.in | 12 | ||||
-rw-r--r-- | sources/pyside6/doc/quickstart.rst | 2 |
12 files changed, 1 insertions, 203 deletions
diff --git a/sources/pyside6/doc/CMakeLists.txt b/sources/pyside6/doc/CMakeLists.txt index 634ebb252..a8d81a772 100644 --- a/sources/pyside6/doc/CMakeLists.txt +++ b/sources/pyside6/doc/CMakeLists.txt @@ -97,11 +97,6 @@ if (FULLDOCSBUILD) endif() endforeach() - #Appending the additional qdocconf that describes the pyside-examples - #doc project. - configure_file("qtmodules/pyside-examples.qdocconf.in" "${CMAKE_CURRENT_LIST_DIR}/qtmodules/pyside-examples.qdocconf" @ONLY) - file(APPEND "pyside.qdocconf.in" "\@CMAKE_CURRENT_LIST_DIR\@/qtmodules/pyside-examples.qdocconf\n") - set(typeSystemDocXmlContents "${typeSystemDocXmlContents}\n</typesystem>\n") file(WRITE "${CMAKE_CURRENT_BINARY_DIR}/typesystem_doc.xml" "${typeSystemDocXmlContents}") diff --git a/sources/pyside6/doc/additionaldocs.lst b/sources/pyside6/doc/additionaldocs.lst index e6ffe7e5d..037cb60f7 100644 --- a/sources/pyside6/doc/additionaldocs.lst +++ b/sources/pyside6/doc/additionaldocs.lst @@ -51,18 +51,6 @@ # fi # done # A line enclosed in [] denotes a (relative) target directory -[pyside-examples] -all-pyside-examples.webxml -pysideexamples-widgets-dialogs-classwizard-classwizard-pyproject.webxml -pysideexamples-widgets-dialogs-classwizard-classwizard-py.webxml -pysideexamples-widgets-dialogs-classwizard-classwizard-qrc.webxml -pysideexamples-widgets-dialogs-classwizard-classwizard-rc-py.webxml -pysideexamples-widgets-dialogs-classwizard-example.webxml -pysideexamples-widgets-itemviews-stardelegate-example.webxml -pysideexamples-widgets-itemviews-stardelegate-stardelegate-pyproject.webxml -pysideexamples-widgets-itemviews-stardelegate-stardelegate-py.webxml -pysideexamples-widgets-itemviews-stardelegate-stareditor-py.webxml -pysideexamples-widgets-itemviews-stardelegate-starrating-py.webxml [overviews] animation-overview.webxml diff --git a/sources/pyside6/doc/examples/images/tabbedbrowser.png b/sources/pyside6/doc/examples/images/tabbedbrowser.png Binary files differdeleted file mode 100644 index 27c3daa09..000000000 --- a/sources/pyside6/doc/examples/images/tabbedbrowser.png +++ /dev/null diff --git a/sources/pyside6/doc/examples/tabbedbrowser.rst b/sources/pyside6/doc/examples/tabbedbrowser.rst deleted file mode 100644 index c34c50647..000000000 --- a/sources/pyside6/doc/examples/tabbedbrowser.rst +++ /dev/null @@ -1,58 +0,0 @@ -********************** -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. diff --git a/sources/pyside6/doc/pyside-examples/images/screenshot_hello.png b/sources/pyside6/doc/images/screenshot_hello.png Binary files differindex 41ebbf01b..41ebbf01b 100644 --- a/sources/pyside6/doc/pyside-examples/images/screenshot_hello.png +++ b/sources/pyside6/doc/images/screenshot_hello.png diff --git a/sources/pyside6/doc/pyside-examples/examples.qdoc b/sources/pyside6/doc/pyside-examples/examples.qdoc deleted file mode 100644 index 116ed65bb..000000000 --- a/sources/pyside6/doc/pyside-examples/examples.qdoc +++ /dev/null @@ -1,37 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2019 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:FDL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: https://www.gnu.org/licenses/fdl-1.3.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ - -/*! - \group all-pyside-examples - \title All Qt for Python Examples - \brief A varied selection of examples can be found in the 'examples' directory of the - pyside-setup repository. This can be accessed after installing - PySide6 via pip, checking the 'site-packages/PySide6/examples' directory. - - This page aims to document the most important use cases of the module - and it will be extended with each release. -*/ diff --git a/sources/pyside6/doc/pyside-examples/images/pysideexample-classwizard.png b/sources/pyside6/doc/pyside-examples/images/pysideexample-classwizard.png Binary files differdeleted file mode 100644 index 1706772d8..000000000 --- a/sources/pyside6/doc/pyside-examples/images/pysideexample-classwizard.png +++ /dev/null diff --git a/sources/pyside6/doc/pyside-examples/images/pysideexample-stardelegate.png b/sources/pyside6/doc/pyside-examples/images/pysideexample-stardelegate.png Binary files differdeleted file mode 100644 index 343416397..000000000 --- a/sources/pyside6/doc/pyside-examples/images/pysideexample-stardelegate.png +++ /dev/null diff --git a/sources/pyside6/doc/pyside-examples/pyside-classwizard.qdoc b/sources/pyside6/doc/pyside-examples/pyside-classwizard.qdoc deleted file mode 100644 index edfd68fd5..000000000 --- a/sources/pyside6/doc/pyside-examples/pyside-classwizard.qdoc +++ /dev/null @@ -1,39 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2019 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:FDL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: https://www.gnu.org/licenses/fdl-1.3.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ - -/*! - \example widgets/dialogs/classwizard - \title PySide6.QtWidgets - Classwizard Example - \ingroup all-pyside-examples - \brief Demonstrates the use of QDialog in a wizard application - - This example demonstrates the use a custom QDialog in a wizard, - which generates necessary C++ class template code. - - \image pysideexample-classwizard.png - -*/ diff --git a/sources/pyside6/doc/pyside-examples/pyside-stardelegate.qdoc b/sources/pyside6/doc/pyside-examples/pyside-stardelegate.qdoc deleted file mode 100644 index 6251ff3e1..000000000 --- a/sources/pyside6/doc/pyside-examples/pyside-stardelegate.qdoc +++ /dev/null @@ -1,39 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2019 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:FDL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: https://www.gnu.org/licenses/fdl-1.3.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ - -/*! - \example widgets/itemviews/stardelegate - \title PySide6.QtWidgets - Star Delegate Example - \ingroup all-pyside-examples - \brief Demonstrates Qt's itemview architecture - - This example demonstrates the itemview architecture, which - is unique to Qt. - - \image pysideexample-stardelegate.png -*/ - diff --git a/sources/pyside6/doc/qtmodules/pyside-examples.qdocconf.in b/sources/pyside6/doc/qtmodules/pyside-examples.qdocconf.in deleted file mode 100644 index 349c7f0f7..000000000 --- a/sources/pyside6/doc/qtmodules/pyside-examples.qdocconf.in +++ /dev/null @@ -1,12 +0,0 @@ -include(@QT_SRC_DIR@/doc/global/qt-module-defaults.qdocconf) - -project = PysideExamples -description = Qt for Python Examples -version = $QT_VERSION - -sourcedirs += @CMAKE_CURRENT_SOURCE_DIR@/pyside-examples -exampledirs = @CMAKE_CURRENT_SOURCE_DIR@/../../../examples -examples.fileextensions += *.py *.pyproject -imagedirs += @CMAKE_CURRENT_SOURCE_DIR@/pyside-examples/images -url.examples = "https://code.qt.io/cgit/pyside/pyside-setup.git/tree/examples/\1?h=$QT_VER" -include(../pyside-config.qdocconf) diff --git a/sources/pyside6/doc/quickstart.rst b/sources/pyside6/doc/quickstart.rst index 14d1c03a0..8cdd46053 100644 --- a/sources/pyside6/doc/quickstart.rst +++ b/sources/pyside6/doc/quickstart.rst @@ -116,5 +116,5 @@ guide you through the development process: Try clicking the button at the bottom to see which greeting you get. - .. image:: pyside-examples/images/screenshot_hello.png + .. image:: images/screenshot_hello.png :alt: Hello World application |