Класс 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, 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 если идентификатор недействителен.

[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)

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

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

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

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

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