PySide6.QtDesigner.QDesignerFormEditorInterface¶

class QDesignerFormEditorInterface¶

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

Synopsis¶

Methods¶

def __init__()
def actionEditor()
def extensionManager()
def formWindowManager()
def objectInspector()
def pluginInstances()
def propertyEditor()
def resourceLocation()
def setActionEditor()
def setExtensionManager()
def setFormManager()
def setObjectInspector()
def setPropertyEditor()
def setTopLevel()
def setWidgetBox()
def topLevel()
def widgetBox()

Static functions¶

def createIcon()

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.

Qt Widgets Designer’s current QDesignerFormEditorInterface object holds information about all Qt Widgets 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:

objectInspector = formEditor.objectInspector()
manager = formEditor.formWindowManager()
objectInspector.setFormWindow(manager.formWindow(0))

QDesignerFormEditorInterface is not intended to be instantiated directly. A pointer to Qt Widgets Designer’s current QDesignerFormEditorInterface object (formEditor in the example above) is provided by the initialize() function’s parameter. When implementing a custom widget plugin, you must subclass the QDesignerCustomWidgetInterface to expose your plugin to Qt Widgets 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 Widgets Designer to store/retrieve persistent configuration settings. The default manager uses QSettings as the backend.

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

See also

QDesignerCustomWidgetInterface

__init__([parent=None])¶

Parameters:: parent – QObject

Constructs a QDesignerFormEditorInterface object with the given parent.

actionEditor()¶

Return type:: QDesignerActionEditorInterface

Returns an interface to Qt Widgets Designer’s action editor.

See also

setActionEditor()

static createIcon(name)¶

Parameters:: name – str
Return type:: QIcon

extensionManager()¶

Return type:: QExtensionManager

Returns an interface to Qt Widgets Designer’s extension manager.

formWindowManager()¶

Return type:: QDesignerFormWindowManagerInterface

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

objectInspector()¶

Return type:: QDesignerObjectInspectorInterface

Returns an interface to Qt Widgets Designer’s object inspector.

See also

setObjectInspector()

pluginInstances()¶

Return type:: .list of QObject

propertyEditor()¶

Return type:: QDesignerPropertyEditorInterface

Returns an interface to Qt Widgets Designer’s property editor.

See also

setPropertyEditor()

resourceLocation()¶

Return type:: str

setActionEditor(actionEditor)¶

Parameters:: actionEditor – QDesignerActionEditorInterface

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

See also

actionEditor()

setExtensionManager(extensionManager)¶

Parameters:: extensionManager – QExtensionManager

setFormManager(formWindowManager)¶

Parameters:: formWindowManager – QDesignerFormWindowManagerInterface

setObjectInspector(objectInspector)¶

Parameters:: objectInspector – QDesignerObjectInspectorInterface

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

See also

objectInspector()

setPropertyEditor(propertyEditor)¶

Parameters:: propertyEditor – QDesignerPropertyEditorInterface

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

See also

propertyEditor()

setTopLevel(topLevel)¶

Parameters:: topLevel – QWidget

setWidgetBox(widgetBox)¶

Parameters:: widgetBox – QDesignerWidgetBoxInterface

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

See also

widgetBox()

topLevel()¶

Return type:: QWidget

Returns Qt Widgets Designer’s top-level widget.

widgetBox()¶

Return type:: QDesignerWidgetBoxInterface

Returns an interface to Qt Widgets Designer’s widget box.

See also

setWidgetBox()