Доступность для приложений QWidget

Введение

Мы сосредоточимся на интерфейсе Qt для доступности QAccessibleInterface и том, как сделать приложения доступными.

Доступность в приложениях на основе QWidget

При взаимодействии с технологиями вспомогательных средств мы должны описать пользовательский интерфейс Qt таким образом, чтобы они могли его понять. Приложения Qt используют QAccessibleInterface для предоставления информации об отдельных элементах пользовательского интерфейса. В настоящее время Qt поддерживает свои виджеты и части виджетов, например, ползунки, но интерфейс также может быть реализован для любого QObject, если это необходимо. QAccessible содержит перечисления, описывающие пользовательский интерфейс. Мы рассмотрим перечисления в ходе этого документа.

Структура пользовательского интерфейса представлена в виде дерева подклассов QAccessibleInterface. Часто это отражение иерархии QWidgets, составляющих пользовательский интерфейс приложения.

Серверы уведомляют клиентов через updateAccessibility() об изменениях в объектах, отправляя события, а клиенты регистрируются для получения событий. Доступные события определяются перечислением QAccessible::Event. Затем клиенты могут запросить объект, сгенерировавший событие, через QAccessible::queryAccessibleInterface().

Члены и перечисления в QAccessible используются для описания доступных объектов:

Role: Описывает роль объекта в пользовательском интерфейсе, например, является ли он окном, полем редактирования текста или ячейкой таблицы.
Relation: Описывает отношения между объектами в иерархии объектов.
State: Объекты могут находиться в ряде различных состояний. Примерами состояний являются состояние отключения объекта, наличие фокуса или предоставление всплывающего меню.

Клиенты также имеют возможность получить содержимое объектов, например, текст кнопки; объект предоставляет строки, определенные перечислением QAccessible::Text, которые предоставляют информацию о содержимом.

Дерево доступных объектов

Как уже упоминалось, структура дерева строится из доступных объектов приложения. Перемещаясь по дереву, клиенты могут получить доступ ко всем элементам пользовательского интерфейса. Связи между объектами предоставляют клиентам информацию о пользовательском интерфейсе. Например, маркер ползунка является потомком ползунка, к которому он принадлежит. QAccessible::Relation описывает различные отношения, которые клиенты могут запросить у объектов.

Обратите внимание, что нет прямого соответствия между деревом Qt QObject и деревом доступных объектов. Например, маркеры полосы прокрутки являются доступными объектами, но не являются виджетами или объектами в Qt.

Клиенты AT имеют доступ к дереву объектов доступности через корневой объект в дереве, который является QApplication. Они могут перемещаться по дереву с помощью функций QAccessibleInterface::parent(), QAccessibleInterface::childCount() и QAccessibleInterface::child().

Qt предоставляет доступные интерфейсы для своих виджетов и для Qt Quick Controls. Интерфейсы для любого подкласса QObject могут быть запрошены через QAccessible::queryInterface(). Если более специализированный интерфейс не определен, предоставляется реализация по умолчанию. Клиент AT не может получить интерфейс для доступных объектов, которые не имеют эквивалентного QObject, например, маркеров полосы прокрутки, но они отображаются как обычные объекты через интерфейсы родительских доступных объектов, например, вы можете запросить их отношения с помощью QAccessibleInterface::relations().

Для иллюстрации мы представляем изображение дерева доступных объектов. Под деревом находится таблица с примерами отношений между объектами.

Метки в порядке сверху вниз: имя класса QAccessibleInterface, виджет, для которого предоставляется интерфейс, и Role объекта. Position, PageLeft и PageRight соответствуют маркерам ползунка, левой и правой части желоба ползунка соответственно. Эти доступные объекты не имеют эквивалентного QObject.

Исходный объект	Целевой объект	Отношение
Ползунок	Индикатор	Управляющий
Индикатор	Ползунок	Управляемый
Ползунок	Приложение	Предок
Приложение	Ползунок	Потомок
Кнопка	Индикатор	Брат

