Класс QAccessibleInterface

Класс QAccessibleInterface определяет интерфейс, который предоставляет информацию об объектах, доступных для использования. Подробнее...

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

Открытые функции

Защищённые функции

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

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

Инструменты обеспечения доступности (также называемые клиентами AT), такие как программы чтения с экрана или устройства для вывода шрифтов Брайля, требуют информации высокого уровня об объектах, доступных в приложении. Объекты, доступные для использования, обеспечивают специализированные методы ввода-вывода, что позволяет пользователям использовать инструменты обеспечения доступности с включёнными приложениями (серверами AT).

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

Клиент AT использует три основных понятия для получения информации об объекте, доступном в приложении:

• Свойства Клиент может считывать информацию об объектах, доступных для использования. В некоторых случаях клиент также может изменять эти свойства, например, текст в строке ввода.
• Действия Клиент может вызывать действия, такие как нажатие кнопки.
• Взаимоотношения и навигация Клиент может перемещаться от одного объекта, доступного для использования, к другому, используя взаимоотношения между объектами.

QAccessibleInterface определяет API для этих трёх понятий.

Взаимоотношения и навигация

Функции childCount() и indexOfChild() возвращают количество дочерних элементов объекта, доступного для использования, и индекс дочернего объекта в его родительском объекте. Функция childAt() возвращает дочерний QAccessibleInterface, который находится в заданном положении. Дочерний элемент не обязательно должен быть непосредственным потомком. Это позволяет обойти промежуточные уровни, когда родитель уже знает самого верхнего дочернего элемента. childAt() используется для проверки попадания (поиска объекта под курсором мыши).

Функция relations() предоставляет информацию о взаимоотношениях объекта с другими объектами, а parent() и child() позволяют перемещаться от одного объекта к другому.

Свойства

Основным свойством объекта, доступного для использования, является то, какой роль он имеет. Различные объекты могут иметь одну и ту же роль, например, и элемент «Добавить строку» в полосе прокрутки, и кнопка OK в диалоговом окне имеют одну и ту же роль, «кнопка». Роль предполагает, какой тип взаимодействия пользователь может выполнить с элементом пользовательского интерфейса.

Свойство состояния объекта является комбинацией различных флагов состояния и может описывать как различие состояния объекта от «нормального» состояния, например, он может быть недоступным, так и его поведение, например, он может быть выбираемым.

Свойство текста предоставляет текстовую информацию об объекте. Обычно объект имеет имя, но может предоставить расширенную информацию, такую как описание, подсказка или информация о любых сочетаниях клавиш, которые он предоставляет. Некоторые объекты позволяют изменять свойство текста с помощью функции setText(), но эта информация в большинстве случаев является только для чтения.

Свойство прямоугольника предоставляет информацию о геометрии объекта, доступного для использования. Эта информация обычно доступна только для визуальных объектов.

Интерфейсы

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

Существует несколько других интерфейсов, которые должны быть реализованы по необходимости. QAccessibleTextInterface должен использоваться для больших редакторов текста, таких как представления документов. Этот интерфейс не должен реализовываться для меток/однострочных редакторов.

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

Списки, таблицы и деревья должны реализовывать QAccessibleTableInterface.

См. также QAccessible, QAccessibleActionInterface, QAccessibleTextInterface, QAccessibleValueInterface и QAccessibleTableInterface.

Документация по членам-функциям

[virtual protected] QAccessibleInterface::~QAccessibleInterface()

Уничтожает QAccessibleInterface.

QAccessibleActionInterface *QAccessibleInterface::actionInterface()

[virtual] QColor QAccessibleInterface::backgroundColor() const

Возвращает цвет фона объекта, доступного для использования, если применимо, или недействительный QColor.

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

[pure virtual] QAccessibleInterface *QAccessibleInterface::child(int index) const

Возвращает доступного потомка с индексом index. Индекс нулевого базиса. Количество потомков объекта можно проверить с помощью childCount.

Возвращает nullptr при запросе невалидного потомка (например, если потомок стал невалидным в промежутке).

См. также childCount() и parent().

[pure virtual] QAccessibleInterface *QAccessibleInterface::childAt(int x, int y) const

Возвращает QAccessibleInterface потомка, содержащего экранные координаты (x, y). Если в этой позиции нет потомков, эта функция возвращает nullptr. Возвращаемый доступный элемент должен быть потомком, но необязательно непосредственным потомком.

Эта функция надёжна только для видимых объектов (невидимые объекты могут быть неверно размещены).

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

Для объектов, наследующих от QAccessibleObject, предоставляется реализация по умолчанию. Она будет перебирать всех потомков. Если виджет управляет своими потомками (например, таблица), более эффективной будет специализированная реализация.

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

[pure virtual] int QAccessibleInterface::childCount() const

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

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

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

[virtual] QAccessibleInterface *QAccessibleInterface::focusChild() const

Возвращает объект, имеющий фокус клавиатуры.

Возвращаемый объект может быть любым потомком, включая самого себя.

[virtual] QColor QAccessibleInterface::foregroundColor() const

Возвращает цвет переднего плана доступного объекта, если применимо, или невалидный QColor.

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

[pure virtual] int QAccessibleInterface::indexOfChild(const QAccessibleInterface *child) const

