Класс QAccessible

Класс QAccessible предоставляет перечисления и статические функции, относящиеся к доступности. Подробнее...

• Список всех членов, включая унаследованные

Общедоступные типы

Статические общедоступные члены

Подробное описание

Этот класс является частью Доступности для приложений QWidget.

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

Функции в этом классе используются для связи между доступными приложениями (также называемыми серверами AT) и инструментами доступности (клиентами AT), такими как программы чтения с экрана и устройства брайля. Клиенты и серверы взаимодействуют следующим образом:

• Серверы AT уведомляют клиентов о событиях через вызовы функции updateAccessibility().
• Клиенты AT запрашивают информацию об объектах на сервере. Класс QAccessibleInterface является основным интерфейсом и инкапсулирует эту информацию в чистом виртуальном API. Реализации интерфейса предоставляются Qt через API queryAccessibleInterface().

Взаимодействие между серверами и клиентами инициируется функцией setRootObject(). Указатели функций могут быть установлены для замены или расширения стандартного поведения статических функций в QAccessible.

Qt поддерживает Microsoft Active Accessibility (MSAA), macOS Accessibility и стандарт AT-SPI Unix/X11. Другие бэкэнды могут быть поддержаны с помощью QAccessibleBridge.

В реализации AT-SPI Unix/X11 приложения становятся доступными, когда выполняются два условия:

• свойство DBus org.a11y.Status.IsEnabled имеет значение true
• свойство DBus org.a11y.Status.ScreenReaderEnabled имеет значение true

Альтернативой установке свойств DBus AT-SPI является установка переменной окружения QT_LINUX_ACCESSIBILITY_ALWAYS_ON.

Помимо статических функций QAccessible, Qt предлагает один универсальный интерфейс QAccessibleInterface, который может быть использован для обертывания всех виджетов и объектов (например, QPushButton). Этот единственный интерфейс предоставляет всю метаданные, необходимые для вспомогательных технологий. Qt предоставляет реализации этого интерфейса для своих встроенных виджетов как плагины.

При разработке пользовательских виджетов вы можете создавать пользовательские подклассы QAccessibleInterface и распространять их как плагины (используя QAccessiblePlugin) или компилировать их в приложение. Аналогично, предварительно определенная поддержка доступности Qt может быть построена как плагин (по умолчанию) или непосредственно в библиотеке Qt. Основным преимуществом использования плагинов является то, что классы доступности загружаются в память только в том случае, если они фактически используются; они не замедляют общий случай, когда никакая вспомогательная технология не используется.

Qt также включает два удобных класса QAccessibleObject и QAccessibleWidget, которые наследуют от QAccessibleInterface и предоставляют наименьший общий знаменатель метаданных (например, геометрию виджета, заголовок окна, базовый текст справки). Вы можете использовать их в качестве базовых классов при обертывании ваших пользовательских подклассов QObject или QWidget.

См. также QAccessibleInterface.

Документация по типам членов

Перечисление QAccessible::Event

Это перечисление определяет типы событий доступности.

Значения для этого перечисления определены так же, как и в спецификациях IAccessible2 и MSAA.

QAccessible::Id

Синоним для unsigned, используемый кэшем QAccessibleInterface.

QAccessible::InterfaceFactory

Это typedef для указателя на функцию со следующим сигнатурой:

typedef QAccessibleInterface *myFactoryFunction(const QString &key, QObject *);

Функция получает QString и указатель на QObject, где QString является ключом, идентифицирующим интерфейс. QObject используется для передачи в QAccessibleInterface, чтобы он мог удерживать на него ссылку.

Если у ключа и QObject нет соответствующего QAccessibleInterface, nullptr будет возвращено.

Установленные фабрики вызываются функцией queryAccessibilityInterface() до тех пор, пока одна из них не предоставит интерфейс.

enum QAccessible::InterfaceType

QAccessibleInterface поддерживает несколько под-интерфейсов. Для обеспечения большей информации о некоторых объектах их доступное представление должно реализовывать один или несколько из этих интерфейсов.

См. также QAccessibleInterface::interface_cast(), QAccessibleTextInterface, QAccessibleValueInterface, QAccessibleActionInterface, QAccessibleTableInterface, и QAccessibleTableCellInterface.

enum QAccessible::RelationFlagflags QAccessible::Relation

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