Статические функции QAccessible

Доступность управляется статическими функциями QAccessible, которые мы рассмотрим вскоре. Они производят интерфейсы QAccessible, строят дерево объектов и инициируют подключение с MSAA или другими платформно-специфичными технологиями. Если вас интересует только то, как сделать ваше приложение доступным, вы можете пропустить этот раздел и перейти к Реализация доступности.

Взаимодействие между клиентами и сервером инициируется при вызове setRootObject(). Это делается при создании экземпляра QApplication, и вам не нужно делать этого самостоятельно.

Когда QObject вызывает updateAccessibility(), клиенты, которые слушают события, уведомляются об изменении. Функция используется для отправки событий технологиям вспомогательных средств, и доступные события события отправляются функцией updateAccessibility().

queryAccessibleInterface() возвращает доступные интерфейсы для QObjects. Все виджеты в Qt предоставляют интерфейсы; если вам нужны интерфейсы для управления поведением других подклассов QObject, вы должны реализовать интерфейсы самостоятельно, хотя удобный класс QAccessibleObject реализует части функциональности за вас.

Фабрика, которая создает интерфейсы доступности для QObjects, является функцией типа QAccessible::InterfaceFactory. Можно установить несколько фабрик. Последняя установленная фабрика будет первой, к которой обратятся для получения интерфейсов. queryAccessibleInterface() использует фабрики для создания интерфейсов для QObjects. Обычно вам не нужно беспокоиться о фабриках, потому что вы можете реализовать плагины, которые создают интерфейсы. Мы приведем примеры обоих подходов позже.

Реализация доступности

Для обеспечения поддержки доступности для виджета или другого элемента пользовательского интерфейса необходимо реализовать QAccessibleInterface и распространить его в QAccessiblePlugin. Также можно скомпилировать интерфейс в приложение и предоставить QAccessible::InterfaceFactory для него. Фабрика может быть использована, если вы связываете библиотеку статически или не хотите дополнительных сложностей с плагинами. Это может быть преимуществом, например, при доставке библиотеки сторонних разработчиков.

Все виджеты и другие элементы пользовательского интерфейса должны иметь интерфейсы и плагины. Если вы хотите, чтобы ваше приложение поддерживало доступность, вам нужно рассмотреть следующие моменты:

Qt уже реализует доступность для собственных виджетов. Поэтому мы рекомендуем использовать виджеты Qt, когда это возможно.
Для каждого элемента, который вы хотите сделать доступным для клиентов доступности, должен быть реализован QAccessibleInterface.
Вам нужно отправлять события доступности из реализуемых вами пользовательских элементов пользовательского интерфейса.

В целом, рекомендуется иметь некоторое знакомство с MSAA, для которого изначально создавалась поддержка доступности Qt. Вы также должны изучить значения перечислений в QAccessible, которые описывают роли, действия, отношения и события, которые вам нужно учитывать.

Обратите внимание, что вы можете изучить, как виджеты Qt реализуют свою доступность. Одна из основных проблем с стандартом MSAA заключается в том, что интерфейсы часто реализуются несогласованно. Это создает трудности для клиентов и часто приводит к предположениям о функциональности объектов.

Можно реализовать интерфейсы, унаследовав QAccessibleInterface и реализовав его чистые виртуальные функции. Однако на практике обычно предпочтительнее унаследовать QAccessibleObject или QAccessibleWidget, которые реализуют часть функциональности за вас. В следующем разделе мы увидим пример реализации доступности для виджета путем наследования класса QAccessibleWidget.

Удобные классы QAccessibleObject и QAccessibleWidget

При реализации интерфейса доступности для виджетов, как правило, наследуют QAccessibleWidget, который является удобным классом для виджетов. Другой доступный удобный класс, который наследуется от QAccessibleWidget, — это QAccessibleObject, который реализует часть интерфейса для QObjects.

Класс QAccessibleWidget предоставляет следующую функциональность:

