PySide6.QtDesigner.QDesignerMemberSheetExtension

class QDesignerMemberSheetExtension

The QDesignerMemberSheetExtension class allows you to manipulate a widget’s member functions which is displayed when configuring connections using Qt Widgets Designer’s mode for editing signals and slots. More…

Synopsis

Methods

Virtual methods

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

QDesignerMemberSheetExtension is a collection of functions that is typically used to query a widget’s member functions, and to manipulate the member functions’ appearance in Qt Widgets Designer’s signals and slots editing mode. For example:

memberSheet = None
manager = formEditor.extensionManager()
memberSheet = qt_extension<QDesignerMemberSheetExtension*>(manager, widget)
index = memberSheet.indexOf(setEchoMode)
memberSheet.setVisible(index, False)
del memberSheet

When implementing a custom widget plugin, a pointer to Qt Widgets Designer’s current QDesignerFormEditorInterface object (formEditor in the example above) is provided by the initialize() function’s parameter.

The member sheet (and any other extension), can be retrieved by querying Qt Widgets Designer’s extension manager using the qt_extension() function. When you want to release the extension, you only need to delete the pointer.

All widgets have a default member sheet used in Qt Widgets Designer’s signals and slots editing mode with the widget’s member functions. But QDesignerMemberSheetExtension also provides an interface for creating custom member sheet extensions.

Warning

Qt Widgets Designer uses the QDesignerMemberSheetExtension to facilitate the signal and slot editing mode. Whenever a connection between two widgets is requested, Qt Widgets Designer will query for the widgets’ member sheet extensions. If a widget has an implemented member sheet extension, this extension will override the default member sheet.

To create a member sheet extension, your extension class must inherit from both QObject and QDesignerMemberSheetExtension . Then, since we are implementing an interface, we must ensure that it’s made known to the meta object system using the Q_INTERFACES() macro:

class MyMemberSheetExtension(QObject,
        public QDesignerMemberSheetExtension

    Q_OBJECT
    Q_INTERFACES(QDesignerMemberSheetExtension)
# public
    ...

This enables Qt Widgets Designer to use qobject_cast() to query for supported interfaces using nothing but a QObject pointer.

In Qt Widgets Designer the extensions are not created until they are required. For that reason, when implementing a member sheet extension, you must also create a QExtensionFactory , i.e a class that is able to make an instance of your extension, and register it using Qt Widgets Designer’s extension manager .

When a widget’s member sheet extension is required, Qt Widgets Designer’s extension manager will run through all its registered factories calling createExtension() for each until the first one that is able to create a member sheet extension for that widget, is found. This factory will then make an instance of the extension. If no such factory is found, Qt Widgets Designer will use the default member sheet.

There are four available types of extensions in Qt Widgets Designer: QDesignerContainerExtension , QDesignerMemberSheetExtension , QDesignerPropertySheetExtension and QDesignerTaskMenuExtension . Qt Widgets Designer’s behavior is the same whether the requested extension is associated with a multi page container, a member sheet, a property sheet or a task menu.

The QExtensionFactory class provides a standard extension factory, and can also be used as an interface for custom extension factories. You can either create a new QExtensionFactory and reimplement the createExtension() function. For example:

QObject ANewExtensionFactory.createExtension(QObject object,
        QString iid, QObject parent)

    if iid != Q_TYPEID(QDesignerMemberSheetExtension):
        return 0
    if (MyCustomWidget widget = qobject_cast<MyCustomWidget>
           (object))
        return MyMemberSheetExtension(widget, parent)
    return 0

Or you can use an existing factory, expanding the createExtension() function to make the factory able to create a member sheet extension as well. For example:

QObject AGeneralExtensionFactory.createExtension(QObject object,
        QString iid, QObject parent)

    widget = MyCustomWidget(object)
    if widget and (iid == Q_TYPEID(QDesignerTaskMenuExtension)):
        return MyTaskMenuExtension(widget, parent)
     elif widget and (iid == Q_TYPEID(QDesignerMemberSheetExtension)):
        return MyMemberSheetExtension(widget, parent)
    else:
        return 0

For a complete example using an extension class, see Task Menu Extension example . The example shows how to create a custom widget plugin for Qt Designer, and how to use the QDesignerTaskMenuExtension class to add custom items to Qt Widgets Designer’s task menu.

See also

QExtensionFactory QExtensionManager Creating Custom Widget Extensions

__init__()
abstract count()
Return type:

int

Returns the extension’s number of member functions.

abstract declaredInClass(index)
Parameters:

index – int

Return type:

str

Returns the name of the class in which the member function with the given index is declared.

See also

indexOf()

abstract indexOf(name)
Parameters:

name – str

Return type:

int

Returns the index of the member function specified by the given name.

See also

memberName()

abstract inheritedFromWidget(index)
Parameters:

index – int

Return type:

bool

Returns true if the member function with the given index is inherited from QWidget, otherwise false.

See also

indexOf()

abstract isSignal(index)
Parameters:

index – int

Return type:

bool

Returns true if the member function with the given index is a signal, otherwise false.

See also

indexOf()

abstract isSlot(index)
Parameters:

index – int

Return type:

bool

Returns true if the member function with the given index is a slot, otherwise false.

See also

indexOf()

abstract isVisible(index)
Parameters:

index – int

Return type:

bool

Returns true if the member function with the given index is visible in Qt Widgets Designer’s signal and slot editor, otherwise false.

abstract memberGroup(index)
Parameters:

index – int

Return type:

str

Returns the name of the member group specified for the function with the given index.

abstract memberName(index)
Parameters:

index – int

Return type:

str

Returns the name of the member function with the given index.

See also

indexOf()

abstract parameterNames(index)
Parameters:

index – int

Return type:

.list of QByteArray

Returns the parameter names of the member function with the given index, as a QByteArray list.

abstract parameterTypes(index)
Parameters:

index – int

Return type:

.list of QByteArray

Returns the parameter types of the member function with the given index, as a QByteArray list.

abstract setMemberGroup(index, group)
Parameters:

  • index – int

  • group – str

Sets the member group of the member function with the given index, to group.

abstract setVisible(index, b)
Parameters:

  • index – int

  • b – bool

If visible is true, the member function with the given index is visible in Qt Widgets Designer’s signals and slots editing mode; otherwise the member function is hidden.

abstract signature(index)
Parameters:

index – int

Return type:

str

Returns the signature of the member function with the given index.

See also

indexOf()