QDesignerFormEditorInterface

The QDesignerFormEditorInterface class allows you to access Qt Designer’s various components. More

Inheritance diagram of PySide6.QtDesigner.QDesignerFormEditorInterface

Synopsis

Functions

Static functions

Detailed Description

Qt Designer’s current QDesignerFormEditorInterface object holds information about all Qt Designer’s components: The action editor, the object inspector, the property editor, the widget box, and the extension and form window managers. QDesignerFormEditorInterface contains a collection of functions that provides interfaces to all these components. They are typically used to query (and manipulate) the respective component. For example:

QDesignerObjectInspectorInterface *objectInspector = 0;
objectInspector = formEditor->objectInspector();

QDesignerFormWindowManagerInterface *manager = 0;
manager = formEditor->formWindowManager();

objectInspector->setFormWindow(manager->formWindow(0));

QDesignerFormEditorInterface is not intended to be instantiated directly. A pointer to Qt Designer’s current QDesignerFormEditorInterface object (formEditor in the example 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.

QDesignerFormEditorInterface also provides functions that can set the action editor, property editor, object inspector and widget box. These are only useful if you want to provide your own custom components.

If designer is embedded in another program, one could to provide its own settings manager. The manager is used by the components of Qt Designer to store/retrieve persistent configuration settings. The default manager uses QSettings as the backend.

Finally, QDesignerFormEditorInterface provides the topLevel() function that returns Qt Designer’s top-level widget.

class PySide6.QtDesigner.QDesignerFormEditorInterface([parent=None])
Parameters

parentPySide6.QtCore.QObject

Constructs a QDesignerFormEditorInterface object with the given parent.

PySide6.QtDesigner.QDesignerFormEditorInterface.actionEditor()
Return type

PySide6.QtDesigner.QDesignerActionEditorInterface

Returns an interface to Qt Designer’s action editor.

static PySide6.QtDesigner.QDesignerFormEditorInterface.createIcon(name)
Parameters

name – str

Return type

PySide6.QtGui.QIcon

PySide6.QtDesigner.QDesignerFormEditorInterface.extensionManager()
Return type

PySide6.QtDesigner.QExtensionManager

Returns an interface to Qt Designer’s extension manager.

PySide6.QtDesigner.QDesignerFormEditorInterface.formWindowManager()
Return type

PySide6.QtDesigner.QDesignerFormWindowManagerInterface

Returns an interface to Qt Designer’s form window manager.

PySide6.QtDesigner.QDesignerFormEditorInterface.objectInspector()
Return type

PySide6.QtDesigner.QDesignerObjectInspectorInterface

Returns an interface to Qt Designer’s object inspector.

PySide6.QtDesigner.QDesignerFormEditorInterface.pluginInstances()
Return type

PySide6.QtDesigner.QDesignerFormEditorInterface.propertyEditor()
Return type

PySide6.QtDesigner.QDesignerPropertyEditorInterface

Returns an interface to Qt Designer’s property editor.

PySide6.QtDesigner.QDesignerFormEditorInterface.resourceLocation()
Return type

str

PySide6.QtDesigner.QDesignerFormEditorInterface.setActionEditor(actionEditor)
Parameters

actionEditorPySide6.QtDesigner.QDesignerActionEditorInterface

Sets Qt Designer’s action editor to be the specified actionEditor.

See also

actionEditor()

PySide6.QtDesigner.QDesignerFormEditorInterface.setExtensionManager(extensionManager)
Parameters

extensionManagerPySide6.QtDesigner.QExtensionManager

PySide6.QtDesigner.QDesignerFormEditorInterface.setFormManager(formWindowManager)
Parameters

formWindowManagerPySide6.QtDesigner.QDesignerFormWindowManagerInterface

PySide6.QtDesigner.QDesignerFormEditorInterface.setObjectInspector(objectInspector)
Parameters

objectInspectorPySide6.QtDesigner.QDesignerObjectInspectorInterface

Sets Qt Designer’s object inspector to be the specified objectInspector.

PySide6.QtDesigner.QDesignerFormEditorInterface.setPropertyEditor(propertyEditor)
Parameters

propertyEditorPySide6.QtDesigner.QDesignerPropertyEditorInterface

Sets Qt Designer’s property editor to be the specified propertyEditor.

See also

propertyEditor()

PySide6.QtDesigner.QDesignerFormEditorInterface.setTopLevel(topLevel)
Parameters

topLevelPySide6.QtWidgets.QWidget

PySide6.QtDesigner.QDesignerFormEditorInterface.setWidgetBox(widgetBox)
Parameters

widgetBoxPySide6.QtDesigner.QDesignerWidgetBoxInterface

Sets Qt Designer’s widget box to be the specified widgetBox.

See also

widgetBox()

PySide6.QtDesigner.QDesignerFormEditorInterface.topLevel()
Return type

PySide6.QtWidgets.QWidget

Returns Qt Designer’s top-level widget.

PySide6.QtDesigner.QDesignerFormEditorInterface.widgetBox()
Return type

PySide6.QtDesigner.QDesignerWidgetBoxInterface

Returns an interface to Qt Designer’s widget box.

See also

setWidgetBox()