diff options
author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2024-03-25 08:28:50 +0100 |
---|---|---|
committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2024-03-25 09:46:45 +0100 |
commit | 25c038385c632e68d78fa58356fc35183c101801 (patch) | |
tree | e6394ec33c7a426a5bb1e23fd462a76f431622a7 /sources/pyside6 | |
parent | 3cba117184c6fa7965c09baeba27868a86ef63cd (diff) |
Documentation: Rename Qt Designer to Qt Widgets Designer
Use *Qt Widgets Designer* (emphasis/italics) instead of
**Qt Widgets Designer** (bold) consistently.
Also fix pyside-designer.rst (Qt Widget Designer -> Qt Widgets
Designer).
Pick-to: 6.7
Task-number: QTBUG-122253
Change-Id: I573264f5b02c62e4b91cfc0f8b0f38da691defed
Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
Diffstat (limited to 'sources/pyside6')
15 files changed, 57 insertions, 49 deletions
diff --git a/sources/pyside6/doc/extras/QtDesigner.QPyDesignerContainerExtension.rst b/sources/pyside6/doc/extras/QtDesigner.QPyDesignerContainerExtension.rst index 7fe6ecf74..a3e5ef511 100644 --- a/sources/pyside6/doc/extras/QtDesigner.QPyDesignerContainerExtension.rst +++ b/sources/pyside6/doc/extras/QtDesigner.QPyDesignerContainerExtension.rst @@ -3,7 +3,7 @@ QPyDesignerContainerExtension is the base class for implementing `QDesignerContainerExtension class`_ -for a Qt Designer custom widget plugin in Python. +for a *Qt Widgets Designer* custom widget plugin in Python. It provides the required inheritance from **QObject**. .. _QDesignerContainerExtension class: https://doc.qt.io/qt-6/qdesignercontainerextension.html diff --git a/sources/pyside6/doc/extras/QtDesigner.QPyDesignerCustomWidgetCollection.rst b/sources/pyside6/doc/extras/QtDesigner.QPyDesignerCustomWidgetCollection.rst index a202bab40..615ca4eec 100644 --- a/sources/pyside6/doc/extras/QtDesigner.QPyDesignerCustomWidgetCollection.rst +++ b/sources/pyside6/doc/extras/QtDesigner.QPyDesignerCustomWidgetCollection.rst @@ -26,7 +26,8 @@ The usage is explained in :ref:`designer_custom_widgets`. .. py:staticmethod:: QPyDesignerCustomWidgetCollection.registerCustomWidget(type[, xml=""[, tool_tip=""[, icon=""[, group=""[container=False]]]]]) - Registers an instance of a Python-implemented QWidget by type with Qt Designer. + Registers an instance of a Python-implemented QWidget by type with + *Qt Widgets Designer*. The optional keyword arguments correspond to the getters of `QDesignerCustomWidgetInterface`_ : @@ -44,7 +45,7 @@ The usage is explained in :ref:`designer_custom_widgets`. Adds a custom widget (implementation of `QDesignerCustomWidgetInterface`_) - with Qt Designer. + with *Qt Widgets Designer*. :param QDesignerCustomWidgetInterface custom_widget: Custom widget instance diff --git a/sources/pyside6/doc/extras/QtDesigner.QPyDesignerMemberSheetExtension.rst b/sources/pyside6/doc/extras/QtDesigner.QPyDesignerMemberSheetExtension.rst index 7d0d81d6c..ef2356221 100644 --- a/sources/pyside6/doc/extras/QtDesigner.QPyDesignerMemberSheetExtension.rst +++ b/sources/pyside6/doc/extras/QtDesigner.QPyDesignerMemberSheetExtension.rst @@ -3,7 +3,7 @@ QPyDesignerMemberSheetExtension is the base class for implementing `QDesignerMemberSheetExtension class`_ -for a Qt Designer custom widget plugin in Python. +for a *Qt Widgets Designer* custom widget plugin in Python. It provides the required inheritance from **QObject**. .. _QDesignerMemberSheetExtension class: https://doc.qt.io/qt-6/qdesignermembersheetextension.html diff --git a/sources/pyside6/doc/extras/QtDesigner.QPyDesignerTaskMenuExtension.rst b/sources/pyside6/doc/extras/QtDesigner.QPyDesignerTaskMenuExtension.rst index c8ac4598b..e5e13122d 100644 --- a/sources/pyside6/doc/extras/QtDesigner.QPyDesignerTaskMenuExtension.rst +++ b/sources/pyside6/doc/extras/QtDesigner.QPyDesignerTaskMenuExtension.rst @@ -3,7 +3,7 @@ QPyDesignerTaskMenuExtension is the base class for implementing `QDesignerTaskMenuExtension class`_ -for a Qt Designer custom widget plugin in Python. +for a *Qt Widgets Designer* custom widget plugin in Python. It provides the required inheritance from **QObject**. .. _QDesignerTaskMenuExtension class: https://doc.qt.io/qt-6/qdesignertaskmenuextension.html diff --git a/sources/pyside6/doc/extras/QtDesigner.rst b/sources/pyside6/doc/extras/QtDesigner.rst index c232128dd..844f25b7b 100644 --- a/sources/pyside6/doc/extras/QtDesigner.rst +++ b/sources/pyside6/doc/extras/QtDesigner.rst @@ -1,5 +1,6 @@ -Provides classes to create your own custom widget plugins for Qt Designer and -classes to access Qt Designer components. +Provides classes to create your own custom widget plugins for +*Qt Widgets Designer* and classes to access *Qt Widgets Designer* +components. In addition, the :class:`QFormBuilder<PySide6.QtDesigner.QFormBuilder>` class provides the possibility of constructing user interfaces from UI files at diff --git a/sources/pyside6/doc/extras/QtUiTools.rst b/sources/pyside6/doc/extras/QtUiTools.rst index c4873b43d..e83aa0357 100644 --- a/sources/pyside6/doc/extras/QtUiTools.rst +++ b/sources/pyside6/doc/extras/QtUiTools.rst @@ -1,4 +1,4 @@ -Qt Designer forms are processed at run-time to produce +*Qt Widgets Designer* forms are processed at run-time to produce dynamically-generated user interfaces. In order to generate a form at run-time, a resource file containing a UI file is needed. diff --git a/sources/pyside6/doc/extras/QtWidgets.rst b/sources/pyside6/doc/extras/QtWidgets.rst index 8c91d3e31..784421aac 100644 --- a/sources/pyside6/doc/extras/QtWidgets.rst +++ b/sources/pyside6/doc/extras/QtWidgets.rst @@ -52,7 +52,7 @@ widget reports its size requirements to the layout through the :meth:`sizePolicy<PySide6.QtWidgets.QWidget.sizePolicy>` properties, and the layout distributes the available space accordingly. -:ref:`Qt Designer<using_ui_files>` is a powerful tool for interactively +:ref:`Qt Widgets Designer<using_ui_files>` is a powerful tool for interactively creating and arranging widgets in layouts. Model/View Classes diff --git a/sources/pyside6/doc/faq/typesoffiles.rst b/sources/pyside6/doc/faq/typesoffiles.rst index d3bd4512d..08003f7f1 100644 --- a/sources/pyside6/doc/faq/typesoffiles.rst +++ b/sources/pyside6/doc/faq/typesoffiles.rst @@ -36,9 +36,10 @@ functionality to your applications. User Interface Definition File ``.ui`` -------------------------------------- -When using Qt Designer, you can create user interfaces using Qt Widgets with -the WYSIWYG form editor, this interface is represented as a widget tree using -XML. Here is an extract of the beginning of a ``.ui`` file: +When using *Qt Widgets Designer*, you can create user interfaces using +Qt Widgets with the WYSIWYG form editor, this interface is represented +as a widget tree using XML. Here is an extract of the beginning of a +``.ui`` file: .. code-block:: xml diff --git a/sources/pyside6/doc/faq/whichide.rst b/sources/pyside6/doc/faq/whichide.rst index ec005a188..0eaba0c9e 100644 --- a/sources/pyside6/doc/faq/whichide.rst +++ b/sources/pyside6/doc/faq/whichide.rst @@ -15,8 +15,8 @@ From a terminal: :command:`pyside6-uic -i form.ui -o ui_form.py` * Generating a Python file from a ``.qrc`` file: :command:`pyside6-rcc -i resources.qrc -o rc_resources.py` -* Opening Qt Designer with the command :command:`pyside6-designer` to - edit/create ``.ui`` files. +* Opening *Qt Widgets Designer* with the command :command:`pyside6-designer` + to edit/create ``.ui`` files. External add-ons/plugins from your favorite IDE might include configuration steps to run these commands, or open external tools like Designer and @@ -47,8 +47,10 @@ that you can install from VS Code while writing the following on the Quick Open PyCharm ------- -You can configure PyCharm to enable external tools, in |project| terms, Qt Designer, and -Qt Creator. Go to ``File > Settings > tools > PyCharm External Tools``, and include the following +You can configure PyCharm to enable external tools, in |project| terms, +*Qt Widgets Designer*, and Qt Creator. Go to +``File > Settings > tools > PyCharm External Tools``, and include the following information to add them to your project. -Later, you will be able to right click a ``.ui`` file, and select ``Qt Designer``, -``pyside6-uic``, or any tool that you configured this way. +Later, you will be able to right click a ``.ui`` file, and select +``Qt Widgets Designer``, ``pyside6-uic``, or any tool that you configured this +way. diff --git a/sources/pyside6/doc/modules.rst b/sources/pyside6/doc/modules.rst index 7d3a81f32..8e77a4616 100644 --- a/sources/pyside6/doc/modules.rst +++ b/sources/pyside6/doc/modules.rst @@ -44,7 +44,7 @@ Qt Modules Supported by Qt for Python .. grid-item-card:: :mod:`QtDesigner <PySide6.QtDesigner>` - Provides classes to extend Qt Designer. + Provides classes to extend *Qt Widgets Designer*. .. grid-item-card:: :mod:`QtGui <PySide6.QtGui>` @@ -173,7 +173,7 @@ Qt Modules Supported by Qt for Python .. grid-item-card:: :mod:`QtUiTools <PySide6.QtUiTools>` - Provides classes to handle forms created with Qt Designer. + Provides classes to handle forms created with *Qt Widgets Designer*. .. grid-item-card:: :mod:`Qt WebChannel <PySide6.QtWebChannel>` diff --git a/sources/pyside6/doc/tools/index.rst b/sources/pyside6/doc/tools/index.rst index a8b97a75f..392fb810c 100644 --- a/sources/pyside6/doc/tools/index.rst +++ b/sources/pyside6/doc/tools/index.rst @@ -27,8 +27,9 @@ Project development :link: pyside6-project :link-type: ref - to build Qt Designer forms (``.ui`` files), resource files (``.qrc``) - and QML type files (``.qmltype``) from a ``.pyproject`` file. + to build *Qt Widgets Designer* forms (``.ui`` files), + resource files (``.qrc``) and QML type files (``.qmltype``) + from a ``.pyproject`` file. Widget Development ~~~~~~~~~~~~~~~~~~ diff --git a/sources/pyside6/doc/tools/pyside-designer.rst b/sources/pyside6/doc/tools/pyside-designer.rst index 05d7556b1..4cde6b2bf 100644 --- a/sources/pyside6/doc/tools/pyside-designer.rst +++ b/sources/pyside6/doc/tools/pyside-designer.rst @@ -3,7 +3,7 @@ pyside6-designer ================ -``pyside6-designer`` is a tool that wraps the `Qt Widget Designer`_, +``pyside6-designer`` is a tool that wraps the `Qt Widgets Designer`_, to enable you to design Qt Widgets applications with a *drag-and-drop* approach. @@ -46,13 +46,13 @@ with the help of the :ref:`pyside6-uic` tool. You can find more details of this process in: :ref:`using_ui_files`. If you are interested in more functionality of the tool, you can check -the official `Qt Widget Designer Manual`_. +the official `Qt Widgets Designer Manual`_. Custom Widgets -------------- -One of the features that the `Qt Widget Designer`_ provides is the possibility +One of the features that the `Qt Widgets Designer`_ provides is the possibility of loading custom widgets, in order to facilitate the development with ad-hoc widgets. @@ -80,12 +80,12 @@ is located. The registration file for the tic-tac-toe widget looks like this: As you can see in the previous code, ``TicTacToe`` is the custom widget, imported from a different file, and the ``TicTacToePlugin`` is the interface -layer for `Qt Widget Designer`_ to recognize it. +layer for `Qt Widgets Designer`_ to recognize it. We provide a helper class, ``QPyDesignerCustomWidgetCollection``, to simplify the registration process. If you are interested in all the details of this specific case, you can check the :ref:`task-menu-extension-example`. -.. _`Qt Widget Designer`: https://doc.qt.io/qt-6/qtdesigner-manual.html -.. _`Qt Widget Designer Manual`: https://doc.qt.io/qt-6/qtdesigner-manual.html +.. _`Qt Widgets Designer`: https://doc.qt.io/qt-6/qtdesigner-manual.html +.. _`Qt Widgets Designer Manual`: https://doc.qt.io/qt-6/qtdesigner-manual.html diff --git a/sources/pyside6/doc/tools/pyside-project.rst b/sources/pyside6/doc/tools/pyside-project.rst index 2a7394065..0359e1b7d 100644 --- a/sources/pyside6/doc/tools/pyside-project.rst +++ b/sources/pyside6/doc/tools/pyside-project.rst @@ -28,7 +28,8 @@ The tool has several subcommands. New projects can be created using the below commands, passing the project name (directory): *new-ui* - Creates a new QtWidgets project with a Qt Designer-based main window. + Creates a new QtWidgets project with a *Qt Widgets Designer*-based main + window. *new-widget* Creates a new QtWidgets project with a main window. diff --git a/sources/pyside6/doc/tutorials/basictutorial/signals_and_slots.rst b/sources/pyside6/doc/tutorials/basictutorial/signals_and_slots.rst index e5d746c22..0bfd9e276 100644 --- a/sources/pyside6/doc/tutorials/basictutorial/signals_and_slots.rst +++ b/sources/pyside6/doc/tutorials/basictutorial/signals_and_slots.rst @@ -79,7 +79,7 @@ Signals can also be connected to free functions: Connections can be spelled out in code or, for widget forms, designed in the `Signal-Slot Editor <https://doc.qt.io/qt-6/designer-connection-mode.html>`_ -of Qt Designer. +of *Qt Widgets Designer*. The Signal Class ---------------- diff --git a/sources/pyside6/doc/tutorials/basictutorial/uifiles.rst b/sources/pyside6/doc/tutorials/basictutorial/uifiles.rst index 20c66496d..1b313c3c3 100644 --- a/sources/pyside6/doc/tutorials/basictutorial/uifiles.rst +++ b/sources/pyside6/doc/tutorials/basictutorial/uifiles.rst @@ -4,13 +4,13 @@ Using ``.ui`` files from Designer or QtCreator with ``QUiLoader`` and ``pyside6- ************************************************************************************* This page describes the use of -`Qt Designer <https://doc.qt.io/qt-6/qtdesigner-manual.html>`_ to create +`Qt Widgets Designer <https://doc.qt.io/qt-6/qtdesigner-manual.html>`_ to create graphical interfaces based on Qt Widgets for your Qt for Python project. -**Qt Designer** is a graphical UI design tool which is available as a +*Qt Widgets Designer* is a graphical UI design tool which is available as a standalone binary (``pyside6-designer``) or embedded into the `Qt Creator IDE <https://doc.qt.io/qtcreator>`_. Its use within **Qt Creator** is described at -`Using Qt Designer <https://doc.qt.io/qtcreator/creator-using-qt-designer.html>`_. +`Using Qt Widgets Designer <https://doc.qt.io/qtcreator/creator-using-qt-designer.html>`_. .. image:: uifiles.png :alt: Designer and the equivalent code @@ -206,14 +206,15 @@ command prompt: .. _designer_custom_widgets: -Custom Widgets in Qt Designer -============================= +Custom Widgets in Qt Widgets Designer +===================================== -**Qt Designer** is able to use user-provided (custom) widgets. They are shown -in the widget box and can be dragged onto the form just like Qt's widgets (see -`Using Custom Widgets with Qt Designer <https://doc.qt.io/qt-6/designer-using-custom-widgets.html>`_ -). Normally, this requires implementing the widget as a plugin to Qt Designer -written in C++ implementing its +*Qt Widgets Designer* is able to use user-provided (custom) widgets. +They are shown in the widget box and can be dragged onto the form just like +Qt's widgets (see +`Using Custom Widgets with Qt Widgets Designer <https://doc.qt.io/qt-6/designer-using-custom-widgets.html>`_ +). Normally, this requires implementing the widget as a plugin to +*Qt Widgets Designer* written in C++ implementing its `QDesignerCustomWidgetInterface`_ . Qt for Python provides a simple interface for this which is similar to @@ -223,7 +224,7 @@ The widget needs to be provided as a Python module, as shown by the :ref:`widgetbinding-example` (file ``wigglywidget.py``) or the :ref:`task-menu-extension-example` (file ``tictactoe.py``). -Registering this with Qt Designer is done by providing +Registering this with *Qt Widgets Designer* is done by providing a registration script named ``register*.py`` and pointing the path-type environment variable ``PYSIDE_DESIGNER_PLUGINS`` to the directory. @@ -263,19 +264,19 @@ The code of the registration script looks as follows: QPyDesignerCustomWidgetCollection provides an implementation of `QDesignerCustomWidgetCollectionInterface`_ -exposing custom widgets to **Qt Designer** with static convenience functions -for registering types or adding instances of +exposing custom widgets to *Qt Widgets Designer* with static convenience +functions for registering types or adding instances of `QDesignerCustomWidgetInterface`_ . The function :meth:`registerCustomWidget()<PySide6.QtDesigner.QPyDesignerCustomWidgetCollection.registerCustomWidget>` -is used to register a widget type with **Qt Designer**. In the simple case, it +is used to register a widget type with *Qt Widgets Designer*. In the simple case, it can be used like ``QUiLoader.registerCustomWidget()``. It takes the custom widget type and some optional keyword arguments passing values that correspond to the getters of `QDesignerCustomWidgetInterface`_ : -When launching **Qt Designer** via its launcher ``pyside6-designer``, +When launching *Qt Widgets Designer* via its launcher ``pyside6-designer``, the custom widget should be visible in the widget box. For advanced usage, it is also possible to pass the function an implementation @@ -289,15 +290,15 @@ corresponding C++ .. _QDesignerCustomWidgetCollectionInterface: https://doc.qt.io/qt-6/qdesignercustomwidgetcollectioninterface.html .. _QDesignerCustomWidgetInterface: https://doc.qt.io/qt-6/qdesignercustomwidgetinterface.html -Troubleshooting the Qt Designer Plugin -++++++++++++++++++++++++++++++++++++++ +Troubleshooting the Qt Widgets Designer Plugin +++++++++++++++++++++++++++++++++++++++++++++++ - The launcher ``pyside6-designer`` must be used. The standalone - **Qt Designer** will not load the plugin. + *Qt Widgets Designer* will not load the plugin. - The menu item **Help/About Plugin** brings up a dialog showing the plugins found and potential load error messages. - Check the console or Windows Debug view for further error messages. - Due to the buffering of output by Python, error messages may appear - only after **Qt Designer** has terminated. + only after *Qt Widgets Designer* has terminated. - When building Qt for Python, be sure to set the ``--standalone`` option for the plugin to be properly installed. |