En esta página

QDesignerPropertySheetExtension Class

La clase `QDesignerPropertySheetExtension` permite manipular las propiedades de un widget que se muestra en el editor de propiedades de ` Qt Designer`. Más información...

Encabezado: #include <QDesignerPropertySheetExtension>
CMake: find_package(Qt6 REQUIRED COMPONENTS Designer)
target_link_libraries(mytarget PRIVATE Qt6::Designer)
qmake: QT += designer

Funciones públicas

QDesignerPropertySheetExtension()
QDesignerPropertySheetExtension(const QDesignerPropertySheetExtension &)
QDesignerPropertySheetExtension(QDesignerPropertySheetExtension &&)
virtual ~QDesignerPropertySheetExtension()
virtual int count() const = 0
virtual bool hasReset(int index) const = 0
virtual int indexOf(const QString &name) const = 0
virtual bool isAttribute(int index) const = 0
virtual bool isChanged(int index) const = 0
virtual bool isEnabled(int index) const = 0
virtual bool isVisible(int index) const = 0
virtual QVariant property(int index) const = 0
virtual QString propertyGroup(int index) const = 0
virtual QString propertyName(int index) const = 0
virtual bool reset(int index) = 0
virtual void setAttribute(int index, bool attribute) = 0
virtual void setChanged(int index, bool changed) = 0
virtual void setProperty(int index, const QVariant &value) = 0
virtual void setPropertyGroup(int index, const QString &group) = 0
virtual void setVisible(int index, bool visible) = 0
QDesignerPropertySheetExtension &operator=(QDesignerPropertySheetExtension &&)
QDesignerPropertySheetExtension &operator=(const QDesignerPropertySheetExtension &)

Descripción detallada

QDesignerPropertySheetExtension proporciona un conjunto de funciones que suelen utilizarse para consultar las propiedades de un widget y para manipular la apariencia de dichas 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;

Ten en cuenta que, si cambias el valor de una propiedad utilizando la función QDesignerPropertySheetExtension::setProperty(), la pila de deshacer no se actualiza. Para garantizar que el valor de una propiedad se pueda revertir mediante la pila de deshacer, debes utilizar en su lugar la función QDesignerFormWindowCursorInterface::setProperty() o su homóloga setWidgetProperty().

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, se puede recuperar consultando el gestor de extensiones de Qt Widgets Designer mediante la función qt_extension(). Cuando se desee liberar la extensión, solo hay que eliminar el puntero.

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

Ten en cuenta las siguientes limitaciones:

  • Qt Widgets Designer Qt Widgets Designer utiliza QDesignerPropertySheetExtension para alimentar su editor de propiedades. Cada vez que se selecciona un widget en su espacio de trabajo, consulta 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 predeterminada.
  • Los tipos de datos utilizados por la hoja de propiedades para algunas propiedades son tipos personalizados opacos de « QVariant » que contienen información adicional en lugar de los tipos de datos simples de Qt. Por ejemplo, este es el caso de las enumeraciones, los indicadores, los iconos, los mapas de píxeles y las cadenas.
  • Qt Widgets DesignerEl editor de propiedades de no dispone de una implementación para gestionar los tipos ` Q_PROPERTY ` en el caso de los tipos personalizados que se han declarado 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, dado que estamos implementando una interfaz, debemos asegurarnos de que el sistema de metaobjetos la reconozca utilizando la macro Q_INTERFACES():

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

public:
    ...
}

Esto permite que ` Qt Widgets Designer ` utilice ` qobject_cast()` para consultar las interfaces compatibles utilizando únicamente un puntero ` QObject `.

En Qt Widgets Designer, las extensiones no se crean hasta que son necesarias. Por ese motivo, al implementar una extensión de hoja de propiedades, también debes crear un ` QExtensionFactory`, es decir, una clase capaz de crear una instancia de tu extensión, y registrarla mediante el método ` extension manager` de ` Qt Widgets Designer`.

Cuando se necesita una extensión de hoja de propiedades, Qt Widgets Designer ejecutará extension manager, que recorrerá todas sus fábricas registradas llamando a QExtensionFactory::createExtension() para cada una de ellas hasta que encuentre la primera capaz de crear una extensión de hoja de propiedades para el widget seleccionado. A continuación, esta fábrica creará una instancia de la extensión. Si no se encuentra ninguna fábrica de este tipo, Qt Widgets Designer utilizará la hoja de propiedades predeterminada.

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 si la extensión solicitada está asociada a un contenedor de varias páginas, una hoja de miembros, 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. Puedes 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 bien, puede utilizar una fábrica existente, ampliando la función ` QExtensionFactory::createExtension()` para que la fábrica también pueda crear 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 ver un ejemplo completo que utilice una clase de extensión, consulta el ejemplo «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 del Qt Widgets Designer.

Véase también QDesignerDynamicPropertySheetExtension, QExtensionFactory, QExtensionManager y Creación de extensiones de widgets personalizadas.

Documentación de las funciones de miembro

[constexpr noexcept default] QDesignerPropertySheetExtension::QDesignerPropertySheetExtension()

Crea por defecto una instancia de ` QDesignerPropertySheetExtension`.

[delete] QDesignerPropertySheetExtension::QDesignerPropertySheetExtension(const QDesignerPropertySheetExtension &)

Crea una instancia de ` QDesignerPropertySheetExtension` mediante copia. Esta función se ha eliminado.

[delete] QDesignerPropertySheetExtension::QDesignerPropertySheetExtension(QDesignerPropertySheetExtension &&)

Crea una instancia de ` QDesignerPropertySheetExtension`. Esta función se ha eliminado.