Он обрабатывает навигацию по дереву и проверку попадания объектов.
Он обрабатывает события, роли и действия, которые являются общими для всех QWidgets.
Он обрабатывает действия и методы, которые можно выполнить на всех виджетах.
Он вычисляет ограничительные прямоугольники с помощью rect().
Он предоставляет строки text(), которые подходят для универсального виджета.
Он устанавливает состояния, которые являются общими для всех виджетов.

Пример QAccessibleWidget

Вместо создания пользовательского виджета и реализации интерфейса для него, мы покажем, как реализуется доступность для одного из стандартных виджетов Qt: QSlider. Доступный интерфейс, QAccessibleSlider, наследуется от QAccessibleAbstractSlider, который в свою очередь наследуется от QAccessibleWidget. Вам не нужно изучать класс QAccessibleAbstractSlider для чтения этого раздела. Если вы хотите взглянуть, код всех доступных интерфейсов Qt находится в qtbase/src/widgets/accessible. Вот конструктор QAccessibleSlider:

QAccessibleSlider::QAccessibleSlider(QWidget *w)
: QAccessibleAbstractSlider(w)
{
    Q_ASSERT(slider());
    addControllingSignal(QLatin1String("valueChanged(int)"));
}

Ползунок — это сложное управление, которое функционирует как Контроллер для своих доступных дочерних элементов. Это отношение должно быть известно интерфейсу (для parent(), child() и relations()). Это можно сделать с помощью управляющего сигнала, который является механизмом, предоставляемым QAccessibleWidget. Мы делаем это в конструкторе:

Выбор показанного сигнала не важен; те же принципы применяются ко всем сигналам, объявленным таким образом. Обратите внимание, что мы используем QLatin1String, чтобы гарантировать, что имя сигнала указано правильно.

Когда доступный объект изменяется таким образом, что пользователи должны знать об этом, он уведомляет клиентов об изменении, отправляя им событие через доступный интерфейс. Вот как QSlider вызывает updateAccessibility(), чтобы указать, что его значение изменилось:

void QAbstractSlider::setValue(int value)
    ...
    QAccessibleValueChangeEvent event(this, d->value);
    QAccessible::updateAccessibility(&event);
    ...
}

Обратите внимание, что вызов производится после изменения значения ползунка, потому что клиенты могут запросить новое значение сразу после получения события.

Интерфейс должен уметь вычислять ограничивающие прямоугольники самого себя и любых дочерних элементов, которые не предоставляют собственный интерфейс. QAccessibleSlider имеет три таких дочерних элемента, идентифицированных частным перечислением SliderElements, которое имеет следующие значения: PageLeft (прямоугольник слева от ручки ползунка), PageRight (прямоугольник справа от ручки), и Position (ручка ползунка). Вот реализация rect():

QRect QAccessibleSlider::rect(int child) const
{
    ...
    switch (child) {
    case PageLeft:
        if (slider()->orientation() == Qt::Vertical)
            rect = QRect(0, 0, slider()->width(), srect.y());
        else
            rect = QRect(0, 0, srect.x(), slider()->height());
        break;
    case Position:
        rect = srect;
        break;
    case PageRight:
        if (slider()->orientation() == Qt::Vertical)
            rect = QRect(0, srect.y() + srect.height(), slider()->width(), slider()->height()- srect.y() - srect.height());
        else
            rect = QRect(srect.x() + srect.width(), 0, slider()->width() - srect.x() - srect.width(), slider()->height());
        break;
    default:
        return QAccessibleAbstractSlider::rect(child);
    }
    ...

Первая часть функции, которую мы опустили, использует текущий стиль для вычисления ограничивающего прямоугольника ручки ползунка; он хранится в srect. Обратите внимание, что дочерний элемент 0, покрытый в случае по умолчанию в приведенном выше коде, является самим ползунком, поэтому мы можем просто вернуть ограничивающий прямоугольник QSlider, полученный от суперкласса, что фактически является значением, полученным из QAccessibleWidget::rect().

    QPoint tp = slider()->mapToGlobal(QPoint(0,0));
    return QRect(tp.x() + rect.x(), tp.y() + rect.y(), rect.width(), rect.height());
}

