Класс 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 приложения становятся доступными, когда выполняются два условия:

• Свойство 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::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>. Он хранит логическое ИЛИ сочетание значений 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(), чтобы избежать ненужных вычислений.