QAccessibleEvent Class

The QAccessibleEvent class is the base class for accessibility notifications. More...

Header:	`#include <QAccessibleEvent>`
CMake:	`find_package(Qt6 REQUIRED COMPONENTS Gui)` `target_link_libraries(mytarget PRIVATE Qt6::Gui)`
qmake:	`QT += gui`
Inherited By:	QAccessibleAnnouncementEvent, QAccessibleStateChangeEvent, QAccessibleTableModelChangeEvent, QAccessibleTextCursorEvent, and QAccessibleValueChangeEvent

List of all members, including inherited members
QAccessibleEvent is part of Accessibility Classes.

Public Functions

	QAccessibleEvent(QAccessibleInterface *interface, QAccessible::Event type)
	QAccessibleEvent(QObject *object, QAccessible::Event type)
virtual	~QAccessibleEvent()
virtual QAccessibleInterface *	accessibleInterface() const
int	child() const
QObject *	object() const
void	setChild(int child)
QAccessible::Event	type() const

Detailed Description

This class is used with QAccessible::updateAccessibility().

The event type is one of the values of QAccessible::Event. There are a number of subclasses that should be used to provide more details about the event.

For example to notify about a focus change when re-implementing QWidget::setFocus, the event could be used as follows:

void MyWidget::setFocus(Qt::FocusReason reason)
{
    // handle custom focus setting...
    QAccessibleEvent event(f, QAccessible::Focus);
    QAccessible::updateAccessibility(&event);
}

To enable in process screen readers, all events must be sent after the change has happened.

Member Function Documentation

QAccessibleEvent::QAccessibleEvent(QAccessibleInterface **interface, QAccessible::Event type*)

Constructs a QAccessibleEvent to notify that interface has changed. The event type describes what changed. Use this function if you already have a QAccessibleInterface or no QObject, otherwise consider the overload taking a QObject parameter as it might be cheaper.

QAccessibleEvent::QAccessibleEvent(QObject **object, QAccessible::Event type*)

Constructs a QAccessibleEvent to notify that object has changed. The event type describes what changed.

`[virtual noexcept]` QAccessibleEvent::~QAccessibleEvent()

Destroys the event.

`[virtual]` QAccessibleInterface *QAccessibleEvent::accessibleInterface() const

Returns the QAccessibleInterface associated with the event.

int QAccessibleEvent::child() const

Returns the child index.

See also setChild().

QObject *QAccessibleEvent::object() const

Returns the event object.

void QAccessibleEvent::setChild(int child)

Sets the child index to child.

See also child().

QAccessible::Event QAccessibleEvent::type() const

Returns the event type.

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.