Accessible QML Type (Uncreatable)

Aktiviert die Barrierefreiheit von QML-Elementen. Mehr...

Hinweis: Dies ist ein nicht erstellbarer Typ. Er kann in QML nicht instanziiert werden.

• Liste aller Mitglieder, einschließlich geerbter Mitglieder
• „Accessible“ ist Teil der Barrierefreiheitsklassen.

Eigenschaften

• checkStateMixed : bool
• checkable : bool
• checked : bool
• defaultButton : bool
• description : string
• editable : bool
• expandable : bool (since 6.12)
• expanded : bool (since 6.12)
• 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

Signale

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

Methoden

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

Ausführliche Beschreibung

Diese Klasse ist Teil des Barrierefreiheits-Frameworks für „ Qt Quick “-Anwendungen.

Elemente, mit denen der Benutzer interagiert oder die dem Benutzer Informationen liefern, müssen ihre Informationen dem Barrierefreiheits-Framework zur Verfügung stellen. Dann können Hilfsmittel diese Informationen nutzen, um Benutzern die Interaktion mit der Anwendung auf verschiedene Weise zu ermöglichen. Dadurch können beispielsweise „ Qt Quick “-Anwendungen mit Bildschirmleseprogrammen genutzt werden.

Die wichtigsten Eigenschaften sind „ name “, „ description “ und „ role “.

Beispiel für die Implementierung einer einfachen Schaltfläche:

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

Die Eigenschaft „ role “ wird auf „ Button “ gesetzt, um den Typ des Steuerelements anzugeben. „ name “ ist die wichtigste Information und ist an den Text auf der Schaltfläche gebunden. Der Name ist eine kurze und prägnante Beschreibung des Steuerelements und sollte die visuelle Beschriftung widerspiegeln. In diesem Fall ist allein anhand des Namens nicht klar, welche Funktion die Schaltfläche hat, daher enthält „ description “ eine Erläuterung. Außerdem gibt es einen Signal-Handler „ Accessible.pressAction “, der von Hilfsmitteln aufgerufen werden kann, um die Schaltfläche auszulösen. Dieser Signal-Handler muss denselben Effekt haben wie das Antippen oder Anklicken der Schaltfläche.

Siehe auch Barrierefreiheit.

Dokumentation zu Eigenschaften

checkStateMixed : bool

Diese Eigenschaft gibt an, ob sich dieses Element im teilweise markierten Zustand befindet.

Standardmäßig ist diese Eigenschaft auf „ false “ gesetzt.

Siehe auch „ checked “ und „ checkable “.

checkable : bool

Diese Eigenschaft gibt an, ob dieses Element aktivierbar ist (wie ein Kontrollkästchen oder bestimmte Schaltflächen).

Standardmäßig ist diese Eigenschaft auf „ false “ gesetzt.

Siehe auch „ checked “.

checked : bool

Diese Eigenschaft gibt an, ob dieses Element derzeit markiert ist.

Standardmäßig lautet diese Eigenschaft „ false “.

Siehe auch „ checkable “.

defaultButton : bool

Diese Eigenschaft gibt an, ob dieses Element die Standardschaltfläche eines Dialogfelds ist.

Standardmäßig ist diese Eigenschaft auf „ false “ gesetzt.

description : string

Diese Eigenschaft legt eine barrierefreie Beschreibung fest. Ähnlich wie der Name beschreibt sie das Element. Die Beschreibung kann etwas ausführlicher sein und erläutern, was das Element bewirkt, beispielsweise die Funktionalität der Schaltfläche, die sie beschreibt.

editable : bool

Diese Eigenschaft gibt an, ob der Text dieses Elements bearbeitbar ist.

Standardmäßig ist diese Eigenschaft auf „ false “ gesetzt.

expandable : bool [since 6.12]

Diese Eigenschaft gibt an, ob dieses Element erweiterbar ist.

Standardmäßig ist diese Eigenschaft auf „ false “ gesetzt.

Diese Eigenschaft wurde in Qt 6.12 eingeführt.

Siehe auch „ expanded “.

expanded : bool [since 6.12]

Diese Eigenschaft gibt an, ob dieses Element derzeit erweitert ist.

