QAccessible: rename AnnouncementPriority to AnnouncementPoliteness

Better name given the value names, as discussed during header review.
Keep AnnouncementPriority as an alias until dependencies are updated.

Change-Id: I7b60c429fb60fc30378a9560da12abb87499225f
Reviewed-by: Michael Weghorn <m.weghorn@posteo.de>
Reviewed-by: Jan Arve Sæther <jan-arve.saether@qt.io>
(cherry picked from commit bb305e63ff856a8c6f9649a27a5eabfb31df8aa7)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
Volker Hilsheimer 2024-06-14 12:41:47 +02:00 committed by Qt Cherry-pick Bot
parent b2f8a7b6a8
commit 5cb79f8850
7 changed files with 29 additions and 25 deletions

View File

@ -954,8 +954,8 @@ void AtSpiAdaptor::sendAnnouncement(QAccessibleAnnouncementEvent *event)
const QString path = pathForInterface(iface);
const QString message = event->message();
const QAccessible::AnnouncementPriority prio = event->priority();
const int politeness = (prio == QAccessible::AnnouncementPriority::Assertive) ? ATSPI_LIVE_ASSERTIVE : ATSPI_LIVE_POLITE;
const QAccessible::AnnouncementPoliteness prio = event->politeness();
const int politeness = (prio == QAccessible::AnnouncementPoliteness::Assertive) ? ATSPI_LIVE_ASSERTIVE : ATSPI_LIVE_POLITE;
const QVariantList args = packDBusSignalArguments(QString(), politeness, 0, QVariant::fromValue(QDBusVariant(message)));
sendDBusSignal(path, ATSPI_DBUS_INTERFACE_EVENT_OBJECT ""_L1, "Announcement"_L1, args);

View File

@ -452,20 +452,20 @@ Q_LOGGING_CATEGORY(lcAccessibilityCore, "qt.accessibility.core");
\sa QAccessibleAttributesInterface
*/
/*! \enum QAccessible::AnnouncementPriority
/*! \enum QAccessible::AnnouncementPoliteness
This enum describes the priority for announcements used by the
\l QAccessibleAnnouncementEvent.
\since 6.8
With \a QAccessible::AnouncementPriority::Polite, assistive technologies
With \a QAccessible::AnouncementPoliteness::Polite, assistive technologies
should announce the message at the next graceful opportunity such as at the
end of speaking the current sentence or when the user pauses typing.
When specifying \a QAccessible::AnouncementPriority::Assertive, assistive
When specifying \a QAccessible::AnouncementPoliteness::Assertive, assistive
technologies should notify the user immediately.
Because an interruption might disorient users or cause them to not complete
their current task, \a QAccessible::AnouncementPriority::Assertive should
their current task, \a QAccessible::AnouncementPoliteness::Assertive should
not be used unless the interruption is imperative.
\value Polite The announcement has normal priority.
@ -1827,17 +1827,19 @@ QAccessibleTextSelectionEvent::~QAccessibleTextSelectionEvent()
/*! \fn QAccessibleAnnouncementEvent::QAccessibleAnnouncementEvent(QObject *object, const QString &message)
Constructs a new QAccessibleAnnouncementEvent event for \a object
to request the announcement of \a message with priority \l QAccessible::AnnouncementPriority::Polite.
to request the announcement of \a message with politeness
\l QAccessible::AnnouncementPoliteness::Polite.
\l QAccessibleAnnouncementEvent::setPriority can be used to adjust the priority.
\l QAccessibleAnnouncementEvent::setPoliteness can be used to adjust the politeness.
*/
/*! \fn QAccessibleAnnouncementEvent::QAccessibleAnnouncementEvent(QAccessibleInterface *iface, const QString &message)
Constructs a new QAccessibleAnnouncementEvent event for \a iface
to request the announcement of \a message with priority \l QAccessible::AnnouncementPriority::Polite.
to request the announcement of \a message with politeness
\l QAccessible::AnnouncementPoliteness::Polite.
\l QAccessibleAnnouncementEvent::setPriority can be used to adjust the priority.
\l QAccessibleAnnouncementEvent::setPoliteness can be used to adjust the politeness.
*/
/*! \fn QString QAccessibleAnnouncementEvent::message() const
@ -1845,14 +1847,14 @@ QAccessibleTextSelectionEvent::~QAccessibleTextSelectionEvent()
Returns the message.
*/
/*! \fn QAccessible::AnnouncementPriority QAccessibleAnnouncementEvent::priority() const
/*! \fn QAccessible::AnnouncementPoliteness QAccessibleAnnouncementEvent::politeness() const
Returns the priority.
Returns the politeness.
*/
/*! \fn void QAccessibleAnnouncementEvent::setPriority(QAccessible::AnnouncementPriority priority)
/*! \fn void QAccessibleAnnouncementEvent::setPoliteness(QAccessible::AnnouncementPoliteness politeness)
Sets the priority with which the announcement will be requested to \a priority.
Sets the politeness with which the announcement will be requested to \a politeness.
*/

