QDesignerCustomWidgetInterface Class

詳細説明

QDesignerCustomWidgetInterfaceは、カスタムウィジェットにインターフェースを提供します。このクラスには、クラス名やヘッダー・ファイル名など、ウィジェットに関する基本情報を返すためにサブクラス化する必要がある一連の関数が含まれています。その他の関数は、プラグインがロードされたときに初期化し、Qt Widgets Designer が使用するカスタムウィジェットのインスタンスを構築するために実装する必要があります。

カスタムウィジェットを実装する場合は、QDesignerCustomWidgetInterface をサブクラス化して、ウィジェットをQt Widgets Designer に公開する必要があります。例えば、これはアナログ時計のカスタムウィジェットをQt Widgets Designer で使用できるようにするカスタムウィジェット・プラグインの例で使用したプラグインの宣言です：

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;
};

クラス定義のうち、この特定のカスタムウィジェットに固有なのはクラス名だけであることに注意してください。さらに、インターフェイスを実装しているので、Q_INTERFACES()マクロを使用して、メタ・オブジェクト・システムに確実に知らせる必要があります。これにより、Qt Widgets Designer は、qobject_cast() 関数を使用して、QObject ポインタだけを使用して、サポートされているインターフェイスを問い合わせることができます。

Qt Widgets Designer がカスタムウィジェットプラグインをロードした後、インターフェースのinitialize() 関数を呼び出して、必要なリソースをセットアップできるようにします。この関数は、QDesignerFormEditorInterface パラメータとともに呼び出され、Qt Widgets Designer のすべての API へのゲートウェイをプラグインに提供します。

Qt Widgets Designer は、適切な親ウィジェットでプラグインのcreateWidget() 関数を呼び出すことで、カスタムウィジェットのインスタンスを構築します。プラグインは、指定された親ウィジェットでカスタムウィジェットのインスタンスを構築して返す必要があります。

Q_PLUGIN_METADATA() マクロを使用して、カスタム・ウィジェット・プラグインをQt Widgets Designer にエクスポートします。たとえば、libcustomwidgetplugin.so (Unix) またはlibcustomwidget.dll (Windows) というライブラリにMyCustomWidget というウィジェット・クラスがある場合、プラグイン・ヘッダを含むファイルに次の行を追加することで、これをエクスポートできます：

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

このマクロは、Qt Widgets Designer がカスタムウィジェットにアクセスして構築できるようにします。このマクロがないと、Qt Widgets Designer は使用できません。

カスタムウィジェットプラグインを実装する場合、別のライブラリとして構築します。複数のカスタムウィジェットプラグインを同じライブラリに含める場合は、さらにQDesignerCustomWidgetCollectionInterface をサブクラス化する必要があります。

• 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

QDesignerCustomWidgetInterfaceクラスを使用した完全な例については、カスタムウィジェットの例を参照してください。この例では、Qt Widgets Designer のカスタムウィジェット・プラグインを作成する方法を示します。