Standardmäßig ist diese Eigenschaft auf „ false “ gesetzt.

Diese Eigenschaft wurde in Qt 6.12 eingeführt.

Siehe auch „ expandable “.

focusable : bool

Diese Eigenschaft gibt an, ob dieses Element den Fokus erhalten kann.

Standardmäßig ist diese Eigenschaft auf „ false “ gesetzt, außer bei Elementen, deren Rolle eine der folgenden ist: „ CheckBox “, „ RadioButton “, „ Switch “, „ Button “, „ MenuItem “, „ PageTab “, „ EditableText “, „ SpinBox “, „ ComboBox “, „ Terminal “ oder „ ScrollBar “.

Siehe auch focused.

focused : bool

Diese Eigenschaft gibt an, ob dieses Element derzeit den Fokus hat.

Standardmäßig ist diese Eigenschaft auf „ false “ gesetzt, gibt jedoch „ true “ für Elemente zurück, bei denen die Methode „ QQuickItem::hasActiveFocus()“ den Wert „ true “ zurückgibt.

Siehe auch „ focusable “.

id : string

Diese Eigenschaft legt eine Kennung für das Objekt fest. Sie kann verwendet werden, um UI-Tests stabile Kennungen zur Verfügung zu stellen. Standardmäßig wird die Kennung auf die ID des QML-Objekts gesetzt. Ist die ID nicht festgelegt, wird der Standardwert „ QAccessible::Identifier “ verwendet.

ignored : bool

Diese Eigenschaft legt fest, ob dieses Element vom Barrierefreiheits-Framework ignoriert werden soll.

Manchmal ist ein Element Teil einer Gruppe von Elementen, die als Einheit behandelt werden sollen. Beispielsweise können zwei Beschriftungen visuell nebeneinander platziert sein, aber separate Elemente darstellen. Aus Gründen der Barrierefreiheit sollten sie als Einheit behandelt werden und werden daher durch ein drittes, unsichtbares Element mit der entsprechenden Geometrie dargestellt.

Beispielsweise fügt eine Geschwindigkeitsanzeige „m/s“ als kleinere Beschriftung hinzu:

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

Standardmäßig ist diese Eigenschaft auf „ false “ gesetzt.

labelFor : Item [since 6.10]

Diese Eigenschaft enthält das Element, für das dieses Element als Bezeichnung dient.

Durch das Festlegen dieser Eigenschaft wird automatisch die Beziehung „ labelledBy “ des anderen Objekts eingerichtet.

Standardmäßig ist diese Eigenschaft auf „ undefined “ gesetzt.

Diese Eigenschaft wurde in Qt 6.10 eingeführt.

labelledBy : Item [since 6.10]

Diese Eigenschaft enthält das Element, das als Bezeichnung für dieses Element verwendet wird.

Durch das Festlegen dieser Eigenschaft wird automatisch die Beziehung „ labelFor “ des anderen Objekts eingerichtet.

Standardmäßig ist diese Eigenschaft auf „ undefined “ gesetzt.

Diese Eigenschaft wurde in Qt 6.10 eingeführt.

multiLine : bool

Diese Eigenschaft gibt an, ob dieses Element mehrere Textzeilen enthält.

Standardmäßig ist diese Eigenschaft auf „ false “ gesetzt.

name : string

Diese Eigenschaft legt einen barrierefreien Namen fest. Bei einer Schaltfläche sollte dieser beispielsweise mit dem Text der Schaltfläche verknüpft sein. Im Allgemeinen sollte diese Eigenschaft auf einen einfachen und prägnanten, aber für Menschen lesbaren Namen gesetzt werden. Geben Sie dabei nicht den Typ des Steuerelements an, das Sie darstellen möchten, sondern lediglich den Namen.

passwordEdit : bool

Diese Eigenschaft gibt an, ob es sich bei diesem Element um ein Textfeld für Passwörter handelt.

Standardmäßig lautet diese Eigenschaft „ false “.

pressed : bool

Diese Eigenschaft gibt an, ob dieses Element gedrückt ist (beispielsweise eine Schaltfläche bei einem Mausklick).