Реализации relations() возвращают комбинацию этих флагов. Некоторые значения являются взаимоисключающими.

Тип Relation — это typedef для QFlags<RelationFlag>. Он хранит логическое ИЛИ комбинацию значений RelationFlag.

enum QAccessible::Role

Это перечисление определяет роль доступного объекта. Роли:

enum QAccessible::Text

Этот перечисление определяет строковую информацию, возвращаемую доступным объектом.

enum QAccessible::TextBoundaryType

Это перечисление описывает различные типы границ текста. Оно следует API IAccessible2 и используется в QAccessibleTextInterface.

См. также QAccessibleTextInterface.

Документация по функциям-членам

[static] QAccessibleInterface *QAccessible::accessibleInterface(QAccessible::Id id)

Возвращает QAccessibleInterface, принадлежащий id.

Возвращает nullptr если id недействительно.

[static] void QAccessible::deleteAccessibleInterface(QAccessible::Id id)

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

[static] void QAccessible::installFactory(QAccessible::InterfaceFactory factory)

Устанавливает InterfaceFactory factory. Последняя установленная фабрика используется в первую очередь queryAccessibleInterface().

[static] bool QAccessible::isActive()

Возвращает true если платформа запросила информацию о доступности.

Эта функция вернёт false, пока инструмент, такой как программа чтения с экрана, не обратится к фреймворку доступности. Возможно использовать QAccessible::queryAccessibleInterface() даже если доступность не активна. Но уведомления на платформу не будут отправлены.

Рекомендуется использовать эту функцию, чтобы предотвратить дорогостоящие уведомления через updateAccessibility() когда они не нужны.

[static] QAccessibleInterface *QAccessible::queryAccessibleInterface(QObject *object)

Если реализация QAccessibleInterface существует для данного object, эта функция возвращает указатель на реализацию; в противном случае возвращает nullptr.

Функция вызывает все установленные функции фабрики (от последней до первой установленной) до тех пор, пока одна не найдёт интерфейс для класса object. Если ни одна фабрика не может предоставить реализацию доступности для класса, функция загружает установленные плагины доступности и проверяет, может ли какой-либо из плагинов предоставить реализацию.

Если реализация для класса объекта недоступна, функция пытается найти реализацию для родительского класса объекта, используя описанную выше стратегию.

Все интерфейсы управляются внутренним кэшем и не должны удаляться.

[static] QAccessible::Id QAccessible::registerAccessibleInterface(QAccessibleInterface *iface)

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

Должна вызываться только один раз для каждого интерфейса iface. Это подразумевается при вызове queryAccessibleInterface, вызов этой функции необходим только при создании QAccessibleInterface с помощью оператора "new". Это не рекомендуется, если возможно, используйте стандартные функции и позвольте queryAccessibleInterface() позаботиться об этом.

Когда необходимо переопределить функцию QAccessibleInterface::child() и вернуть дочерний элемент после его построения, необходимо вызвать эту функцию.

[static] void QAccessible::removeFactory(QAccessible::InterfaceFactory factory)

Удаляет factory из списка установленных InterfaceFactories.

[static] void QAccessible::setRootObject(QObject *object)

Устанавливает корневой объект доступных объектов этого приложения в object. Все остальные доступные объекты могут быть достигнуты с помощью навигации по объектам из корневого объекта.

Обычно нет необходимости вызывать эту функцию, так как Qt устанавливает объект QApplication в качестве корневого объекта сразу перед входом в цикл событий в QApplication::exec().

Используйте QAccessible::installRootObjectHandler(), чтобы перенаправить вызов функции на пользовательскую обработчик.

См. также queryAccessibleInterface().

[static] QAccessible::Id QAccessible::uniqueId(QAccessibleInterface *iface)

Возвращает уникальный идентификатор для QAccessibleInterface iface.

[static] void QAccessible::updateAccessibility(QAccessibleEvent *event)

Уведомляет о событии, которое может быть важно для клиентов, использующих доступность.

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

Например, тип ValueChange указывает, что положение ползунка изменено.

Вызывайте эту функцию всякий раз, когда состояние вашего объекта доступности или одного из его подэлементов было изменено либо программно (например, с помощью вызова QLabel::setText()), либо в результате взаимодействия пользователя.

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