QDesignerFormEditorInterface Class

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

Header: #include <QDesignerFormEditorInterface>
Inherits: QObject

Public Functions

QDesignerFormEditorInterface(QObject *parent = nullptr)
virtual ~QDesignerFormEditorInterface()
QDesignerActionEditorInterface *actionEditor() const
QDesignerDialogGuiInterface *dialogGui() const
QExtensionManager *extensionManager() const
QDesignerFormWindowManagerInterface *formWindowManager() const
QtGradientManager *gradientManager() const
QDesignerIntegrationInterface *integration() const
QDesignerIntrospectionInterface *introspection() const
QDesignerMetaDataBaseInterface *metaDataBase() const
QDesignerObjectInspectorInterface *objectInspector() const
QList<QDesignerOptionsPageInterface *> optionsPages() const
QObjectList pluginInstances() const
QDesignerPluginManager *pluginManager() const
QDesignerPromotionInterface *promotion() const
QDesignerPropertyEditorInterface *propertyEditor() const
QString resourceLocation() const
QtResourceModel *resourceModel() const
void setActionEditor(QDesignerActionEditorInterface *actionEditor)
void setDialogGui(QDesignerDialogGuiInterface *dialogGui)
void setGradientManager(QtGradientManager *gradientManager)
void setIntegration(QDesignerIntegrationInterface *integration)
void setIntrospection(QDesignerIntrospectionInterface *introspection)
void setObjectInspector(QDesignerObjectInspectorInterface *objectInspector)
void setOptionsPages(const QList<QDesignerOptionsPageInterface *> &optionsPages)
void setPluginManager(QDesignerPluginManager *pluginManager)
void setPropertyEditor(QDesignerPropertyEditorInterface *propertyEditor)
void setResourceModel(QtResourceModel *resourceModel)
void setSettingsManager(QDesignerSettingsInterface *settingsManager)
void setTopLevel(QWidget *topLevel)
void setWidgetBox(QDesignerWidgetBoxInterface *widgetBox)
QDesignerSettingsInterface *settingsManager() const
QWidget *topLevel() const
QDesignerWidgetBoxInterface *widgetBox() const
QDesignerWidgetDataBaseInterface *widgetDataBase() const
QDesignerWidgetFactoryInterface *widgetFactory() const

Static Public Members

QIcon createIcon(const QString &name)

Protected Functions

void setExtensionManager(QExtensionManager *extensionManager)
void setFormManager(QDesignerFormWindowManagerInterface *formWindowManager)
void setMetaDataBase(QDesignerMetaDataBaseInterface *metaDataBase)
void setPromotion(QDesignerPromotionInterface *promotion)
void setWidgetDataBase(QDesignerWidgetDataBaseInterface *widgetDataBase)
void setWidgetFactory(QDesignerWidgetFactoryInterface *widgetFactory)

Detailed Description

\inmoduleQtDesigner

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:

         auto *objectInspector = formEditor->objectInspector();
         auto *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 QDesignerCustomWidgetInterface::initialize() 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.

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 Designer's action editor.

See also setActionEditor().

[static] QIcon QDesignerFormEditorInterface::createIcon(const QString &name)

\internal

\since5.0

Return icons for actions of Qt Designer.

QDesignerDialogGuiInterface *QDesignerFormEditorInterface::dialogGui() const

\internal

Returns the dialog GUI used by the form editor.

See also setDialogGui().

QExtensionManager *QDesignerFormEditorInterface::extensionManager() const

Returns an interface to Qt Designer's extension manager.

See also setExtensionManager().

QDesignerFormWindowManagerInterface *QDesignerFormEditorInterface::formWindowManager() const

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

QtGradientManager *QDesignerFormEditorInterface::gradientManager() const

\internal\since 4.4 Returns the gradient manager used by the style sheet editor.

See also setGradientManager().

QDesignerIntegrationInterface *QDesignerFormEditorInterface::integration() const

\internal

Returns an interface to the integration.

See also setIntegration().

QDesignerIntrospectionInterface *QDesignerFormEditorInterface::introspection() const

\internal\since 4.4 Returns the introspection used by the form editor.

See also setIntrospection().

QDesignerMetaDataBaseInterface *QDesignerFormEditorInterface::metaDataBase() const

\internal

Returns an interface to the meta database used by the form editor.

See also setMetaDataBase().

QDesignerObjectInspectorInterface *QDesignerFormEditorInterface::objectInspector() const

Returns an interface to Qt Designer's object inspector.

See also setObjectInspector().

QList<QDesignerOptionsPageInterface *> QDesignerFormEditorInterface::optionsPages() const

\internal\since 4.5 Returns the list of options pages that allow the user to configure Qt Designer components.

See also setOptionsPages().

QObjectList QDesignerFormEditorInterface::pluginInstances() const

\internal

\since5.0

Returns the plugin instances of QDesignerPluginManager.

