Класс QAccessible

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

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

Типы

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

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

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

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

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

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

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

Qt поддерживает Microsoft Active Accessibility (MSAA), macOS Accessibility и стандарт Unix/X11 AT-SPI. Другие бэкэнды могут быть поддержаны с помощью 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::Событие

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

Значения для этого перечисления определены так же, как и в спецификациях 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 с помощью оператора OR.

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, из кэша и удаляет его. Идентификатор становится недействительным и может быть повторно использован кэшем.

[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(), чтобы избежать ненужных вычислений.