QDesignerFormEditorInterface Class

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

Header: #include <QDesignerFormEditorInterface>
CMake: find_package(Qt6 REQUIRED COMPONENTS Designer)
target_link_libraries(mytarget PRIVATE Qt6::Designer)
qmake: QT += designer
Inherits: QObject

Public Functions

QDesignerFormEditorInterface(QObject *parent = nullptr)
virtual ~QDesignerFormEditorInterface()
QDesignerActionEditorInterface *actionEditor() const
QExtensionManager *extensionManager() const
QDesignerFormWindowManagerInterface *formWindowManager() const
QDesignerObjectInspectorInterface *objectInspector() const
QDesignerPropertyEditorInterface *propertyEditor() const
void setActionEditor(QDesignerActionEditorInterface *actionEditor)
void setObjectInspector(QDesignerObjectInspectorInterface *objectInspector)
void setPropertyEditor(QDesignerPropertyEditorInterface *propertyEditor)
void setWidgetBox(QDesignerWidgetBoxInterface *widgetBox)
QWidget *topLevel() const
QDesignerWidgetBoxInterface *widgetBox() const

Detailed Description

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:

        auto *objectInspector = formEditor->objectInspector();
        auto *manager = formEditor->formWindowManager();


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 QDesignerCustomWidgetInterface::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.

Member Function Documentation

[explicit] QDesignerFormEditorInterface::QDesignerFormEditorInterface(QObject *parent = nullptr)

Constructs a QDesignerFormEditorInterface object with the given parent.

[virtual noexcept] QDesignerFormEditorInterface::~QDesignerFormEditorInterface()

Destroys the QDesignerFormEditorInterface object.

QDesignerActionEditorInterface *QDesignerFormEditorInterface::actionEditor() const

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

See also setActionEditor().

QExtensionManager *QDesignerFormEditorInterface::extensionManager() const

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

QDesignerFormWindowManagerInterface *QDesignerFormEditorInterface::formWindowManager() const

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

QDesignerObjectInspectorInterface *QDesignerFormEditorInterface::objectInspector() const

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

See also setObjectInspector().

QDesignerPropertyEditorInterface *QDesignerFormEditorInterface::propertyEditor() const

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

See also setPropertyEditor().

void QDesignerFormEditorInterface::setActionEditor(QDesignerActionEditorInterface *actionEditor)

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

See also actionEditor().

void QDesignerFormEditorInterface::setObjectInspector(QDesignerObjectInspectorInterface *objectInspector)

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

See also objectInspector().

void QDesignerFormEditorInterface::setPropertyEditor(QDesignerPropertyEditorInterface *propertyEditor)

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

See also propertyEditor().

void QDesignerFormEditorInterface::setWidgetBox(QDesignerWidgetBoxInterface *widgetBox)

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

See also widgetBox().

QWidget *QDesignerFormEditorInterface::topLevel() const

Returns Qt Widgets Designer's top-level widget.

QDesignerWidgetBoxInterface *QDesignerFormEditorInterface::widgetBox() const

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

See also setWidgetBox().

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.