Accessibility QML Type

(BETA) Provides access to accessibility options provided by the operating system. More...

• List of all members, including inherited members

Properties

• boldText : BoldTextStatus
• highContrast : HighContrastStatus
• textScale : var
• voiceOver : VoiceOverState

Detailed Description

The Accessibility component detects the accessibility options of the operating system that the app is running on. This can be used to change the behavior of your app based on operating system-level options.

This component is a singleton, and does not need to be instantiated.

The following table describes which features are supported on which platforms.

This code sample demonstrates an example usage of the Accessibility component, displaying the component's proeprties as derived from the device. If the device doesn't support an accessibility element, it will return -1, 0 if the device supports the element but isn't currently using it, and 1 if the element is supported and in use. In the case of fontScale, it will show a value reflecting how large the text is, with 1 representing 100% of normal text size.

App {
    id: app
    width: 400
    height: 640

    ColumnLayout {
        anchors.fill: parent

        Row {
            Layout.fillWidth: true
            Layout.alignment: Qt.AlignCenter
            Layout.margins: 15
            spacing: 20

            Text {
                width: parent.width / 2
                text: "Voice Over"
            }

            Text {
                width: parent.width / 2

                text: Accessibility.voiceOver
            }
        }


        Row {
            Layout.fillWidth: true
            Layout.alignment: Qt.AlignCenter
            Layout.margins: 15
            spacing: 20

            Text {
                width: parent.width / 2
                text: "Bold Text"
            }

            Text {
                width: parent.width / 2
                text: Accessibility.boldText
            }
        }


        Row {
            Layout.fillWidth: true
            Layout.alignment: Qt.AlignCenter
            Layout.margins: 15
            spacing: 20

            Text {
                width: parent.width / 2
                text: "High Contrast"
            }

            Text {
                width: parent.width / 2
                text: Accessibility.highContrast
            }
        }

        Row {
            Layout.fillWidth: true
            Layout.alignment: Qt.AlignCenter
            Layout.margins: 15
            spacing: 20

            Text {
                width: parent.width / 2
                text: "Font Scale"
            }

            Text {
                width: parent.width / 2
                text: Accessibility.textScale
            }
        }
    }
}

Enumerations

VoiceOverState enumeration

BoldTextStatus enumeration

HighContrastStatus enumeration

Property Documentation