QDesignerPluginManager *QDesignerFormEditorInterface::pluginManager() const

\internal

Returns the plugin manager used by the form editor.

See also setPluginManager().

QDesignerPromotionInterface *QDesignerFormEditorInterface::promotion() const

\internal

Returns an interface to the designer promotion handler.

See also setPromotion().

QDesignerPropertyEditorInterface *QDesignerFormEditorInterface::propertyEditor() const

Returns an interface to Qt Designer's property editor.

See also setPropertyEditor().

QString QDesignerFormEditorInterface::resourceLocation() const

\internal

Returns the path to the resources used by the form editor.

QtResourceModel *QDesignerFormEditorInterface::resourceModel() const

\internal\since 4.4 Returns the resource model used by the form editor.

See also setResourceModel().

void QDesignerFormEditorInterface::setActionEditor(QDesignerActionEditorInterface *actionEditor)

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

See also actionEditor().

void QDesignerFormEditorInterface::setDialogGui(QDesignerDialogGuiInterface *dialogGui)

\internal

Sets the dialog GUI used by the form editor to the specified dialogGui.

See also dialogGui().

[protected] void QDesignerFormEditorInterface::setExtensionManager(QExtensionManager *extensionManager)

\internal

See also extensionManager().

[protected] void QDesignerFormEditorInterface::setFormManager(QDesignerFormWindowManagerInterface *formWindowManager)

\internal

void QDesignerFormEditorInterface::setGradientManager(QtGradientManager *gradientManager)

\internal

Sets the gradient manager used by the style sheet editor to the specified gradientManager.

See also gradientManager().

void QDesignerFormEditorInterface::setIntegration(QDesignerIntegrationInterface *integration)

\internal

See also integration().

void QDesignerFormEditorInterface::setIntrospection(QDesignerIntrospectionInterface *introspection)

\internal\since 4.4

Sets the introspection used by the form editor to the specified introspection.

See also introspection().

[protected] void QDesignerFormEditorInterface::setMetaDataBase(QDesignerMetaDataBaseInterface *metaDataBase)

\internal

See also metaDataBase().

void QDesignerFormEditorInterface::setObjectInspector(QDesignerObjectInspectorInterface *objectInspector)

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

See also objectInspector().

void QDesignerFormEditorInterface::setOptionsPages(const QList<QDesignerOptionsPageInterface *> &optionsPages)

\internal\since 4.5 Sets the list of options pages that allow the user to configure Qt Designer components.

See also optionsPages().

void QDesignerFormEditorInterface::setPluginManager(QDesignerPluginManager *pluginManager)

\internal

Sets the plugin manager used by the form editor to the specified pluginManager.

See also pluginManager().

[protected] void QDesignerFormEditorInterface::setPromotion(QDesignerPromotionInterface *promotion)

\internal

Sets the designer promotion handler.

See also promotion().

void QDesignerFormEditorInterface::setPropertyEditor(QDesignerPropertyEditorInterface *propertyEditor)

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

See also propertyEditor().

void QDesignerFormEditorInterface::setResourceModel(QtResourceModel *resourceModel)

\internal

Sets the resource model used by the form editor to the specified resourceModel.

See also resourceModel().

void QDesignerFormEditorInterface::setSettingsManager(QDesignerSettingsInterface *settingsManager)

\internal\since 4.5 Sets the settings manager used to store/retrieve the persistent settings of the components.

See also settingsManager().

void QDesignerFormEditorInterface::setTopLevel(QWidget *topLevel)

\internal

See also topLevel().

void QDesignerFormEditorInterface::setWidgetBox(QDesignerWidgetBoxInterface *widgetBox)

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

See also widgetBox().

[protected] void QDesignerFormEditorInterface::setWidgetDataBase(QDesignerWidgetDataBaseInterface *widgetDataBase)

\internal

See also widgetDataBase().

[protected] void QDesignerFormEditorInterface::setWidgetFactory(QDesignerWidgetFactoryInterface *widgetFactory)

\internal

See also widgetFactory().

QDesignerSettingsInterface *QDesignerFormEditorInterface::settingsManager() const

\internal\since 4.5 Returns the settings manager used by the components to store persistent settings.

QWidget *QDesignerFormEditorInterface::topLevel() const

Returns Qt Designer's top-level widget.

See also setTopLevel().

QDesignerWidgetBoxInterface *QDesignerFormEditorInterface::widgetBox() const

Returns an interface to Qt Designer's widget box.

See also setWidgetBox().

QDesignerWidgetDataBaseInterface *QDesignerFormEditorInterface::widgetDataBase() const

\internal

Returns an interface to the widget database used by the form editor.

See also setWidgetDataBase().

QDesignerWidgetFactoryInterface *QDesignerFormEditorInterface::widgetFactory() const

\internal

Returns an interface to the widget factory used by the form editor to create widgets for the form.

See also setWidgetFactory().