QAccessibleWidget Class

The QAccessibleWidget class implements the QAccessibleInterface for QWidgets. More...

Header: #include <QAccessibleWidget>
CMake: find_package(Qt6 REQUIRED COMPONENTS Widgets)
target_link_libraries(mytarget PRIVATE Qt6::Widgets)
qmake: QT += widgets
Inherits: QAccessibleObject and QAccessibleActionInterface

Public Functions

QAccessibleWidget(QWidget *w, QAccessible::Role role = QAccessible::Client, const QString &name = QString())

Reimplemented Public Functions

virtual QStringList actionNames() const override
virtual QColor backgroundColor() const override
virtual QAccessibleInterface *child(int index) const override
virtual int childCount() const override
virtual void doAction(const QString &actionName) override
virtual QAccessibleInterface *focusChild() const override
virtual QColor foregroundColor() const override
virtual int indexOfChild(const QAccessibleInterface *child) const override
virtual void *interface_cast(QAccessible::InterfaceType t) override
virtual bool isValid() const override
virtual QStringList keyBindingsForAction(const QString &actionName) const override
virtual QAccessibleInterface *parent() const override
virtual QRect rect() const override
virtual QList<QPair<QAccessibleInterface *, QAccessible::Relation>> relations(QAccessible::Relation match = QAccessible::AllRelations) const override
virtual QAccessible::Role role() const override
virtual QAccessible::State state() const override
virtual QString text(QAccessible::Text t) const override
virtual QWindow *window() const override

Protected Functions

virtual ~QAccessibleWidget()
void addControllingSignal(const QString &signal)
QObject *parentObject() const
QWidget *widget() const

Detailed Description

This class is part of Accessibility for QWidget Applications.

This class is convenient to use as a base class for custom implementations of QAccessibleInterfaces that provide information about widget objects.

The class provides functions to retrieve the parentObject() (the widget's parent widget), and the associated widget(). Controlling signals can be added with addControllingSignal(), and setters are provided for various aspects of the interface implementation, for example setValue(), setDescription(), setAccelerator(), and setHelp().

See also QAccessible and QAccessibleObject.

Member Function Documentation

[explicit] QAccessibleWidget::QAccessibleWidget(QWidget *w, QAccessible::Role role = QAccessible::Client, const QString &name = QString())

Creates a QAccessibleWidget object for widget w. role and name are optional parameters that set the object's role and name properties.

[virtual noexcept protected] QAccessibleWidget::~QAccessibleWidget()

Destroys this object.

[override virtual] QStringList QAccessibleWidget::actionNames() const

Reimplements: QAccessibleActionInterface::actionNames() const.

[protected] void QAccessibleWidget::addControllingSignal(const QString &signal)

Registers signal as a controlling signal.

An object is a Controller to any other object connected to a controlling signal.

[override virtual] QColor QAccessibleWidget::backgroundColor() const

Reimplements: QAccessibleInterface::backgroundColor() const.

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

Reimplements: QAccessibleInterface::child(int index) const.

[override virtual] int QAccessibleWidget::childCount() const

Reimplements: QAccessibleInterface::childCount() const.

[override virtual] void QAccessibleWidget::doAction(const QString &actionName)

Reimplements: QAccessibleActionInterface::doAction(const QString &actionName).

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

Reimplements: QAccessibleInterface::focusChild() const.

[override virtual] QColor QAccessibleWidget::foregroundColor() const

Reimplements: QAccessibleInterface::foregroundColor() const.

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

Reimplements: QAccessibleInterface::indexOfChild(const QAccessibleInterface *child) const.

[override virtual] void *QAccessibleWidget::interface_cast(QAccessible::InterfaceType t)

Reimplements: QAccessibleInterface::interface_cast(QAccessible::InterfaceType type).

[override virtual] bool QAccessibleWidget::isValid() const

Reimplements: QAccessibleObject::isValid() const.

[override virtual] QStringList QAccessibleWidget::keyBindingsForAction(const QString &actionName) const

Reimplements: QAccessibleActionInterface::keyBindingsForAction(const QString &actionName) const.

[override virtual] QAccessibleInterface *QAccessibleWidget::parent() const

Reimplements: QAccessibleInterface::parent() const.

[protected] QObject *QAccessibleWidget::parentObject() const

Returns the associated widget's parent object, which is either the parent widget, or qApp for top-level widgets.

[override virtual] QRect QAccessibleWidget::rect() const

Reimplements: QAccessibleObject::rect() const.

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

Reimplements: QAccessibleInterface::relations(QAccessible::Relation match) const.

[override virtual] QAccessible::Role QAccessibleWidget::role() const

Reimplements: QAccessibleInterface::role() const.

[override virtual] QAccessible::State QAccessibleWidget::state() const

Reimplements: QAccessibleInterface::state() const.

[override virtual] QString QAccessibleWidget::text(QAccessible::Text t) const

Reimplements: QAccessibleInterface::text(QAccessible::Text t) const.

[protected] QWidget *QAccessibleWidget::widget() const

Returns the associated widget.

[override virtual] QWindow *QAccessibleWidget::window() const

Reimplements: QAccessibleInterface::window() const.

© 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.