Класс QAccessible

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

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

Типы публичного интерфейса

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

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

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

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

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

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

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

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

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

• Свойство 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 QAccessibleInterface *myFactoryFunction(const QString &key, QObject *);

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

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

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

enum QAccessible::InterfaceType

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

Примечание: При наследовании одного из этих интерфейсов необходимо реализовать QAccessibleInterface::interface_cast().

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

enum QAccessible::RelationFlagflags QAccessible::Relation

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

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

Тип Relation — псевдоним для QFlags<RelationFlag>. Он хранит объединение по оператору OR значений 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)

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

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

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

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

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

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

Должна вызываться ровно один раз для каждого интерфейса iface. Это неявно вызывается при вызове queryAccessibleInterface, вызов этой функции требуется только тогда, когда QAccessibleInterfaces создаются оператором "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(), чтобы избежать ненужных вычислений.