Возвращает индекс объекта child в списке потомков этого объекта с нулевым базисом или -1, если child не является потомком этого объекта.

Все объекты предоставляют эту информацию о своих потомках.

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

[virtual] void *QAccessibleInterface::interface_cast(QAccessible::InterfaceType type)

Возвращает специализированный интерфейс доступности type из универсального QAccessibleInterface.

Эта функция должна быть переопределена, когда требуется предоставить больше информации о виджете или объекте через специализированные интерфейсы. Например, поле ввода должно реализовывать QAccessibleTextInterface.

См. также QAccessible::InterfaceType, QAccessibleTextInterface, QAccessibleValueInterface, QAccessibleActionInterface, QAccessibleTableInterface и QAccessibleTableCellInterface.

[pure virtual] bool QAccessibleInterface::isValid() const

Возвращает true если все данные, необходимые для использования этой реализации интерфейса, валидны (например, все указатели не нулевые); в противном случае возвращает false.

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

[pure virtual] QObject *QAccessibleInterface::object() const

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

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

[pure virtual] QAccessibleInterface *QAccessibleInterface::parent() const

Возвращает QAccessibleInterface родителя в иерархии доступного объекта.

Возвращает nullptr если родитель не существует (например, для объекта приложения верхнего уровня).

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

[pure virtual] QRect QAccessibleInterface::rect() const

Возвращает геометрию объекта. Геометрия представлена в экранных координатах.

Эта функция надёжна только для видимых объектов (невидимые объекты могут быть неверно размещены).

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

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

[virtual] QList<QPair<QAccessibleInterface *, QAccessible::Relation> > QAccessibleInterface::relations(QAccessible::Relation match = QAccessible::AllRelations) const

Возвращает значимые отношения к другим виджетам. Обычно это не возвращает отношения родитель/потомок, если они не обрабатываются особым образом, например, в дереве. Обычно это возвращает отношения "метка-для" и "метка".

Можно отфильтровать отношения, используя необязательный параметр match. Сам объект никогда не должен возвращаться.

См. также parent() и child().

[pure virtual] QAccessible::Role QAccessibleInterface::role() const

Возвращает роль объекта. Роль объекта обычно статична.

Все доступные объекты имеют роль.

См. также text() и state().

[pure virtual] void QAccessibleInterface::setText(QAccessible::Text t, const QString &text)

Устанавливает свойство текста t объекта в text.

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

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

[pure virtual] QAccessible::State QAccessibleInterface::state() const

Возвращает текущее состояние объекта. Возвращаемое значение является комбинацией флагов в перечислении QAccessible::StateFlag.

Все доступные объекты имеют состояние.

См. также text() и role().

QAccessibleTableCellInterface *QAccessibleInterface::tableCellInterface()

QAccessibleTableInterface *QAccessibleInterface::tableInterface()

[pure virtual] QString QAccessibleInterface::text(QAccessible::Text t) const

Возвращает значение свойства текста t объекта.

Значение QAccessible::Name — это строка, используемая клиентами для идентификации, поиска или объявления доступного объекта пользователю. Все объекты должны иметь имя, уникальное в контейнере. Имя может использоваться клиентами по-разному, поэтому имя должно как кратко описывать объект, так и быть уникальным.

Описание QAccessible::Description доступного объекта предоставляет текстовую информацию о визуальном представлении объекта. Описание в первую очередь используется для предоставления большего контекста пользователям с нарушениями зрения, но также используется для поиска контекста или других приложений. Не все объекты имеют описание. Кнопка "ОК" не нуждается в описании, но кнопка инструмента, отображающая изображение смайлика, нужна.

Значение QAccessible::Value доступного объекта представляет визуальную информацию, содержащуюся в объекте, например, текст в поле ввода. Обычно значение может быть изменено пользователем. Не все объекты имеют значение, например, статические текстовые метки нет, а у некоторых объектов состояние уже является значением, например, переключатели.

Текст QAccessible::Help предоставляет информацию о функции и использовании доступного объекта. Не все объекты предоставляют эту информацию.

Значение QAccessible::Accelerator — это сочетание клавиш клавиатуры, которое активирует стандартное действие объекта. Сочетание клавиш — это подчеркнутый символ в тексте меню, пункта меню или виджета и представляет собой либо сам символ, либо сочетание этого символа и модификатора клавиш, таких как Alt, Ctrl или Shift. У элементов управления командами, таких как кнопки инструментов, также есть сочетания клавиш и обычно они отображаются в подсказке.

Все объекты предоставляют строку для QAccessible::Name.

См. также setText(), role() и state().

QAccessibleTextInterface *QAccessibleInterface::textInterface()

QAccessibleValueInterface *QAccessibleInterface::valueInterface()

[virtual] QWindow *QAccessibleInterface::window() const

Возвращает окно, связанное с базовым объектом. Например, QAccessibleWidget переопределяет это и возвращает windowHandle() QWidget.

Используется на некоторых платформах, чтобы уведомлять клиента AT об изменениях состояния. Бэкенд будет проходить по всем предкам до тех пор, пока не найдет окно. (Это означает, что по крайней мере один интерфейс среди предков должен вернуть действительный указатель QWindow).

Реализация по умолчанию возвращает nullptr.