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

В реализации 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

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

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

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