QDesignerPropertySheetExtension Class

Descripción detallada

QDesignerPropertySheetExtension proporciona una colección de funciones que se utilizan normalmente para consultar las propiedades de un widget, y para manipular la apariencia de las propiedades en el editor de propiedades. Por ejemplo:

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;

Tenga en cuenta que si cambia el valor de una propiedad utilizando la función QDesignerPropertySheetExtension::setProperty(), la pila de deshacer no se actualiza. Para asegurarse de que el valor de una propiedad puede ser revertido utilizando la pila de deshacer, debe utilizar la función QDesignerFormWindowCursorInterface::setProperty(), o su compañera setWidgetProperty(), en su lugar.

Al implementar un complemento de widget personalizado, el parámetro de la función QDesignerCustomWidgetInterface::initialize() proporciona un puntero al objeto QDesignerFormEditorInterface actual de Qt Widgets Designer (formEditor en el ejemplo anterior).

La hoja de propiedades, o cualquier otra extensión, puede recuperarse consultando el gestor de extensiones de Qt Widgets Designer mediante la función qt_extension(). Cuando quieras liberar la extensión, sólo tienes que borrar el puntero.

Todos los widgets tienen una hoja de propiedades por defecto que rellena el editor de propiedades de Qt Widgets Designer con las propiedades del widget (es decir, las definidas con la macro Q_PROPERTY()). Pero QDesignerPropertySheetExtension también proporciona una interfaz para crear extensiones de hojas de propiedades personalizadas.

Ten en cuenta las siguientes limitaciones:

• Qt Widgets Designer utiliza QDesignerPropertySheetExtension para alimentar su editor de propiedades. Siempre que se seleccione un widget en su área de trabajo, Qt Widgets Designer consultará la extensión de la hoja de propiedades del widget. Si el widget seleccionado tiene una extensión de hoja de propiedades implementada, esta extensión sustituirá a la hoja de propiedades por defecto.
• Los tipos de datos utilizados por la hoja de propiedades para algunas propiedades son tipos opacos personalizados de QVariant que contienen información adicional en lugar de tipos de datos Qt simples. Por ejemplo, este es el caso de las enumeraciones, banderas, iconos, pixmaps y cadenas.
• Qt Widgets El editor de propiedades de Designer no tiene ninguna implementación para manejar tipos Q_PROPERTY para tipos personalizados que han sido declarados con Q_DECLARE_METATYPE().

Para crear una extensión de hoja de propiedades, tu clase de extensión debe heredar tanto de QObject como de QDesignerPropertySheetExtension. A continuación, puesto que estamos implementando una interfaz, debemos asegurarnos de que se da a conocer al meta sistema de objetos mediante la macro Q_INTERFACES():

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

public:
    ...
}

Esto permite a Qt Widgets Designer utilizar qobject_cast() para consultar las interfaces soportadas utilizando únicamente un puntero QObject.

En Qt Widgets Designer las extensiones no se crean hasta que son necesarias. Por este motivo, al implementar una extensión de hoja de propiedades, también debe crear una QExtensionFactory, es decir, una clase que sea capaz de crear una instancia de su extensión, y registrarla utilizando extension manager de Qt Widgets Designer.

Cuando se necesite una extensión de hoja de propiedades, Qt Widgets Designer's extension manager recorrerá todas las fábricas registradas llamando a QExtensionFactory::createExtension() para cada una de ellas hasta que encuentre la primera que pueda crear una extensión de hoja de propiedades para el widget seleccionado. Esta fábrica creará una instancia de la extensión. Si no se encuentra ninguna, Qt Widgets Designer utilizará la hoja de propiedades por defecto.

Hay cuatro tipos de extensiones disponibles en Qt Widgets Designer: QDesignerContainerExtension QDesignerMemberSheetExtension , QDesignerPropertySheetExtension y QDesignerTaskMenuExtension. El comportamiento de Qt Designer es el mismo independientemente de que la extensión solicitada esté asociada a un contenedor multipágina, una hoja de propiedades o un menú de tareas.

La clase QExtensionFactory proporciona una fábrica de extensiones estándar y también puede utilizarse como interfaz para fábricas de extensiones personalizadas. Puede crear un nuevo QExtensionFactory y reimplementar la función QExtensionFactory::createExtension(). por ejemplo:

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

O puede utilizar una fábrica existente, ampliando la función QExtensionFactory::createExtension() para que la fábrica pueda crear también una extensión de hoja de propiedades. Por ejemplo:

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

Para un ejemplo completo usando una clase de extensión, vea el ejemplo de Extensión del Menú de Tareas. El ejemplo muestra cómo crear un complemento de widget personalizado para Qt Designer, y cómo utilizar la clase QDesignerTaskMenuExtension para añadir elementos personalizados al menú de tareas de Qt Widgets Designer.