abstractintegration.h

Go to the documentation of this file.

// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
 
#ifndef ABSTRACTINTEGRATION_H
#define ABSTRACTINTEGRATION_H
 
#include <QtDesigner/sdk_global.h>
 
#include <QtCore/qobject.h>
#include <QtCore/qstringlist.h>
#include <QtCore/qflags.h>
#include <QtCore/qversionnumber.h>
 
#include <memory>
 
QT_BEGIN_NAMESPACE
 
class QDesignerFormWindowInterface;
class QDesignerFormEditorInterface;
class QDesignerIntegrationInterfacePrivate;
class QDesignerResourceBrowserInterface;
class QVariant;
class QWidget;
 
namespace qdesigner_internal {
class QDesignerIntegrationPrivate;
}
 
class QDESIGNER_SDK_EXPORT QDesignerIntegrationInterface: public QObject
{
    Q_OBJECT
    Q_PROPERTY(QString headerSuffix READ headerSuffix WRITE setHeaderSuffix)
    Q_PROPERTY(bool headerLowercase READ isHeaderLowercase WRITE setHeaderLowercase)
    Q_PROPERTY(QVersionNumber qtVersion READ qtVersion WRITE setQtVersion)
 
public:
    enum ResourceFileWatcherBehaviour
    {
        NoResourceFileWatcher,
        ReloadResourceFileSilently,
        PromptToReloadResourceFile // Default
    };
    Q_ENUM(ResourceFileWatcherBehaviour)
 
    enum FeatureFlag
    {
        ResourceEditorFeature = 0x1,
        SlotNavigationFeature = 0x2,
        DefaultWidgetActionFeature = 0x4,
        DefaultFeature = ResourceEditorFeature | DefaultWidgetActionFeature
    };
    Q_DECLARE_FLAGS(Feature, FeatureFlag)
 
    explicit QDesignerIntegrationInterface(QDesignerFormEditorInterface *core, QObject *parent = nullptr);
    ~QDesignerIntegrationInterface() override;
 
    QDesignerFormEditorInterface *core() const;
 
    virtual QWidget *containerWindow(QWidget *widget) const = 0;
 
    // Create a resource browser specific to integration. Language integration takes precedence
    virtual QDesignerResourceBrowserInterface *createResourceBrowser(QWidget *parent = nullptr) = 0;
    virtual QString headerSuffix() const = 0;
    virtual void setHeaderSuffix(const QString &headerSuffix) = 0;
 
    virtual bool isHeaderLowercase() const = 0;
    virtual void setHeaderLowercase(bool headerLowerCase) = 0;
 
    QVersionNumber qtVersion() const;
    void setQtVersion(const QVersionNumber &qtVersion);
 
    virtual Feature features() const = 0;
    bool hasFeature(Feature f) const;
 
    virtual ResourceFileWatcherBehaviour resourceFileWatcherBehaviour() const = 0;
    virtual void setResourceFileWatcherBehaviour(ResourceFileWatcherBehaviour behaviour) = 0;
 
    virtual QString contextHelpId() const = 0;
 
    void emitObjectNameChanged(QDesignerFormWindowInterface *formWindow, QObject *object,
                               const QString &newName, const QString &oldName);
    void emitNavigateToSlot(const QString &objectName, const QString &signalSignature, const QStringList &parameterNames);
    void emitNavigateToSlot(const QString &slotSignature);
    void emitHelpRequested(const QString &manual, const QString &document);
 
Q_SIGNALS:
    void propertyChanged(QDesignerFormWindowInterface *formWindow, const QString &name, const QVariant &value);
    void objectNameChanged(QDesignerFormWindowInterface *formWindow, QObject *object, const QString &newName, const QString &oldName);
    void helpRequested(const QString &manual, const QString &document);
 
    void navigateToSlot(const QString &objectName, const QString &signalSignature, const QStringList &parameterNames);
    void navigateToSlot(const QString &slotSignature);
 
public Q_SLOTS:
    virtual void setFeatures(Feature f) = 0;
    virtual void updateProperty(const QString &name, const QVariant &value, bool enableSubPropertyHandling) = 0;
    virtual void updateProperty(const QString &name, const QVariant &value) = 0;
    // Additional signals of designer property editor
    virtual void resetProperty(const QString &name) = 0;
    virtual void addDynamicProperty(const QString &name, const QVariant &value) = 0;
    virtual void removeDynamicProperty(const QString &name) = 0;
 
    virtual void updateActiveFormWindow(QDesignerFormWindowInterface *formWindow) = 0;
    virtual void setupFormWindow(QDesignerFormWindowInterface *formWindow) = 0;
    virtual void updateSelection() = 0;
    virtual void updateCustomWidgetPlugins() = 0;
 
private:
    std::unique_ptr<QDesignerIntegrationInterfacePrivate> d;
};
 
class QDESIGNER_SDK_EXPORT QDesignerIntegration: public QDesignerIntegrationInterface
{
    Q_OBJECT
public:
    explicit QDesignerIntegration(QDesignerFormEditorInterface *core, QObject *parent = nullptr);
    ~QDesignerIntegration() override;
 
    QString headerSuffix() const override;
    void setHeaderSuffix(const QString &headerSuffix) override;
 
    bool isHeaderLowercase() const override;
    void setHeaderLowercase(bool headerLowerCase) override;
 
    Feature features() const override;
    void setFeatures(Feature f) override;
 
    ResourceFileWatcherBehaviour resourceFileWatcherBehaviour() const override;
    void setResourceFileWatcherBehaviour(ResourceFileWatcherBehaviour behaviour) override;
 
    QWidget *containerWindow(QWidget *widget) const override;
 
    // Load plugins into widget database and factory.
    static void initializePlugins(QDesignerFormEditorInterface *formEditor);
 
    // Create a resource browser specific to integration. Language integration takes precedence
    QDesignerResourceBrowserInterface *createResourceBrowser(QWidget *parent = nullptr) override;
 
    QString contextHelpId() const override;
 
    void updateProperty(const QString &name, const QVariant &value, bool enableSubPropertyHandling) override;
    void updateProperty(const QString &name, const QVariant &value) override;
    // Additional signals of designer property editor
    void resetProperty(const QString &name) override;
    void addDynamicProperty(const QString &name, const QVariant &value) override;
    void removeDynamicProperty(const QString &name) override;
 
    void updateActiveFormWindow(QDesignerFormWindowInterface *formWindow) override;
    void setupFormWindow(QDesignerFormWindowInterface *formWindow) override;
    void updateSelection() override;
    void updateCustomWidgetPlugins() override;
 
private:
    std::unique_ptr<qdesigner_internal::QDesignerIntegrationPrivate> d;
};
 
QT_END_NAMESPACE
 
#endif // ABSTRACTINTEGRATION_H