Standardmäßig ist diese Eigenschaft auf „ false “ gesetzt.

readOnly : bool

Diese Eigenschaft gibt an, dass ein Textfeld schreibgeschützt ist.

Dies ist relevant, wenn die Rolle „ QAccessible::EditableText “ ist und auf „schreibgeschützt“ gesetzt ist. Standardmäßig lautet diese Eigenschaft „ false “.

role : enumeration

Dieses Flag legt den semantischen Typ des Widgets fest. Ein Button hätte beispielsweise den Typ „Button“. Der Wert muss einer der folgenden sein: „ QAccessible::Role “.

Einige Rollen weisen eine spezielle Semantik auf. Um beispielsweise Kontrollkästchen zu implementieren, wird eine Eigenschaft „checked“ erwartet.

searchEdit : bool

Diese Eigenschaft gibt an, ob dieses Element als Eingabe für eine Suchanfrage dient. Diese Eigenschaft wirkt sich nur auf bearbeitbaren Text aus.

Standardmäßig ist diese Eigenschaft auf „ false “ gesetzt.

selectable : bool

Diese Eigenschaft gibt an, ob dieses Element ausgewählt werden kann.

Standardmäßig ist diese Eigenschaft auf „ false “ gesetzt.

Siehe auch „ selected “.

selectableText : bool

Diese Eigenschaft gibt an, ob dieses Element auswählbaren Text enthält.

Standardmäßig ist diese Eigenschaft auf „ false “ gesetzt.

selected : bool

Diese Eigenschaft gibt an, ob dieses Element ausgewählt ist.

Standardmäßig ist diese Eigenschaft auf „ false “ gesetzt.

Siehe auch „ selectable “.

Signal-Dokumentation

decreaseAction()

Dieses Signal wird ausgegeben, wenn eine Verkleinerungsaktion von einem Hilfsmittel wie beispielsweise einem Screenreader empfangen wird.

increaseAction()

Dieses Signal wird ausgegeben, wenn eine Vergrößerungsaktion von einem Hilfsmittel wie beispielsweise einem Screenreader empfangen wird.

nextPageAction()

Dieses Signal wird ausgegeben, wenn von einem Hilfsmittel wie beispielsweise einem Screenreader eine Aktion zum Blättern zur nächsten Seite empfangen wird.

pressAction()

Dieses Signal wird ausgegeben, wenn eine Druckaktion von einem Hilfsmittel wie beispielsweise einem Screenreader empfangen wird.

previousPageAction()

Dieses Signal wird ausgegeben, wenn eine vorherige Seitenaktion von einem Hilfsmittel wie einem Screenreader empfangen wird.

scrollDownAction()

Dieses Signal wird ausgelöst, wenn eine Bildlauf-nach-unten-Aktion von einem Hilfsmittel wie beispielsweise einem Screenreader empfangen wird.

scrollLeftAction()

Dieses Signal wird ausgesendet, wenn eine Aktion zum Scrollen nach links von einem Hilfsmittel wie beispielsweise einem Screenreader empfangen wird.

scrollRightAction()

Dieses Signal wird ausgelöst, wenn eine Aktion zum Scrollen nach rechts von einem Hilfsmittel wie beispielsweise einem Screenreader empfangen wird.

scrollUpAction()

Dieses Signal wird ausgelöst, wenn eine Aufwärts-Scroll-Aktion von einem Hilfsmittel wie beispielsweise einem Screenreader empfangen wird.

showOnScreenAction()

Dieses Signal wird ausgesendet, wenn ein Hilfsmittel wie beispielsweise ein Screenreader ein teilweise sichtbares Element erkennt und fordert, dass es vollständig sichtbar gemacht wird.

toggleAction()

Dieses Signal wird ausgegeben, wenn eine Umschaltaktion von einem Hilfsmittel wie beispielsweise einem Screenreader empfangen wird.

Methodendokumentation

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

Löst ein Ankündigungsereignis mit dem „ message “ und der Höflichkeitsstufe „ politeness “ aus.

Diese Methode wurde in Qt 6.8 eingeführt.

Siehe auch QAccessibleAnnouncementEvent.