[virtual constexpr noexcept default] QDesignerPropertySheetExtension::~QDesignerPropertySheetExtension()

Elimina la extensión de la hoja de propiedades.

[pure virtual] int QDesignerPropertySheetExtension::count() const

Devuelve el número de propiedades del widget seleccionado.

[pure virtual] bool QDesignerPropertySheetExtension::hasReset(int index) const

Devuelve «true» si la propiedad situada en la dirección index tiene un botón de restablecimiento en el editor de propiedades de Qt Widgets Designer; en caso contrario, devuelve «false».

Véase también indexOf() y reset().

[pure virtual] int QDesignerPropertySheetExtension::indexOf(const QString &name) const

Devuelve el índice de una propiedad determinada name.

Véase también propertyName().

[pure virtual] bool QDesignerPropertySheetExtension::isAttribute(int index) const

Devuelve «true» si la propiedad situada en la dirección index es un atributo, que se excluirá del archivo de interfaz de usuario; en caso contrario, devuelve «false».

Véase también indexOf() y setAttribute().

[pure virtual] bool QDesignerPropertySheetExtension::isChanged(int index) const

Devuelve «true» si el valor de la propiedad en la index indicada difiere del valor por defecto de la propiedad; en caso contrario, devuelve «false».

Véase también indexOf(), setChanged() y reset().

[pure virtual] bool QDesignerPropertySheetExtension::isEnabled(int index) const

Devuelve «true» si la propiedad situada en la dirección index está habilitada en el editor de propiedades de Qt Widgets Designer; en caso contrario, devuelve «false».

Véase también indexOf().

[pure virtual] bool QDesignerPropertySheetExtension::isVisible(int index) const

Devuelve «true» si la propiedad situada en la ruta index es visible en el editor de propiedades de Qt Widgets Designer; en caso contrario, devuelve «false».

Véase también indexOf() y setVisible().

[pure virtual] QVariant QDesignerPropertySheetExtension::property(int index) const

Devuelve el valor de la propiedad en la dirección index indicada.

Véase también indexOf(), setProperty() y propertyGroup().

[pure virtual] QString QDesignerPropertySheetExtension::propertyGroup(int index) const

Devuelve el grupo de propiedades correspondiente a la propiedad indicada en index.

Qt Widgets DesignerEl editor de propiedades de 's admite grupos de propiedades, es decir, secciones de propiedades relacionadas. Una propiedad puede vincularse a un grupo mediante la función setPropertyGroup(). El grupo predeterminado de cualquier propiedad es el nombre de la clase que la define. Por ejemplo, la propiedad QObject::objectName aparece dentro del grupo de propiedades QObject.

Véanse también indexOf() y setPropertyGroup().

[pure virtual] QString QDesignerPropertySheetExtension::propertyName(int index) const

Devuelve el nombre de la propiedad en la dirección index indicada.

Véase también indexOf().

[pure virtual] bool QDesignerPropertySheetExtension::reset(int index)

Restablece el valor de la propiedad indicada en index al valor por defecto. Devuelve «true» si se ha encontrado un valor por defecto; en caso contrario, devuelve «false».

Véase también indexOf(), hasReset() y isChanged().

[pure virtual] void QDesignerPropertySheetExtension::setAttribute(int index, bool attribute)

Si attribute es verdadero, la propiedad situada en la dirección index se convierte en un atributo que quedará excluido del archivo UI; en caso contrario, se incluirá.

Véase también indexOf() y isAttribute().

[pure virtual] void QDesignerPropertySheetExtension::setChanged(int index, bool changed)

Establece si la propiedad indicada en index es diferente de su valor por defecto o no, en función del parámetro changed.

Véanse también indexOf() y isChanged().

[pure virtual] void QDesignerPropertySheetExtension::setProperty(int index, const QVariant &value)

Establece el valor de la propiedad « value » en el valor indicado en « index ».

Advertencia: Si se modifica el valor de una propiedad mediante esta función, la pila de deshacer no se actualiza. Para garantizar que el valor de una propiedad se pueda revertir mediante la pila de deshacer, se debe utilizar la función QDesignerFormWindowCursorInterface::setProperty() o su función complementaria setWidgetProperty(), en su lugar.

Véase también indexOf(), property() y propertyGroup().

[pure virtual] void QDesignerPropertySheetExtension::setPropertyGroup(int index, const QString &group)

Establece el grupo de propiedades de la propiedad situada en la dirección index como group.

Al vincular una propiedad a un grupo, esta aparece dentro de la sección de dicho grupo en el editor de propiedades. El grupo de propiedades predeterminado de cualquier propiedad es el nombre de la clase que la define. Por ejemplo, la propiedad QObject::objectName aparece dentro del grupo de propiedades QObject.

Véanse también indexOf(), property() y propertyGroup().

[pure virtual] void QDesignerPropertySheetExtension::setVisible(int index, bool visible)

Si visible es verdadero, la propiedad situada en la dirección index es visible en el editor de propiedades de Qt Widgets Designer; en caso contrario, la propiedad está oculta.

Véase también indexOf() y isVisible().

[delete] QDesignerPropertySheetExtension &QDesignerPropertySheetExtension::operator=(QDesignerPropertySheetExtension &&)

Asigna mediante «Move» other a esta instancia de QDesignerPropertySheetExtension. Esta función se ha eliminado.

[delete] QDesignerPropertySheetExtension &QDesignerPropertySheetExtension::operator=(const QDesignerPropertySheetExtension &)

Asigna por copia other a esta instancia de QDesignerPropertySheetExtension. Esta función se ha eliminado.

© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.