Класс QAccessible

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

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

• свойство 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

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

Внутреннее: используется при создании подклассов 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, будет возвращён 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(Id id)

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

Возвращает 0, если id недействительно.

[static] void QAccessible::deleteAccessibleInterface(Id id)

Удаляет интерфейс, принадлежащий данному id, из кэша и удаляет его. Id становится недействительным и может быть повторно использован кэшем.

[static] void QAccessible::installFactory(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] Id QAccessible::registerAccessibleInterface(QAccessibleInterface *iface)

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

Должна вызываться только один раз для каждого интерфейса iface. Это неявно вызывается при вызове queryAccessibleInterface; вызов этой функции требуется только когда QAccessibleInterfaces инициализируются оператором "new". Это не рекомендуется, в идеале используйте стандартные функции и позвольте queryAccessibleInterface() позаботиться об этом.

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

[static] void QAccessible::removeFactory(InterfaceFactory factory)

Удаляет factory из списка установленных InterfaceFactories.

[static] void QAccessible::setRootObject(QObject *object)

Устанавливает корневой объект доступных объектов этого приложения на object. Все остальные доступные объекты доступны с помощью навигации по объектам от корневого объекта.

Обычно, вызывать эту функцию не нужно, так как Qt устанавливает объект QApplication в качестве корневого объекта сразу перед входом в цикл событий в QApplication::exec().

Используйте QAccessible::installRootObjectHandler(), чтобы перенаправить вызов функции на пользовательскую функцию-обработчик.

См. такжеqueryAccessibleInterface().

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

Возвращает уникальный идентификатор для QAccessibleInterface iface.

[static] void QAccessible::updateAccessibility(QAccessibleEvent *event)

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

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

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

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

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