View File

@ -613,7 +613,7 @@ public:
inline QAccessibleAnnouncementEvent(QObject *object, const QString &message)
: QAccessibleEvent(object, QAccessible::InvalidEvent)
, m_message(message)
, m_priority(QAccessible::AnnouncementPriority::Polite)
, m_politeness(QAccessible::AnnouncementPoliteness::Polite)
{
m_type = QAccessible::Announcement;
}
@ -621,7 +621,7 @@ public:
inline QAccessibleAnnouncementEvent(QAccessibleInterface *iface, const QString &message)
: QAccessibleEvent(iface, QAccessible::InvalidEvent)
, m_message(message)
, m_priority(QAccessible::AnnouncementPriority::Polite)
, m_politeness(QAccessible::AnnouncementPoliteness::Polite)
{
m_type = QAccessible::Announcement;
}
@ -629,12 +629,12 @@ public:
~QAccessibleAnnouncementEvent();
QString message() const { return m_message; }
QAccessible::AnnouncementPriority priority() const { return m_priority; }
void setPriority(QAccessible::AnnouncementPriority priority) { m_priority = priority; };
QAccessible::AnnouncementPoliteness politeness() const { return m_politeness; }
void setPoliteness(QAccessible::AnnouncementPoliteness politeness) { m_politeness = politeness; };
protected:
QString m_message;
QAccessible::AnnouncementPriority m_priority;
QAccessible::AnnouncementPoliteness m_politeness;
};
#ifndef Q_QDOC

View File

@ -370,11 +370,13 @@ public:
Level,
};
enum class AnnouncementPriority {
enum class AnnouncementPoliteness {
Polite,
Assertive
};
Q_ENUM(AnnouncementPriority)
Q_ENUM(AnnouncementPoliteness)
// ### remove once qtdeclarative dependencies are up-to-date
using AnnouncementPriority = AnnouncementPoliteness;
typedef QAccessibleInterface*(*InterfaceFactory)(const QString &key, QObject*);
typedef void(*UpdateHandler)(QAccessibleEvent *event);

View File

@ -38,7 +38,7 @@ void QCocoaAccessibility::notifyAccessibilityUpdate(QAccessibleEvent *event)
switch (event->type()) {
case QAccessible::Announcement: {
auto *announcementEvent = static_cast<QAccessibleAnnouncementEvent *>(event);
auto priorityLevel = (announcementEvent->priority() == QAccessible::AnnouncementPriority::Assertive)
auto priorityLevel = (announcementEvent->politeness() == QAccessible::AnnouncementPoliteness::Assertive)
? NSAccessibilityPriorityHigh
: NSAccessibilityPriorityMedium;
NSDictionary *announcementInfo = @{

View File

@ -210,8 +210,8 @@ void QWindowsUiaMainProvider::raiseNotification(QAccessibleAnnouncementEvent *ev
if (QAccessibleInterface *accessible = event->accessibleInterface()) {
if (QWindowsUiaMainProvider *provider = providerForAccessible(accessible)) {
BSTR message = bStrFromQString(event->message());
QAccessible::AnnouncementPriority prio = event->priority();
NotificationProcessing processing = (prio == QAccessible::AnnouncementPriority::Assertive)
QAccessible::AnnouncementPoliteness prio = event->politeness();
NotificationProcessing processing = (prio == QAccessible::AnnouncementPoliteness::Assertive)
? NotificationProcessing_ImportantAll
: NotificationProcessing_All;
BSTR activityId = bStrFromQString(QString::fromLatin1(""));

View File

@ -237,7 +237,7 @@ private:
else
newEvent = new QAccessibleAnnouncementEvent(event->accessibleInterface(),
oldEvent->message());
newEvent->setPriority(oldEvent->priority());
newEvent->setPoliteness(oldEvent->politeness());
ev = newEvent;
} else {
if (event->object())