QDesignerCustomWidgetInterface Class

Description détaillée

QDesignerCustomWidgetInterface fournit une interface pour un widget personnalisé. La classe contient un ensemble de fonctions qui doivent être sous-classées pour renvoyer des informations de base sur le widget, telles que le nom de sa classe et le nom de son fichier d'en-tête. D'autres fonctions doivent être mises en œuvre pour initialiser le plugin lorsqu'il est chargé et pour construire des instances du widget personnalisé à utiliser par Qt Widgets Designer.

Lorsque vous mettez en œuvre un widget personnalisé, vous devez sous-classer QDesignerCustomWidgetInterface pour exposer votre widget à Qt Widgets Designer. Par exemple, voici la déclaration du plugin utilisé dans l'exemple du plugin de widget personnalisé qui permet à un widget personnalisé d'horloge analogique d'être utilisé par 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;
};

Notez que la seule partie de la définition de la classe qui est spécifique à ce widget personnalisé particulier est le nom de la classe. De plus, comme nous implémentons une interface, nous devons nous assurer qu'elle est connue du système de métaobjets à l'aide de la macro Q_INTERFACES(). Cela permet à Qt Widgets Designer d'utiliser la fonction qobject_cast() pour rechercher les interfaces prises en charge en n'utilisant rien d'autre qu'un pointeur QObject.

Une fois que Qt Widgets Designer a chargé un plugin de widget personnalisé, il appelle la fonction initialize() de l'interface pour lui permettre de mettre en place toutes les ressources dont il peut avoir besoin. Cette fonction est appelée avec un paramètre QDesignerFormEditorInterface qui fournit au plugin une passerelle vers l'ensemble de l'API de Qt Widgets Designer.

Qt Widgets Designer construit des instances du widget personnalisé en appelant la fonction createWidget() du plugin avec un widget parent approprié. Les plugins doivent construire et renvoyer une instance de widget personnalisé avec le widget parent spécifié.

Exporter votre plugin de widget personnalisé vers Qt Widgets Designer à l'aide de la macro Q_PLUGIN_METADATA(). Par exemple, si une bibliothèque appelée libcustomwidgetplugin.so (sous Unix) ou libcustomwidget.dll (sous Windows) contient une classe de widget appelée MyCustomWidget, nous pouvons l'exporter en ajoutant la ligne suivante au fichier contenant l'en-tête du plugin :

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

Cette macro garantit que Qt Widgets Designer peut accéder au widget personnalisé et le construire. Sans cette macro, Qt Widgets Designer ne peut pas l'utiliser.

Lorsque vous mettez en œuvre un plugin de widget personnalisé, vous le construisez comme une bibliothèque distincte. Si vous souhaitez inclure plusieurs plugins de widgets personnalisés dans la même bibliothèque, vous devez en outre sous-classer 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

Pour un exemple complet utilisant la classe QDesignerCustomWidgetInterface, voir l'exemple de widget personnalisé. L'exemple montre comment créer un plugin de widget personnalisé pour Qt Widgets Designer.