QDesignerContainerExtension Class

Description détaillée

Qt Widgets Designer montrant l'option d'insertion d'une page avant la page actuelle dans un objet." src="images/containerextension-example.webp" title="Capture d'écran de l'éditeur d'interface utilisateur de Qt Widgets Designer montrant l'option d'insertion d'une page avant la page actuelle dans un objet."/>

QDesignerContainerExtension fournit une interface pour la création d'extensions de conteneurs personnalisées. Une extension de conteneur consiste en une collection de fonctions dont Qt Widgets Designer a besoin pour gérer un plugin de conteneur multi-pages, et une liste des pages du conteneur.

Pour créer une extension de conteneur, votre classe d'extension doit hériter à la fois de QObject et de QDesignerContainerExtension. Par exemple :

class MyContainerExtension : public QObject,
       public QDesignerContainerExtension
{
    Q_OBJECT
    Q_INTERFACES(QDesignerContainerExtension)

public:
    MyContainerExtension(MyCustomWidget *widget,
                         QObject *parent = 0);
    int count() const;
    QWidget *widget(int index) const;
    int currentIndex() const;
    void setCurrentIndex(int index);
    void addWidget(QWidget *widget);
    void insertWidget(int index, QWidget *widget);
    void remove(int index);

private:
    MyCustomWidget *myWidget;
};

Puisque nous mettons en œuvre 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.

Vous devez réimplémenter plusieurs fonctions pour permettre à Qt Widgets Designer de gérer un widget conteneur multi-pages personnalisé : Qt Widgets Designer utilise count() pour garder une trace du nombre de pages dans votre conteneur, widget() pour retourner la page à un index donné dans la liste des pages du conteneur, et currentIndex() pour retourner l'index de la liste de la page sélectionnée. Qt Widgets Designer utilise la fonction addWidget() pour ajouter une page donnée au conteneur, s'attendant à ce qu'elle soit ajoutée à la liste des pages, tandis qu'il s'attend à ce que la fonction insertWidget() ajoute une page donnée au conteneur en l'insérant à un index donné.

Dans Qt Widgets Designer, les extensions ne sont pas créées tant qu'elles ne sont pas nécessaires. C'est pourquoi vous devez également créer une classe QExtensionFactory, c'est-à-dire une classe capable de créer une instance de votre extension, et l'enregistrer à l'aide de la fonction extension manager de Qt Widgets Designer.

Lorsqu'une extension de conteneur est requise, Qt Widgets Designer's extension manager parcourt toutes les usines enregistrées en appelant QExtensionFactory::createExtension() pour chacune d'entre elles jusqu'à ce que la première usine capable de créer une extension de conteneur soit trouvée. Cette usine créera alors l'extension pour le plugin.

Il existe quatre types d'extensions disponibles sur Qt Widgets Designer: QDesignerContainerExtension , QDesignerMemberSheetExtension, QDesignerPropertySheetExtension et QDesignerTaskMenuExtension. Le comportement de Qt Widgets Designer est le même que l'extension demandée soit associée à un conteneur multipage, à une feuille de membre, à une feuille de propriété ou à un menu de tâches.

La classe QExtensionFactory fournit une fabrique d'extensions standard et peut également être utilisée comme interface pour des fabriques d'extensions personnalisées. Vous pouvez soit créer un nouveau QExtensionFactory et réimplémenter la fonction QExtensionFactory::createExtension(). Par exemple :

QObject *ANewExtensionFactory::createExtension(QObject *object,
        const QString &iid, QObject *parent) const
{
    if (iid != Q_TYPEID(QDesignerContainerExtension))
        return 0;

    if (MyCustomWidget *widget = qobject_cast<MyCustomWidget*>
           (object))
        return new MyContainerExtension(widget, parent);

    return 0;
}

Ou vous pouvez utiliser une fabrique existante, en étendant la fonction QExtensionFactory::createExtension() pour que la fabrique puisse également créer une extension de conteneur. Par exemple :

QObject *AGeneralExtensionFactory::createExtension(QObject *object,
        const QString &iid, QObject *parent) const
{
    MyCustomWidget *widget = qobject_cast<MyCustomWidget*>(object);

    if (widget && (iid == Q_TYPEID(QDesignerTaskMenuExtension))) {
        return new MyTaskMenuExtension(widget, parent);

    } else if (widget && (iid == Q_TYPEID(QDesignerContainerExtension))) {
        return new MyContainerExtension(widget, parent);

    } else {
        return 0;
    }
}

Pour un exemple complet utilisant la classe QDesignerContainerExtension, voir l'exemple Container Extension. L'exemple montre comment créer un plugin multi-pages personnalisé pour Qt Widgets Designer.