Перед возвращением прямоугольника он должен быть отображен в экранных координатах.

QAccessibleSlider должен переопределить QAccessibleInterface::childCount(), так как он управляет дочерними элементами без интерфейсов.

Функция text() возвращает строки QAccessible::Text для ползунка:

QString QAccessibleSlider::text(Text t, int child) const
{
    if (!slider()->isVisible())
        return QString();
    switch (t) {
    case Value:
        if (!child || child == 2)
            return QString::number(slider()->value());
        return QString();
    case Name:
        switch (child) {
        case PageLeft:
            return slider()->orientation() == Qt::Horizontal ?
                QSlider::tr("Page left") : QSlider::tr("Page up");
        case Position:
            return QSlider::tr("Position");
        case PageRight:
            return slider()->orientation() == Qt::Horizontal ?
                QSlider::tr("Page right") : QSlider::tr("Page down");
        }
        break;
    default:
        break;
    }
    return QAccessibleAbstractSlider::text(t, child);
}

Функция slider() возвращает указатель на QSlider интерфейса. Некоторые значения оставлены для реализации суперкласса. Не все значения подходят для всех доступных объектов, как вы можете видеть для QAccessible::Value случае. Для тех значений, где нельзя предоставить соответствующий текст, вы должны просто вернуть пустую строку.

Реализация функции role() проста:

QAccessible::Role QAccessibleSlider::role(int child) const
{
    switch (child) {
    case PageLeft:
    case PageRight:
        return PushButton;
    case Position:
        return Indicator;
    default:
        return Slider;
    }
}

Функция role должна быть переопределена всеми объектами и описывает роль самих себя и дочерних элементов, которые не предоставляют собственных доступных интерфейсов.

Далее, доступный интерфейс должен возвращать состояния, в которых может находиться ползунок. Мы рассмотрим части реализации state(), чтобы показать, как обрабатываются всего несколько состояний:

QAccessible::State QAccessibleSlider::state(int child) const
{
    const State parentState = QAccessibleAbstractSlider::state(0);
    ...
    switch (child) {
    case PageLeft:
        if (slider->value() <= slider->minimum())
            state |= Unavailable;
        break;
    case PageRight:
        if (slider->value() >= slider->maximum())
            state |= Unavailable;
        break;
    case Position:
    default:
        break;
    }

    return state;
}

Реализация state() в суперклассе использует реализацию QAccessibleInterface::state(). Нам просто нужно отключить кнопки, если ползунок находится в минимальном или максимальном положении.

Теперь мы предоставили клиентам информацию о ползунке. Чтобы клиенты могли изменять ползунок — например, изменять его значение — мы должны предоставить информацию о действиях, которые могут быть выполнены, и выполнять их по запросу. Об этом мы поговорим в следующем разделе.

Обработка запросов действий от клиентов

Приложения могут предоставлять действия, которые могут быть вызваны клиентом. Для поддержки действий в объекте необходимо унаследовать QAccessibleActionInterface.

Интерактивные элементы должны предоставлять функциональность, запускаемую взаимодействием с мышкой, например. Кнопка, например, должна реализовать действие щелчка.

Установка фокуса — это еще одно действие, которое должно быть реализовано для виджетов, которые могут получить фокус.

Вы должны переопределить actionNames(), чтобы вернуть список всех действий, которые поддерживает объект. Этот список не должен быть локализован.

Существуют две функции, которые предоставляют информацию о действиях, которые должны возвращать локализованные строки: localizedActionName() и localizedActionDescription(). Эти функции могут использоваться клиентом для отображения действий пользователю. Как правило, имя должно быть кратким и состоять только из одного слова, например, «нажать».

