diff options
| author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2024-10-23 09:04:59 +0200 |
|---|---|---|
| committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2024-10-24 09:44:57 +0200 |
| commit | 0f1756769b66152c561233bb2de1ce3e21a8321f (patch) | |
| tree | e4934e2af44bb0a90cc3ba43808abdf39618d96b /sources/pyside6/doc/extras/QtDesigner.QPyDesignerCustomWidgetCollection.rst | |
| parent | 35eb8b218405cec8610394add763d1d4297ae24a (diff) | |
Fix extra class documentation
- Add indentation
- Use refs for classes and decorators
- Fix method/parameter listings
Pick-to: 6.8
Change-Id: Iaada9d40e734935d5e56d75fc2a9b1a72da58e33
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
Diffstat (limited to 'sources/pyside6/doc/extras/QtDesigner.QPyDesignerCustomWidgetCollection.rst')
| -rw-r--r-- | sources/pyside6/doc/extras/QtDesigner.QPyDesignerCustomWidgetCollection.rst | 66 |
1 files changed, 32 insertions, 34 deletions
diff --git a/sources/pyside6/doc/extras/QtDesigner.QPyDesignerCustomWidgetCollection.rst b/sources/pyside6/doc/extras/QtDesigner.QPyDesignerCustomWidgetCollection.rst index 615ca4eec..083fb1f76 100644 --- a/sources/pyside6/doc/extras/QtDesigner.QPyDesignerCustomWidgetCollection.rst +++ b/sources/pyside6/doc/extras/QtDesigner.QPyDesignerCustomWidgetCollection.rst @@ -1,52 +1,50 @@ .. currentmodule:: PySide6.QtDesigner .. py:class:: QPyDesignerCustomWidgetCollection -Synopsis --------- + Synopsis + -------- -Functions -^^^^^^^^^ + Methods + ^^^^^^^ -+------------------------------------------------------------------------------------------------+ -|def :meth:`registerCustomWidget<QPyDesignerCustomWidgetCollection.registerCustomWidget>` (type) | -+------------------------------------------------------------------------------------------------+ -|def :meth:`addCustomWidget<QPyDesignerCustomWidgetCollection.addCustomWidget>` (custom_widget) | -+------------------------------------------------------------------------------------------------+ + .. container:: function_list -Detailed Description --------------------- + def :meth:`registerCustomWidget` + def :meth:`addCustomWidget` -The :class:`~.QPyDesignerCustomWidgetCollection` implements -`QDesignerCustomWidgetCollectionInterface <https://doc.qt.io/qt-6/qdesignercustomwidgetcollectioninterface.html>`_ -and provides static helper functions for registering custom widgets by -type or by implementing -`QDesignerCustomWidgetInterface`_ . + Detailed Description + -------------------- -The usage is explained in :ref:`designer_custom_widgets`. + The :class:`~.QPyDesignerCustomWidgetCollection` implements + `QDesignerCustomWidgetCollectionInterface <https://doc.qt.io/qt-6/qdesignercustomwidgetcollectioninterface.html>`_ + and provides static helper functions for registering custom widgets by + type or by implementing `QDesignerCustomWidgetInterface`_ . -.. py:staticmethod:: QPyDesignerCustomWidgetCollection.registerCustomWidget(type[, xml=""[, tool_tip=""[, icon=""[, group=""[container=False]]]]]) + The usage is explained in :ref:`designer_custom_widgets`. - Registers an instance of a Python-implemented QWidget by type with - *Qt Widgets Designer*. + .. py:staticmethod:: QPyDesignerCustomWidgetCollection.registerCustomWidget(type[, xml=""[, tool_tip=""[, icon=""[, group=""[container=False]]]]]) - The optional keyword arguments correspond to the getters of - `QDesignerCustomWidgetInterface`_ : + :param str xml: A snippet of XML code in ``.ui`` format that specifies how the widget is created and sets initial property values. + :param str tool_tip: Tool tip to be shown in the widget box. + :param str icon: Path to an icon file be shown in the widget box. + :param str group: Category for grouping widgets in the widget box. + :param str module: Module name for generating the import code by `uic <https://doc.qt.io/qt-6/uic.html>`_ . + :param bool container: Indicates whether the widget is a container like `QGroupBox`, that is, child widgets can be placed on it. - :param str xml: A snippet of XML code in ``.ui`` format that specifies how the widget is created and sets initial property values. - :param str tool_tip: Tool tip to be shown in the widget box. - :param str icon: Path to an icon file be shown in the widget box. - :param str group: Category for grouping widgets in the widget box. - :param str module: Module name for generating the import code by `uic <https://doc.qt.io/qt-6/uic.html>`_ . - :param bool container: Indicates whether the widget is a container like `QGroupBox`, that is, child widgets can be placed on it. + Registers an instance of a Python-implemented QWidget by type with + *Qt Widgets Designer*. - .. seealso:: :meth:`registerCustomWidget()<PySide6.QtUiTools.QUiLoader.registerCustomWidget>` + The optional keyword arguments correspond to the getters of + `QDesignerCustomWidgetInterface`_ : -.. py:staticmethod:: QPyDesignerCustomWidgetCollection.addCustomWidget(custom_widget) + .. seealso:: :meth:`registerCustomWidget()<PySide6.QtUiTools.QUiLoader.registerCustomWidget>` - Adds a custom widget (implementation of - `QDesignerCustomWidgetInterface`_) - with *Qt Widgets Designer*. + .. py:staticmethod:: QPyDesignerCustomWidgetCollection.addCustomWidget(custom_widget) - :param QDesignerCustomWidgetInterface custom_widget: Custom widget instance + :param QDesignerCustomWidgetInterface custom_widget: Custom widget instance + + Adds a custom widget (implementation of + `QDesignerCustomWidgetInterface`_) + with *Qt Widgets Designer*. .. _QDesignerCustomWidgetInterface: https://doc.qt.io/qt-6/qdesignercustomwidgetinterface.html |