Класс QAccessible

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

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

Публичные типы

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

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

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

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

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

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

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

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

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

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

• Свойство org.a11y.Status.IsEnabled DBus равно true
• Свойство org.a11y.Status.ScreenReaderEnabled DBus равно 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::Событие

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

Внутреннее: используется при создании подклассов QAccessibleEvent.

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

typedef QAccessible::Id

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

typedef QAccessible::InterfaceFactory

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

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

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

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

Установленные фабрики вызываются функцией 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>. Он хранит логическое ИЛИ комбинацию значений RelationFlag.

enum QAccessible::Role

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

enum QAccessible::Text

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

enum QAccessible::TextBoundaryType

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

См. также QAccessibleTextInterface.

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

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

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

Возвращает 0, если 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, эта функция возвращает указатель на неё; в противном случае она возвращает 0.

Функция вызывает все установленные фабричные функции (от недавно установленных к менее недавно установленным), пока не найдёт такую, которая предоставляет интерфейс для класса 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(), чтобы избежать ненужных вычислений.