Доступен список стандартных имен действий и локализаций, которые следует использовать, когда действие подходит. Это облегчает клиентам понимание семантики, и Qt попытается правильно отобразить их на различных платформах.

Конечно, действие также должно иметь способ запуска. doAction() должно вызывать действие, как рекламируется по имени и описанию.

Чтобы увидеть примеры реализации действий и методов, вы можете изучить реализации стандартных виджетов Qt, таких как QAccessiblePushButton.

Реализация доступных плагинов

В этом разделе мы объясним процедуру реализации доступных плагинов для ваших интерфейсов. Плагин — это класс, хранящийся в общей библиотеке, который может быть загружен во время выполнения. Предоставление интерфейсов в виде плагинов удобно, поскольку они будут загружаться только при необходимости.

Создание доступного плагина достигается путем наследования QAccessiblePlugin, определения поддерживаемых имен классов в описании JSON плагина и переопределения create() из QAccessiblePlugin. Файл .pro должен быть изменен для использования шаблона плагина, а библиотека, содержащая плагин, должна быть размещена в пути, по которому Qt ищет доступные плагины.

Мы пройдемся по реализации SliderPlugin, который является доступным плагином, производящим интерфейс QAccessibleSlider из QAccessibleWidget Example. Мы начнем с функции key():

QStringList SliderPlugin::keys() const
{
    return QStringList() << QLatin1String("QSlider");
}

Нам просто нужно вернуть имя класса единственного интерфейса, для которого наш плагин может создать доступный интерфейс. Плагин может поддерживать любое количество классов; просто добавьте больше имен классов в список строк. Мы переходим к функции create():

QAccessibleInterface *SliderPlugin::create(const QString &classname, QObject *object)
{
    QAccessibleInterface *interface = 0;

    if (classname == QLatin1String("QSlider") && object && object->isWidgetType())
        interface = new QAccessibleSlider(static_cast<QWidget *>(object));

    return interface;
}

Мы проверяем, предназначен ли запрашиваемый интерфейс для QSlider; если да, мы создаем и возвращаем интерфейс для него. Обратите внимание, что object всегда будет экземпляром classname. Вы должны вернуть 0, если вы не поддерживаете класс. updateAccessibility() проверяет доступные плагины доступности, пока не найдет такой, который не возвращает 0.

Наконец, вам нужно включить макросы в файле cpp:

    Q_OBJECT
    Q_PLUGIN_METADATA(IID "org.qt-project.Qt.Examples.Accessibility.SliderPlugin" FILE "slider.json")

Макрос Q_PLUGIN_METADATA экспортирует плагин в SliderPlugin класс в библиотеку acc_sliderplugin. Первый аргумент — IID плагина, а второй — необязательный файл json, содержащий метаданные плагина. Для получения дополнительной информации о плагинах вы можете обратиться к документу-обзору плагинов .

Не имеет значения, нужно ли вам статически или динамически связывать плагин с приложением.

Реализация фабрик интерфейсов

Если вы не хотите предоставлять плагины для ваших доступных интерфейсов, вы можете использовать фабрику интерфейсов (QAccessible::InterfaceFactory), что является рекомендуемым способом предоставления доступных интерфейсов в статически связанном приложении.

Фабрика — это указатель на функцию, которая принимает те же параметры, что и QAccessiblePlugin’s create() — QString и QObject. Она также работает аналогично. Вы устанавливаете фабрику с помощью функции installFactory(). Мы даем пример того, как создать фабрику для QAccessibleSlider интерфейса:

QAccessibleInterface *sliderFactory(const QString &classname, QObject *object)
{
    QAccessibleInterface *interface = 0;

    if (classname == QLatin1String("QSlider") && object && object->isWidgetType())
        interface = new QAccessibleSlider(static_cast<QWidget *>(object));

    return interface;
}

int main(int argc, char *argv[])
{
    QApplication app(argc, argv);
    QAccessible::installFactory(sliderFactory);
    ...
}

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-5.14/accessible-qwidget.html