Класс 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.

typedef QAccessible::Id

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

typedef 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>. Он хранит логическое ИЛИ комбинацию значений 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; вызов этой функции необходим только в том случае, если 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)

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

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

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

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

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