QDesignerIntegrationInterface Class

The QDesignerIntegrationInterface glues together parts of Qt Designer and allows for overwriting functionality for IDE integration. More...

Header: #include <QDesignerIntegrationInterface>
Inherits: QObject
Inherited By:

QDesignerIntegration

Public Types

flags Feature
enum FeatureFlag { ResourceEditorFeature, SlotNavigationFeature, DefaultWidgetActionFeature, DefaultFeature }
enum ResourceFileWatcherBehaviour { NoResourceFileWatcher, ReloadResourceFileSilently, PromptToReloadResourceFile }

Properties

Public Functions

virtual QWidget *containerWindow(QWidget *widget) const = 0
virtual QDesignerResourceBrowserInterface *createResourceBrowser(QWidget *parent = 0) = 0
virtual QString headerSuffix() const = 0
virtual bool isHeaderLowercase() const = 0
virtual void setHeaderLowercase(bool headerLowerCase) = 0
virtual void setHeaderSuffix(const QString &headerSuffix) = 0

Public Slots

virtual void addDynamicProperty(const QString &name, const QVariant &value) = 0
virtual void removeDynamicProperty(const QString &name) = 0
virtual void resetProperty(const QString &name) = 0
virtual void setupFormWindow(QDesignerFormWindowInterface *formWindow) = 0
virtual void updateActiveFormWindow(QDesignerFormWindowInterface *formWindow) = 0
virtual void updateCustomWidgetPlugins() = 0
virtual void updateProperty(const QString &name, const QVariant &value, bool enableSubPropertyHandling) = 0
virtual void updateProperty(const QString &name, const QVariant &value) = 0
virtual void updateSelection() = 0

Detailed Description

\internal

\inmoduleQtDesigner

See also QDesignerFormEditorInterface.

Member Type Documentation

enum QDesignerIntegrationInterface::FeatureFlag
flags QDesignerIntegrationInterface::Feature

\internal

This enum describes the features that are available and can be controlled by the integration.

ConstantValueDescription
QDesignerIntegrationInterface::ResourceEditorFeature0x1The resource editor is enabled.
QDesignerIntegrationInterface::SlotNavigationFeature0x2Provide context menu entry offering 'Go to slot'.
QDesignerIntegrationInterface::DefaultWidgetActionFeature0x4Trigger the preferred action of QDesignerTaskMenuExtension when widget is activated.
QDesignerIntegrationInterface::DefaultFeatureResourceEditorFeature | DefaultWidgetActionFeatureDefault for Qt Designer

The Feature type is a typedef for QFlags<FeatureFlag>. It stores an OR combination of FeatureFlag values.

See also hasFeature() and features().

enum QDesignerIntegrationInterface::ResourceFileWatcherBehaviour

\internal

This enum describes if and how resource files are watched.

ConstantValueDescription
QDesignerIntegrationInterface::NoResourceFileWatcher0Do not watch for changes
QDesignerIntegrationInterface::ReloadResourceFileSilently1Reload files silently.
QDesignerIntegrationInterface::PromptToReloadResourceFile2Prompt the user to reload.

Property Documentation

headerLowercase : bool

Returns whether headers of promoted widgets should be lower-cased (as the user types the class name).

Access functions:

virtual bool isHeaderLowercase() const = 0
virtual void setHeaderLowercase(bool headerLowerCase) = 0

headerSuffix : QString

Returns the suffix of the header of promoted widgets.

Access functions:

virtual QString headerSuffix() const = 0
virtual void setHeaderSuffix(const QString &headerSuffix) = 0

Member Function Documentation

[pure virtual slot] void QDesignerIntegrationInterface::addDynamicProperty(const QString &name, const QVariant &value)

Triggered by the property editor to add a dynamic property value.

\internal

If a different property editor is used, it should invoke this function.

[pure virtual] QWidget *QDesignerIntegrationInterface::containerWindow(QWidget *widget) const

Returns the outer window containing a form for applying main container geometries.

\internal

Should be implemented by IDE integrations.

[pure virtual] QDesignerResourceBrowserInterface *QDesignerIntegrationInterface::createResourceBrowser(QWidget *parent = 0)

Creates a resource browser depending on IDE integration.

\internal

Note: Language integration takes precedence.

[pure virtual slot] void QDesignerIntegrationInterface::removeDynamicProperty(const QString &name)

Triggered by the property editor to remove a dynamic property.

\internal

If a different property editor is used, it should invoke this function.

[pure virtual slot] void QDesignerIntegrationInterface::resetProperty(const QString &name)

Triggered by the property editor to reset a property value.

\internal

If a different property editor is used, it should invoke this function.

[pure virtual slot] void QDesignerIntegrationInterface::setupFormWindow(QDesignerFormWindowInterface *formWindow)

Sets up the new form window.

\internal

[pure virtual slot] void QDesignerIntegrationInterface::updateActiveFormWindow(QDesignerFormWindowInterface *formWindow)

Sets up the active form window.

\internal

[pure virtual slot] void QDesignerIntegrationInterface::updateCustomWidgetPlugins()

Triggers a reload of the custom widget plugins.

\internal

[pure virtual slot] void QDesignerIntegrationInterface::updateProperty(const QString &name, const QVariant &value, bool enableSubPropertyHandling)

Triggered by the property editor to update a property value.

\internal

If a different property editor is used, it should invoke this function.

[pure virtual slot] void QDesignerIntegrationInterface::updateProperty(const QString &name, const QVariant &value)

Triggered by the property editor to update a property value without subproperty handling.

\internal

If a different property editor is used, it should invoke this function.

[pure virtual slot] void QDesignerIntegrationInterface::updateSelection()

Sets the selected widget of the form window in various components.

\internal

In IDE integrations, the method can be overwritten to move the selection handles of the form's main window, should it be selected.