QDesignerCustomWidgetInterface Class

Ausführliche Beschreibung

QDesignerCustomWidgetInterface stellt eine Schnittstelle für ein benutzerdefiniertes Widget bereit. Die Klasse enthält eine Reihe von Funktionen, die in Unterklassen implementiert werden müssen, um grundlegende Informationen über das Widget zurückzugeben, wie beispielsweise den Klassennamen und den Namen der Header-Datei. Weitere Funktionen müssen implementiert werden, um das Plugin beim Laden zu initialisieren und Instanzen des benutzerdefinierten Widgets für den „ Qt Widgets -Designer“ zu erstellen.

Bei der Implementierung eines benutzerdefinierten Widgets müssen Sie eine Unterklasse von `QDesignerCustomWidgetInterface` erstellen, um Ihr Widget für den „ Qt Widgets “-Designer verfügbar zu machen. Dies ist beispielsweise die Deklaration für das im Beispiel „Custom Widget Plugin“ verwendete Plugin, das die Verwendung eines benutzerdefinierten Analoguhr-Widgets im „ Qt Widgets “-Designer ermöglicht:

class AnalogClockPlugin : public QObject, public QDesignerCustomWidgetInterface
{
    Q_OBJECT
    Q_PLUGIN_METADATA(IID "org.qt-project.Qt.QDesignerCustomWidgetInterface")
    Q_INTERFACES(QDesignerCustomWidgetInterface)
public:
    explicit AnalogClockPlugin(QObject *parent = nullptr);

    bool isContainer() const override;
    bool isInitialized() const override;
    QIcon icon() const override;
    QString domXml() const override;
    QString group() const override;
    QString includeFile() const override;
    QString name() const override;
    QString toolTip() const override;
    QString whatsThis() const override;
    QWidget *createWidget(QWidget *parent) override;
    void initialize(QDesignerFormEditorInterface *core) override;

private:
    bool initialized = false;
};

Beachten Sie, dass der Klassenname der einzige Teil der Klassendefinition ist, der für dieses spezielle benutzerdefinierte Widget spezifisch ist. Da wir zudem eine Schnittstelle implementieren, müssen wir sicherstellen, dass diese dem Metaobjektsystem mithilfe des Makros ` Q_INTERFACES()` bekannt gemacht wird. Dadurch kann der „ Qt Widgets Designer“ die Funktion ` qobject_cast()` nutzen, um allein anhand eines ` QObject `-Zeigers nach unterstützten Schnittstellen abzufragen.

Nachdem der „ Qt Widgets “ Designer ein benutzerdefiniertes Widget-Plugin geladen hat, ruft er die Funktion „ initialize()“ der Schnittstelle auf, damit diese alle benötigten Ressourcen einrichten kann. Diese Funktion wird mit einem „ QDesignerFormEditorInterface “-Parameter aufgerufen, der dem Plugin einen Zugang zur gesamten API des „ Qt Widgets “ Designers bietet.

Qt Widgets Designer erstellt Instanzen des benutzerdefinierten Widgets, indem er die Funktion ` createWidget()` des Plugins mit einem geeigneten übergeordneten Widget aufruft. Plugins müssen eine Instanz eines benutzerdefinierten Widgets mit dem angegebenen übergeordneten Widget erstellen und zurückgeben.

Exportieren Sie Ihr benutzerdefiniertes Widget-Plugin mithilfe des Makros „ Q_PLUGIN_METADATA()“ in den „ Qt Widgets Designer“. Wenn beispielsweise eine Bibliothek namens „ libcustomwidgetplugin.so “ (unter Unix) oder „ libcustomwidget.dll “ (unter Windows) eine Widget-Klasse namens „ MyCustomWidget “ enthält, können wir diese exportieren, indem wir die folgende Zeile in die Datei mit dem Plugin-Header einfügen:

Q_PLUGIN_METADATA(IID "org.qt-project.Qt.QDesignerCustomWidgetInterface")

Dieses Makro stellt sicher, dass der „ Qt Widgets “-Designer auf das benutzerdefinierte Widget zugreifen und es erstellen kann. Ohne dieses Makro kann der „ Qt Widgets “-Designer das Widget nicht verwenden.

Bei der Implementierung eines benutzerdefinierten Widget-Plugins erstellen Sie dieses als separate Bibliothek. Wenn Sie mehrere benutzerdefinierte Widget-Plugins in derselben Bibliothek zusammenfassen möchten, müssen Sie zusätzlich eine Unterklasse von ` QDesignerCustomWidgetCollectionInterface` definieren.

• QVariant::ByteArray
• QVariant::Bool
• QVariant::Color
• QVariant::Cursor
• QVariant::Date
• QVariant::DateTime
• QVariant::Double
• QVariant::Int
• QVariant::Point
• QVariant::Rect
• QVariant::Size
• QVariant::SizePolicy
• QVariant::String
• QVariant::Time
• QVariant::UInt

Ein vollständiges Beispiel für die Verwendung der Klasse `QDesignerCustomWidgetInterface` finden Sie im Beispiel „Benutzerdefiniertes Widget“. Das Beispiel zeigt, wie Sie ein benutzerdefiniertes Widget-Plugin für den „ Qt Widgets -Designer“ erstellen.