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

В реализации 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::Событие

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

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

typedef QAccessible::Id

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

typedef QAccessible::InterfaceFactory

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

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

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

Если ключу и QObject не соответствует QAccessibleInterface, возвращается null-указатель.

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