QDesignerPropertySheetExtension Class

Description détaillée

QDesignerPropertySheetExtension fournit une collection de fonctions qui sont généralement utilisées pour interroger les propriétés d'un widget et pour manipuler l'apparence des propriétés dans l'éditeur de propriétés. A titre d'exemple :

QDesignerPropertySheetExtension *propertySheet = nullptr;
QExtensionManager manager = formEditor->extensionManager();

propertySheet = qt_extension<QDesignerPropertySheetExtension*>(manager, widget);
int index = propertySheet->indexOf(u"margin"_s);

propertySheet->setProperty(index, 10);
propertySheet->setChanged(index, true);

delete propertySheet;

Notez que si vous modifiez la valeur d'une propriété à l'aide de la fonction QDesignerPropertySheetExtension::setProperty(), la pile d'annulation n'est pas mise à jour. Pour vous assurer que la valeur d'une propriété peut être annulée à l'aide de la pile d'annulation, vous devez utiliser la fonction QDesignerFormWindowCursorInterface::setProperty(), ou son copain setWidgetProperty(), à la place.

Lors de l'implémentation d'un plugin de widget personnalisé, un pointeur sur l'objet QDesignerFormEditorInterface actuel de Qt Widgets Designer(formEditor dans l'exemple ci-dessus) est fourni par le paramètre de la fonction QDesignerCustomWidgetInterface::initialize().

La feuille de propriétés, ou toute autre extension, peut être récupérée en interrogeant le gestionnaire d'extensions de Qt Widgets Designer à l'aide de la fonction qt_extension(). Lorsque vous souhaitez libérer l'extension, il vous suffit de supprimer le pointeur.

Tous les widgets ont une feuille de propriétés par défaut qui remplit l'éditeur de propriétés de Qt Widgets Designer avec les propriétés du widget (c'est-à-dire celles définies avec la macro Q_PROPERTY()). Mais QDesignerPropertySheetExtension fournit également une interface pour créer des extensions de feuilles de propriétés personnalisées.

Gardez à l'esprit les limitations suivantes :

• Qt Widgets Designer QDesignerPropertySheetExtension utilise QDesignerPropertySheetExtension pour alimenter son éditeur de propriétés. Chaque fois qu'un widget est sélectionné dans son espace de travail, Qt Widgets Designer demande l'extension de la feuille de propriétés du widget. Si le widget sélectionné possède une extension de feuille de propriétés implémentée, cette extension remplacera la feuille de propriétés par défaut.
• Les types de données utilisés par la feuille de propriétés pour certaines propriétés sont des types personnalisés opaques QVariant contenant des informations supplémentaires au lieu de types de données Qt ordinaires. C'est le cas, par exemple, des énumérations, des drapeaux, des icônes, des pixmaps et des chaînes de caractères.
• Qt Widgets DesignerL'éditeur de propriétés de Qt n'a pas d'implémentation pour gérer les types Q_PROPERTY pour les types personnalisés qui ont été déclarés avec Q_DECLARE_METATYPE().

Pour créer une extension de feuille de propriétés, votre classe d'extension doit hériter à la fois de QObject et de QDesignerPropertySheetExtension. Ensuite, puisque 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() :

class MyPropertySheetExtension : public QObject,
        public QDesignerPropertySheetExtension
{
    Q_OBJECT
    Q_INTERFACES(QDesignerPropertySheetExtension)

public:
    ...
}

Cela permet à Qt Widgets Designer d'utiliser qobject_cast() pour rechercher les interfaces prises en charge en n'utilisant rien d'autre qu'un pointeur QObject.

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

Lorsqu'une extension de feuille de propriétés est requise, Qt Widgets Designer's extension manager passe en revue toutes les usines enregistrées en appelant QExtensionFactory::createExtension() pour chacune d'entre elles jusqu'à ce que la première capable de créer une extension de feuille de propriétés pour le widget sélectionné soit trouvée. Cette usine créera alors une instance de l'extension. Si aucune usine de ce type n'est trouvée, Qt Widgets Designer utilisera la feuille de propriétés par défaut.

Quatre types d'extensions sont disponibles dans Qt Widgets Designer: QDesignerContainerExtension, QDesignerMemberSheetExtension, QDesignerPropertySheetExtension et QDesignerTaskMenuExtension. Le comportement de Qt 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(QDesignerPropertySheetExtension))
        return 0;

    if (MyCustomWidget *widget = qobject_cast<MyCustomWidget*>
           (object))
        return new MyPropertySheetExtension(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 feuille de propriétés. 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(QDesignerPropertySheetExtension))) {
        return new MyPropertySheetExtension(widget, parent);

    } else {
        return 0;
    }
}

Pour un exemple complet utilisant une classe d'extension, voir l'exemple d'extension de menu de tâches. L'exemple montre comment créer un plugin de widget personnalisé pour Qt Designer et comment utiliser la classe QDesignerTaskMenuExtension pour ajouter des éléments personnalisés au menu des tâches de Qt Widgets Designer.