QDesignerPropertyEditorInterface

The QDesignerPropertyEditorInterface class allows you to query and manipulate the current state of Qt Designer’s property editor. More

Inheritance diagram of PySide6.QtDesigner.QDesignerPropertyEditorInterface

Synopsis

Functions

Virtual functions

Detailed Description

QDesignerPropertyEditorInterface contains a collection of functions that is typically used to query the property editor for its current state, and several slots manipulating it’s state. The interface also provide a signal, , which is emitted whenever a property changes in the property editor. The signal’s arguments are the property that changed and its new value.

For example, when implementing a custom widget plugin, you can connect the signal to a custom slot:

QDesignerPropertyEditorInterface *propertyEditor = 0;
propertyEditor = formEditor->propertyEditor();

connect(propertyEditor, SIGNAL(propertyChanged(QString,QVariant)),
        this, SLOT(checkProperty(QString,QVariant)));

Then the custom slot can check if the new value is within the range we want when a specified property, belonging to a particular widget, changes:

void checkProperty(QString property, QVariant value) {
    QDesignerPropertyEditorInterface *propertyEditor = 0;
    propertyEditor = formEditor->propertyEditor();

    QObject *object = propertyeditor->object();
    MyCustomWidget *widget = qobject_cast<MyCustomWidget>(object);

    if (widget && property == aProperty && value != expectedValue)
        {...}
}

The QDesignerPropertyEditorInterface class is not intended to be instantiated directly. You can retrieve an interface to Qt Designer’s property editor using the propertyEditor() function. A pointer to Qt Designer’s current QDesignerFormEditorInterface object (formEditor in the examples above) is provided by the function’s parameter. When implementing a custom widget plugin, you must subclass the QDesignerCustomWidgetInterface to expose your plugin to Qt Designer.

The functions accessing the property editor are the core() function that you can use to retrieve an interface to the form editor, the function that returns the name of the currently selected property in the property editor, the function that returns the currently selected object in Qt Designer’s workspace, and the function that returns true if the property editor is write proteced (otherwise false).

The slots manipulating the property editor’s state are the slot that you can use to change the currently selected object in Qt Designer’s workspace, the slot that changes the value of a given property and the slot that control the write protection of the property editor.

class PySide6.QtDesigner.QDesignerPropertyEditorInterface(parent[, flags={}])
Parameters

Constructs a property editor interface with the given parent and the specified window flags.

PySide6.QtDesigner.QDesignerPropertyEditorInterface.core()
Return type

PySide6.QtDesigner.QDesignerFormEditorInterface

Returns a pointer to Qt Designer’s current QDesignerFormEditorInterface object.

PySide6.QtDesigner.QDesignerPropertyEditorInterface.currentPropertyName()
Return type

str

PySide6.QtDesigner.QDesignerPropertyEditorInterface.isReadOnly()
Return type

bool

PySide6.QtDesigner.QDesignerPropertyEditorInterface.object()
Return type

PySide6.QtCore.QObject

PySide6.QtDesigner.QDesignerPropertyEditorInterface.propertyChanged(name, value)
Parameters
  • name – str

  • value – object

PySide6.QtDesigner.QDesignerPropertyEditorInterface.setObject(object)
Parameters

objectPySide6.QtCore.QObject

PySide6.QtDesigner.QDesignerPropertyEditorInterface.setPropertyValue(name, value[, changed=true])
Parameters
  • name – str

  • value – object

  • changed – bool

PySide6.QtDesigner.QDesignerPropertyEditorInterface.setReadOnly(readOnly)
Parameters

readOnly – bool