Accessible QML Type

Habilita la accesibilidad de los elementos QML. Más...

• Lista de todos los miembros, incluidos los heredados
• Accessible forma parte de Accessibility Classes.

Propiedades

• checkStateMixed : bool
• checkable : bool
• checked : bool
• defaultButton : bool
• description : string
• editable : bool
• focusable : bool
• focused : bool
• id : string
• ignored : bool
• labelFor : Item (since 6.10)
• labelledBy : Item (since 6.10)
• multiLine : bool
• name : string
• passwordEdit : bool
• pressed : bool
• readOnly : bool
• role : enumeration
• searchEdit : bool
• selectable : bool
• selectableText : bool
• selected : bool

Señales

• decreaseAction()
• increaseAction()
• nextPageAction()
• pressAction()
• previousPageAction()
• scrollDownAction()
• scrollLeftAction()
• scrollRightAction()
• scrollUpAction()
• toggleAction()

Métodos

• void announce(string message, AnnouncementPoliteness politeness) (since 6.8)

Descripción detallada

Esta clase forma parte de la Accesibilidad para aplicaciones Qt Quick .

Los elementos con los que interactúa el usuario o que le proporcionan información necesitan exponer su información al marco de accesibilidad. A continuación, las herramientas de asistencia pueden hacer uso de esa información para permitir a los usuarios interactuar con la aplicación de diversas maneras. Así, por ejemplo, las aplicaciones Qt Quick pueden utilizarse con lectores de pantalla.

Las propiedades más importantes son name, description y role.

Ejemplo de implementación de un botón sencillo:

Rectangle {
    id: myButton
    Text {
        id: label
        text: "next"
    }
    Accessible.role: Accessible.Button
    Accessible.name: label.text
    Accessible.description: "shows the next page"
    Accessible.onPressAction: {
        // do a button click
    }
}

role se establece en Button para indicar el tipo de control. name es la información más importante y está vinculada al texto del botón. El nombre es una descripción breve y concisa del control y debe reflejar la etiqueta visual. En este caso no está claro qué hace el botón sólo con el nombre, así que description contiene una explicación. También hay un manejador de señales Accessible.pressAction que puede ser invocado por las herramientas de asistencia para activar el botón. Este gestor de señales debe tener el mismo efecto que pulsar o hacer clic en el botón.

Véase también Accesibilidad.

Documentación de propiedades

checkStateMixed : bool

Esta propiedad indica si el elemento está parcialmente marcado.

Por defecto esta propiedad es false.

Véase también checked y checkable.

checkable : bool

Esta propiedad indica si este elemento se puede marcar (como una casilla de verificación o algunos botones).

Por defecto esta propiedad es false.

Véase también checked.

checked : bool

Esta propiedad indica si este elemento está actualmente marcado.

Por defecto esta propiedad es false.

Véase también checkable.

defaultButton : bool

Esta propiedad indica si este elemento es el botón por defecto de un diálogo.

Por defecto esta propiedad es false.

description : string

Esta propiedad establece una descripción accesible. Similar al nombre, describe el elemento. La descripción puede ser un poco más verbosa y decir lo que hace el elemento, por ejemplo la funcionalidad del botón que describe.

editable : bool

Esta propiedad indica si este elemento tiene texto editable.

Por defecto esta propiedad es false.

focusable : bool

Esta propiedad indica si este elemento es enfocable.

Por defecto, esta propiedad es false excepto para los elementos cuyo rol es uno de los siguientes: CheckBox, RadioButton, Switch, Button, MenuItem, PageTab, EditableText, SpinBox, ComboBox, Terminal o ScrollBar.

Véase también focused.

focused : bool

Esta propiedad indica si este elemento tiene actualmente el foco activo.

Por defecto, esta propiedad es false, pero devolverá true para elementos que tengan QQuickItem::hasActiveFocus() devolviendo true.

Véase también focusable.

id : string

Esta propiedad establece un identificador para el objeto. Puede utilizarse para proporcionar identificadores estables a las pruebas de interfaz de usuario. Por defecto, el identificador es el ID del objeto QML. Si no se establece el ID, se utiliza el valor predeterminado QAccessible::Identifier.

ignored : bool

Esta propiedad indica si este elemento debe ser ignorado por el marco de accesibilidad.

A veces un elemento forma parte de un grupo de elementos que deben tratarse como uno solo. Por ejemplo, dos etiquetas pueden estar visualmente situadas una al lado de la otra, pero son elementos separados. A efectos de accesibilidad, deben tratarse como uno solo y, por tanto, se representan mediante un tercer elemento invisible con la geometría adecuada.

Por ejemplo, un indicador de velocidad añade "m/s" como una etiqueta más pequeña:

Row {
    Label {
        id: speedLabel
        text: "Speed: 5"
        Accessible.ignored: true
    }
    Label {
        text: qsTr("m/s")
        Accessible.ignored: true
    }
    Accessible.role: Accessible.StaticText
    Accessible.name: speedLabel.text + " meters per second"
}

Por defecto esta propiedad es false.

labelFor : Item [since 6.10]

Esta propiedad contiene el objeto del que este elemento es una etiqueta.

Al establecer esta propiedad se establece automáticamente la relación labelledBy del otro objeto.

Por defecto esta propiedad es undefined.

Esta propiedad se introdujo en Qt 6.10.

labelledBy : Item [since 6.10]

Esta propiedad contiene el elemento que se utiliza como etiqueta para este elemento.

Al establecer esta propiedad se establece automáticamente la relación labelFor del otro objeto.

Por defecto esta propiedad es undefined.

Esta propiedad se introdujo en Qt 6.10.

multiLine : bool

Esta propiedad indica si este ítem tiene múltiples líneas de texto.

Por defecto esta propiedad es false.

name : string

Esta propiedad establece un nombre accesible. Para un botón, por ejemplo, debería estar vinculado a su texto. En general, esta propiedad debe tener un nombre simple y conciso pero legible. No incluya el tipo de control que desea representar sino sólo el nombre.

passwordEdit : bool

Esta propiedad indica si este elemento es una edición de texto con contraseña.

Por defecto esta propiedad es false.

pressed : bool

Esta propiedad indica si este elemento está pulsado (por ejemplo, un botón durante un clic del ratón).

Por defecto esta propiedad es false.

readOnly : bool

Esta propiedad indica que un campo de texto es de sólo lectura.

Es relevante cuando el rol es QAccessible::EditableText y se establece como de sólo lectura. Por defecto esta propiedad es false.

role : enumeration

Esta bandera establece el tipo semántico del widget. Un botón, por ejemplo, tendría "Button" como tipo. El valor debe ser uno de QAccessible::Role.

Algunas funciones tienen una semántica especial. Para implementar casillas de verificación, por ejemplo, se espera una propiedad "checked".

searchEdit : bool

Esta propiedad indica si este elemento es entrada para una consulta de búsqueda. Esta propiedad sólo afectará al texto editable.

Por defecto esta propiedad es false.

selectable : bool

Esta propiedad indica si este elemento puede ser seleccionado.

Por defecto esta propiedad es false.

Véase también selected.

selectableText : bool

Esta propiedad indica si este elemento contiene texto seleccionable.

Por defecto esta propiedad es false.

selected : bool

Esta propiedad indica si el elemento está seleccionado.

Por defecto esta propiedad es false.

Véase también selectable.

Documentación de señales

decreaseAction()

Esta señal se emite cuando se recibe una acción de disminución desde una herramienta de asistencia, como un lector de pantalla.

increaseAction()

Esta señal se emite cuando se recibe una acción de aumento de una herramienta de asistencia, como un lector de pantalla.

nextPageAction()

Esta señal se emite cuando se recibe una acción de página siguiente de una herramienta de asistencia, como un lector de pantalla.

pressAction()

Esta señal se emite cuando se recibe una acción de pulsación desde una herramienta de asistencia, como un lector de pantalla.

previousPageAction()

Esta señal se emite cuando se recibe una acción de página anterior de una herramienta de asistencia, como un lector de pantalla.

scrollDownAction()

Esta señal se emite cuando se recibe una acción de desplazamiento hacia abajo desde una herramienta de asistencia, como un lector de pantalla.

scrollLeftAction()

Esta señal se emite cuando se recibe una acción de desplazamiento hacia la izquierda desde una herramienta de asistencia, como un lector de pantalla.

scrollRightAction()

Esta señal se emite cuando se recibe una acción de desplazamiento a la derecha desde una herramienta de asistencia, como un lector de pantalla.

scrollUpAction()

Esta señal se emite cuando se recibe una acción de desplazamiento hacia arriba desde una herramienta de asistencia, como un lector de pantalla.

toggleAction()

Esta señal se emite cuando se recibe una acción de conmutación de una herramienta de asistencia, como un lector de pantalla.

Documentación del método

[since 6.8] void announce(string message, AnnouncementPoliteness politeness)

Emite un evento de anuncio con un message con cortesía politeness.

Este método se introdujo en Qt 6.8.

Véase también QAccessibleAnnouncementEvent.