1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: Nokia Corporation (qt-info@nokia.com)
7 ** This file is part of the QtGui module of the Qt Toolkit.
9 ** $QT_BEGIN_LICENSE:LGPL$
10 ** GNU Lesser General Public License Usage
11 ** This file may be used under the terms of the GNU Lesser General Public
12 ** License version 2.1 as published by the Free Software Foundation and
13 ** appearing in the file LICENSE.LGPL included in the packaging of this
14 ** file. Please review the following information to ensure the GNU Lesser
15 ** General Public License version 2.1 requirements will be met:
16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
18 ** In addition, as a special exception, Nokia gives you certain additional
19 ** rights. These rights are described in the Nokia Qt LGPL Exception
20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
22 ** GNU General Public License Usage
23 ** Alternatively, this file may be used under the terms of the GNU General
24 ** Public License version 3.0 as published by the Free Software Foundation
25 ** and appearing in the file LICENSE.GPL included in the packaging of this
26 ** file. Please review the following information to ensure the GNU General
27 ** Public License version 3.0 requirements will be met:
28 ** http://www.gnu.org/copyleft/gpl.html.
31 ** Alternatively, this file may be used in accordance with the terms and
32 ** conditions contained in a signed written agreement between you and Nokia.
40 ****************************************************************************/
42 #include "qaccessible.h"
44 #ifndef QT_NO_ACCESSIBILITY
45 #include "qaccessible_mac_p.h"
49 #include "qapplication.h"
50 #include "qmainwindow.h"
51 #include "qtextdocument.h"
53 #include "qabstractslider.h"
54 #include "qsplitter.h"
55 #include "qtabwidget.h"
56 #include "qlistview.h"
57 #include "qtableview.h"
58 #include "qdockwidget.h"
60 #include <private/qt_mac_p.h>
61 #include <private/qwidget_p.h>
62 #include <CoreFoundation/CoreFoundation.h>
67 Set up platform defines. There is a one-to-one correspondence between the
68 Carbon and Cocoa roles and attributes, but the prefix and type changes.
70 #ifdef QT_MAC_USE_COCOA
71 typedef NSString * const QAXRoleType;
72 #define QAXApplicationRole NSAccessibilityApplicationRole
73 #define QAXButtonRole NSAccessibilityButtonRole
74 #define QAXCancelAction NSAccessibilityCancelAction
75 #define QAXCheckBoxRole NSAccessibilityCheckBoxRole
76 #define QAXChildrenAttribute NSAccessibilityChildrenAttribute
77 #define QAXCloseButtonAttribute NSAccessibilityCloseButtonAttribute
78 #define QAXCloseButtonAttribute NSAccessibilityCloseButtonAttribute
79 #define QAXColumnRole NSAccessibilityColumnRole
80 #define QAXConfirmAction NSAccessibilityConfirmAction
81 #define QAXContentsAttribute NSAccessibilityContentsAttribute
82 #define QAXDecrementAction NSAccessibilityDecrementAction
83 #define QAXDecrementArrowSubrole NSAccessibilityDecrementArrowSubrole
84 #define QAXDecrementPageSubrole NSAccessibilityDecrementPageSubrole
85 #define QAXDescriptionAttribute NSAccessibilityDescriptionAttribute
86 #define QAXEnabledAttribute NSAccessibilityEnabledAttribute
87 #define QAXExpandedAttribute NSAccessibilityExpandedAttribute
88 #define QAXFocusedAttribute NSAccessibilityFocusedAttribute
89 #define QAXFocusedUIElementChangedNotification NSAccessibilityFocusedUIElementChangedNotification
90 #define QAXFocusedWindowChangedNotification NSAccessibilityFocusedWindowChangedNotification
91 #define QAXGroupRole NSAccessibilityGroupRole
92 #define QAXGrowAreaAttribute NSAccessibilityGrowAreaAttribute
93 #define QAXGrowAreaRole NSAccessibilityGrowAreaRole
94 #define QAXHelpAttribute NSAccessibilityHelpAttribute
95 #define QAXHorizontalOrientationValue NSAccessibilityHorizontalOrientationValue
96 #define QAXHorizontalScrollBarAttribute NSAccessibilityHorizontalScrollBarAttribute
97 #define QAXIncrementAction NSAccessibilityIncrementAction
98 #define QAXIncrementArrowSubrole NSAccessibilityIncrementArrowSubrole
99 #define QAXIncrementPageSubrole NSAccessibilityIncrementPageSubrole
100 #define QAXIncrementorRole NSAccessibilityIncrementorRole
101 #define QAXLinkedUIElementsAttribute NSAccessibilityLinkedUIElementsAttribute
102 #define QAXListRole NSAccessibilityListRole
103 #define QAXMainAttribute NSAccessibilityMainAttribute
104 #define QAXMaxValueAttribute NSAccessibilityMaxValueAttribute
105 #define QAXMenuBarRole NSAccessibilityMenuBarRole
106 #define QAXMenuButtonRole NSAccessibilityMenuButtonRole
107 #define QAXMenuClosedNotification NSAccessibilityMenuClosedNotification
108 #define QAXMenuItemRole NSAccessibilityMenuItemRole
109 #define QAXMenuOpenedNotification NSAccessibilityMenuOpenedNotification
110 #define QAXMenuRole NSAccessibilityMenuRole
111 #define QAXMinValueAttribute NSAccessibilityMinValueAttribute
112 #define QAXMinimizeButtonAttribute NSAccessibilityMinimizeButtonAttribute
113 #define QAXMinimizedAttribute NSAccessibilityMinimizedAttribute
114 #define QAXNextContentsAttribute NSAccessibilityNextContentsAttribute
115 #define QAXOrientationAttribute NSAccessibilityOrientationAttribute
116 #define QAXParentAttribute NSAccessibilityParentAttribute
117 #define QAXPickAction NSAccessibilityPickAction
118 #define QAXPopUpButtonRole NSAccessibilityPopUpButtonRole
119 #define QAXPositionAttribute NSAccessibilityPositionAttribute
120 #define QAXPressAction NSAccessibilityPressAction
121 #define QAXPreviousContentsAttribute NSAccessibilityPreviousContentsAttribute
122 #define QAXProgressIndicatorRole NSAccessibilityProgressIndicatorRole
123 #define QAXRadioButtonRole NSAccessibilityRadioButtonRole
124 #define QAXRoleAttribute NSAccessibilityRoleAttribute
125 #define QAXRoleDescriptionAttribute NSAccessibilityRoleDescriptionAttribute
126 #define QAXRowRole NSAccessibilityRowRole
127 #define QAXRowsAttribute NSAccessibilityRowsAttribute
128 #define QAXScrollAreaRole NSAccessibilityScrollAreaRole
129 #define QAXScrollBarRole NSAccessibilityScrollBarRole
130 #define QAXSelectedAttribute NSAccessibilitySelectedAttribute
131 #define QAXSelectedChildrenAttribute NSAccessibilitySelectedChildrenAttribute
132 #define QAXSelectedRowsAttribute NSAccessibilitySelectedRowsAttribute
133 #define QAXSizeAttribute NSAccessibilitySizeAttribute
134 #define QAXSliderRole NSAccessibilitySliderRole
135 #define QAXSplitGroupRole NSAccessibilitySplitGroupRole
136 #define QAXSplitterRole NSAccessibilitySplitterRole
137 #define QAXSplittersAttribute NSAccessibilitySplittersAttribute
138 #define QAXStaticTextRole NSAccessibilityStaticTextRole
139 #define QAXSubroleAttribute NSAccessibilitySubroleAttribute
140 #define QAXSubroleAttribute NSAccessibilitySubroleAttribute
141 #define QAXTabGroupRole NSAccessibilityTabGroupRole
142 #define QAXTableRole NSAccessibilityTableRole
143 #define QAXTabsAttribute NSAccessibilityTabsAttribute
144 #define QAXTextFieldRole NSAccessibilityTextFieldRole
145 #define QAXTitleAttribute NSAccessibilityTitleAttribute
146 #define QAXTitleUIElementAttribute NSAccessibilityTitleUIElementAttribute
147 #define QAXToolbarButtonAttribute NSAccessibilityToolbarButtonAttribute
148 #define QAXToolbarRole NSAccessibilityToolbarRole
149 #define QAXTopLevelUIElementAttribute NSAccessibilityTopLevelUIElementAttribute
150 #define QAXUnknownRole NSAccessibilityUnknownRole
151 #define QAXValueAttribute NSAccessibilityValueAttribute
152 #define QAXValueChangedNotification NSAccessibilityValueChangedNotification
153 #define QAXValueIndicatorRole NSAccessibilityValueIndicatorRole
154 #define QAXVerticalOrientationValue NSAccessibilityVerticalOrientationValue
155 #define QAXVerticalScrollBarAttribute NSAccessibilityVerticalScrollBarAttribute
156 #define QAXVisibleRowsAttribute NSAccessibilityVisibleRowsAttribute
157 #define QAXWindowAttribute NSAccessibilityWindowAttribute
158 #define QAXWindowCreatedNotification NSAccessibilityWindowCreatedNotification
159 #define QAXWindowMovedNotification NSAccessibilityWindowMovedNotification
160 #define QAXWindowRole NSAccessibilityWindowRole
161 #define QAXZoomButtonAttribute NSAccessibilityZoomButtonAttribute
163 typedef CFStringRef const QAXRoleType;
164 #define QAXApplicationRole kAXApplicationRole
165 #define QAXButtonRole kAXButtonRole
166 #define QAXCancelAction kAXCancelAction
167 #define QAXCheckBoxRole kAXCheckBoxRole
168 #define QAXChildrenAttribute kAXChildrenAttribute
169 #define QAXCloseButtonAttribute kAXCloseButtonAttribute
170 #define QAXColumnRole kAXColumnRole
171 #define QAXConfirmAction kAXConfirmAction
172 #define QAXContentsAttribute kAXContentsAttribute
173 #define QAXDecrementAction kAXDecrementAction
174 #define QAXDecrementArrowSubrole kAXDecrementArrowSubrole
175 #define QAXDecrementPageSubrole kAXDecrementPageSubrole
176 #define QAXDescriptionAttribute kAXDescriptionAttribute
177 #define QAXEnabledAttribute kAXEnabledAttribute
178 #define QAXExpandedAttribute kAXExpandedAttribute
179 #define QAXFocusedAttribute kAXFocusedAttribute
180 #define QAXFocusedUIElementChangedNotification kAXFocusedUIElementChangedNotification
181 #define QAXFocusedWindowChangedNotification kAXFocusedWindowChangedNotification
182 #define QAXGroupRole kAXGroupRole
183 #define QAXGrowAreaAttribute kAXGrowAreaAttribute
184 #define QAXGrowAreaRole kAXGrowAreaRole
185 #define QAXHelpAttribute kAXHelpAttribute
186 #define QAXHorizontalOrientationValue kAXHorizontalOrientationValue
187 #define QAXHorizontalScrollBarAttribute kAXHorizontalScrollBarAttribute
188 #define QAXIncrementAction kAXIncrementAction
189 #define QAXIncrementArrowSubrole kAXIncrementArrowSubrole
190 #define QAXIncrementPageSubrole kAXIncrementPageSubrole
191 #define QAXIncrementorRole kAXIncrementorRole
192 #define QAXLinkedUIElementsAttribute kAXLinkedUIElementsAttribute
193 #define QAXListRole kAXListRole
194 #define QAXMainAttribute kAXMainAttribute
195 #define QAXMaxValueAttribute kAXMaxValueAttribute
196 #define QAXMenuBarRole kAXMenuBarRole
197 #define QAXMenuButtonRole kAXMenuButtonRole
198 #define QAXMenuClosedNotification kAXMenuClosedNotification
199 #define QAXMenuItemRole kAXMenuItemRole
200 #define QAXMenuOpenedNotification kAXMenuOpenedNotification
201 #define QAXMenuRole kAXMenuRole
202 #define QAXMinValueAttribute kAXMinValueAttribute
203 #define QAXMinimizeButtonAttribute kAXMinimizeButtonAttribute
204 #define QAXMinimizedAttribute kAXMinimizedAttribute
205 #define QAXNextContentsAttribute kAXNextContentsAttribute
206 #define QAXOrientationAttribute kAXOrientationAttribute
207 #define QAXParentAttribute kAXParentAttribute
208 #define QAXPickAction kAXPickAction
209 #define QAXPopUpButtonRole kAXPopUpButtonRole
210 #define QAXPositionAttribute kAXPositionAttribute
211 #define QAXPressAction kAXPressAction
212 #define QAXPreviousContentsAttribute kAXPreviousContentsAttribute
213 #define QAXProgressIndicatorRole kAXProgressIndicatorRole
214 #define QAXRadioButtonRole kAXRadioButtonRole
215 #define QAXRoleAttribute kAXRoleAttribute
216 #define QAXRoleDescriptionAttribute kAXRoleDescriptionAttribute
217 #define QAXRowRole kAXRowRole
218 #define QAXRowsAttribute kAXRowsAttribute
219 #define QAXScrollAreaRole kAXScrollAreaRole
220 #define QAXScrollBarRole kAXScrollBarRole
221 #define QAXSelectedAttribute kAXSelectedAttribute
222 #define QAXSelectedChildrenAttribute kAXSelectedChildrenAttribute
223 #define QAXSelectedRowsAttribute kAXSelectedRowsAttribute
224 #define QAXSizeAttribute kAXSizeAttribute
225 #define QAXSliderRole kAXSliderRole
226 #define QAXSplitGroupRole kAXSplitGroupRole
227 #define QAXSplitterRole kAXSplitterRole
228 #define QAXSplittersAttribute kAXSplittersAttribute
229 #define QAXStaticTextRole kAXStaticTextRole
230 #define QAXSubroleAttribute kAXSubroleAttribute
231 #define QAXTabGroupRole kAXTabGroupRole
232 #define QAXTableRole kAXTableRole
233 #define QAXTabsAttribute kAXTabsAttribute
234 #define QAXTextFieldRole kAXTextFieldRole
235 #define QAXTitleAttribute kAXTitleAttribute
236 #define QAXTitleUIElementAttribute kAXTitleUIElementAttribute
237 #define QAXToolbarButtonAttribute kAXToolbarButtonAttribute
238 #define QAXToolbarRole kAXToolbarRole
239 #define QAXTopLevelUIElementAttribute kAXTopLevelUIElementAttribute
240 #define QAXUnknownRole kAXUnknownRole
241 #define QAXValueAttribute kAXValueAttribute
242 #define QAXValueChangedNotification kAXValueChangedNotification
243 #define QAXValueIndicatorRole kAXValueIndicatorRole
244 #define QAXVerticalOrientationValue kAXVerticalOrientationValue
245 #define QAXVerticalScrollBarAttribute kAXVerticalScrollBarAttribute
246 #define QAXVisibleRowsAttribute kAXVisibleRowsAttribute
247 #define QAXWindowAttribute kAXWindowAttribute
248 #define QAXWindowCreatedNotification kAXWindowCreatedNotification
249 #define QAXWindowMovedNotification kAXWindowMovedNotification
250 #define QAXWindowRole kAXWindowRole
251 #define QAXZoomButtonAttribute kAXZoomButtonAttribute
255 /*****************************************************************************
257 *****************************************************************************/
258 extern bool qt_mac_is_macsheet(const QWidget *w); //qwidget_mac.cpp
259 extern bool qt_mac_is_macdrawer(const QWidget *w); //qwidget_mac.cpp
261 /*****************************************************************************
263 *****************************************************************************/
264 //hardcoded bindings between control info and (known) QWidgets
265 struct QAccessibleTextBinding {
269 } text_bindings[][10] = {
270 { { QAccessible::MenuItem, QAXMenuItemRole, false },
273 { { QAccessible::MenuBar, QAXMenuBarRole, false },
276 { { QAccessible::ScrollBar, QAXScrollBarRole, false },
279 { { QAccessible::Grip, QAXGrowAreaRole, false },
282 { { QAccessible::Window, QAXWindowRole, false },
285 { { QAccessible::Dialog, QAXWindowRole, false },
288 { { QAccessible::AlertMessage, QAXWindowRole, false },
291 { { QAccessible::ToolTip, QAXWindowRole, false },
294 { { QAccessible::HelpBalloon, QAXWindowRole, false },
297 { { QAccessible::PopupMenu, QAXMenuRole, false },
300 { { QAccessible::Application, QAXApplicationRole, false },
303 { { QAccessible::Pane, QAXGroupRole, false },
306 { { QAccessible::Grouping, QAXGroupRole, false },
309 { { QAccessible::Separator, QAXSplitterRole, false },
312 { { QAccessible::ToolBar, QAXToolbarRole, false },
315 { { QAccessible::PageTab, QAXRadioButtonRole, false },
318 { { QAccessible::ButtonMenu, QAXMenuButtonRole, false },
321 { { QAccessible::ButtonDropDown, QAXPopUpButtonRole, false },
324 { { QAccessible::SpinBox, QAXIncrementorRole, false },
327 { { QAccessible::Slider, QAXSliderRole, false },
330 { { QAccessible::ProgressBar, QAXProgressIndicatorRole, false },
333 { { QAccessible::ComboBox, QAXPopUpButtonRole, false },
336 { { QAccessible::RadioButton, QAXRadioButtonRole, false },
339 { { QAccessible::CheckBox, QAXCheckBoxRole, false },
342 { { QAccessible::StaticText, QAXStaticTextRole, false },
343 { QAccessible::Name, QAXValueAttribute, false },
346 { { QAccessible::Table, QAXTableRole, false },
349 { { QAccessible::StatusBar, QAXStaticTextRole, false },
352 { { QAccessible::Column, QAXColumnRole, false },
355 { { QAccessible::ColumnHeader, QAXColumnRole, false },
358 { { QAccessible::Row, QAXRowRole, false },
361 { { QAccessible::RowHeader, QAXRowRole, false },
364 { { QAccessible::Cell, QAXTextFieldRole, false },
367 { { QAccessible::PushButton, QAXButtonRole, false },
370 { { QAccessible::EditableText, QAXTextFieldRole, true },
373 { { QAccessible::Link, QAXTextFieldRole, false },
376 { { QAccessible::Indicator, QAXValueIndicatorRole, false },
379 { { QAccessible::Splitter, QAXSplitGroupRole, false },
382 { { QAccessible::List, QAXListRole, false },
385 { { QAccessible::ListItem, QAXStaticTextRole, false },
388 { { QAccessible::Cell, QAXStaticTextRole, false },
395 static CFStringRef macRole(const QAInterface &interface);
397 QDebug operator<<(QDebug debug, const QAInterface &interface)
399 if (interface.isValid() == false)
400 debug << "invalid interface";
402 debug << interface.object() << "id" << interface.id() << "role" << hex << interface.role();
406 // The root of the Qt accessible hiearchy.
407 static QObject *rootObject = 0;
410 bool QAInterface::operator==(const QAInterface &other) const
412 if (isValid() == false || other.isValid() == false)
413 return (isValid() && other.isValid());
415 // walk up the parent chain, comparing child indexes, until we reach
416 // an interface that has a QObject.
417 QAInterface currentThis = *this;
418 QAInterface currentOther = other;
420 while (currentThis.object() == 0) {
421 if (currentOther.object() != 0)
424 // fail if the child indexes in the two hirearchies don't match.
425 if (currentThis.parent().indexOfChild(currentThis) !=
426 currentOther.parent().indexOfChild(currentOther))
429 currentThis = currentThis.parent();
430 currentOther = currentOther.parent();
433 return (currentThis.object() == currentOther.object() && currentThis.id() == currentOther.id());
436 bool QAInterface::operator!=(const QAInterface &other) const
438 return !operator==(other);
441 uint qHash(const QAInterface &item)
444 return qHash(item.object()) + qHash(item.id());
446 return qHash(item.cachedObject()) + qHash(item.id());
449 QAInterface QAInterface::navigate(RelationFlag relation, int entry) const
452 return QAInterface();
454 // On a QAccessibleInterface that handles its own children we can short-circut
455 // the navigation if this QAInterface refers to one of the children:
457 // The Ancestor interface will always be the same QAccessibleInterface with
458 // a child value of 0.
459 if (relation == QAccessible::Ancestor)
460 return QAInterface(*this, 0);
462 // The child hiearchy is only one level deep, so navigating to a child
463 // of a child is not possible.
464 if (relation == QAccessible::Child) {
465 return QAInterface();
468 QAccessibleInterface *child_iface = 0;
470 const int status = base.interface->navigate(relation, entry, &child_iface);
473 return QAInterface(); // not found;
475 // Check if target is a child of this interface.
477 return QAInterface(*this, status);
479 // Target is child_iface or a child of that (status decides).
480 return QAInterface(child_iface, status);
484 QAElement::QAElement()
488 QAElement::QAElement(AXUIElementRef elementRef)
489 :elementRef(elementRef)
491 if (elementRef != 0) {
492 CFRetain(elementRef);
497 QAElement::QAElement(const QAElement &element)
498 :elementRef(element.elementRef)
500 if (elementRef != 0) {
501 CFRetain(elementRef);
506 QAElement::QAElement(HIObjectRef object, int child)
508 #ifndef QT_MAC_USE_COCOA
510 elementRef = 0; // Create invalid QAElement.
512 elementRef = AXUIElementCreateWithHIObjectAndIdentifier(object, child);
521 QAElement::~QAElement()
523 if (elementRef != 0) {
525 CFRelease(elementRef);
529 void QAElement::operator=(const QAElement &other)
534 if (elementRef != 0) {
536 CFRelease(elementRef);
539 elementRef = other.elementRef;
541 if (elementRef != 0) {
542 CFRetain(elementRef);
547 bool QAElement::operator==(const QAElement &other) const
549 if (elementRef == 0 || other.elementRef == 0)
550 return (elementRef == other.elementRef);
552 return CFEqual(elementRef, other.elementRef);
555 uint qHash(QAElement element)
557 return qHash(element.object()) + qHash(element.id());
560 #ifndef QT_MAC_USE_COCOA
561 static QInterfaceFactory *createFactory(const QAInterface &interface);
563 Q_GLOBAL_STATIC(QAccessibleHierarchyManager, accessibleHierarchyManager);
566 Reomves all accessibility info accosiated with the sender object.
568 void QAccessibleHierarchyManager::objectDestroyed(QObject *object)
570 HIObjectRef hiObject = qobjectHiobjectHash.value(object);
571 delete qobjectElementHash.value(object);
572 qobjectElementHash.remove(object);
573 hiobjectInterfaceHash.remove(hiObject);
577 Removes all stored items.
579 void QAccessibleHierarchyManager::reset()
581 qDeleteAll(qobjectElementHash);
582 qobjectElementHash.clear();
583 hiobjectInterfaceHash.clear();
584 qobjectHiobjectHash.clear();
587 QAccessibleHierarchyManager *QAccessibleHierarchyManager::instance()
589 return accessibleHierarchyManager();
592 #ifndef QT_MAC_USE_COCOA
593 static bool isItemView(const QAInterface &interface)
595 QObject *object = interface.object();
596 return (interface.role() == QAccessible::List || interface.role() == QAccessible::Table
597 || (object && qobject_cast<QAbstractItemView *>(interface.object()))
598 || (object && object->objectName() == QLatin1String("qt_scrollarea_viewport")
599 && qobject_cast<QAbstractItemView *>(object->parent())));
603 static bool isTabWidget(const QAInterface &interface)
605 if (QObject *object = interface.object())
606 return (object->inherits("QTabWidget") && interface.id() == 0);
610 static bool isStandaloneTabBar(const QAInterface &interface)
612 QObject *object = interface.object();
613 if (interface.role() == QAccessible::PageTabList && object)
614 return (qobject_cast<QTabWidget *>(object->parent()) == 0);
619 static bool isEmbeddedTabBar(const QAInterface &interface)
621 QObject *object = interface.object();
622 if (interface.role() == QAccessible::PageTabList && object)
623 return (qobject_cast<QTabWidget *>(object->parent()));
629 Decides if a QAInterface is interesting from an accessibility users point of view.
631 bool isItInteresting(const QAInterface &interface)
633 // Mac accessibility does not have an attribute that corresponds to the Invisible/Offscreen
634 // state, so we disable the interface here.
635 const QAccessible::State state = interface.state();
636 if (state & QAccessible::Invisible ||
637 state & QAccessible::Offscreen )
640 const QAccessible::Role role = interface.role();
642 if (QObject * const object = interface.object()) {
643 const QString className = QLatin1String(object->metaObject()->className());
645 // VoiceOver focusing on tool tips can be confusing. The contents of the
646 // tool tip is avalible through the description attribute anyway, so
647 // we disable accessibility for tool tips.
648 if (className == QLatin1String("QTipLabel"))
651 // Hide TabBars that has a QTabWidget parent (the tab widget handles the accessibility)
652 if (isEmbeddedTabBar(interface))
655 // Hide docked dockwidgets. ### causes infinitie loop in the apple accessibility code.
656 /* if (QDockWidget *dockWidget = qobject_cast<QDockWidget *>(object)) {
657 if (dockWidget->isFloating() == false)
663 // Client is a generic role returned by plain QWidgets or other
664 // widgets that does not have separate QAccessible interface, such
665 // as the TabWidget. Return false unless macRole gives the interface
667 if (role == QAccessible::Client && macRole(interface) == CFStringRef(QAXUnknownRole))
670 // Some roles are not interesting:
671 if (role == QAccessible::Border || // QFrame
672 role == QAccessible::Application || // We use the system-provided application element.
673 role == QAccessible::MenuItem) // The system also provides the menu items.
676 // It is probably better to access the toolbar buttons directly than having
677 // to navigate through the toolbar.
678 if (role == QAccessible::ToolBar)
684 QAElement QAccessibleHierarchyManager::registerInterface(QObject *object, int child)
686 #ifndef QT_MAC_USE_COCOA
687 return registerInterface(QAInterface(QAccessible::queryAccessibleInterface(object), child));
696 Creates a QAXUIelement that corresponds to the given QAInterface.
698 QAElement QAccessibleHierarchyManager::registerInterface(const QAInterface &interface)
700 #ifndef QT_MAC_USE_COCOA
701 if (interface.isValid() == false)
703 QAInterface objectInterface = interface.objectInterface();
705 QObject * qobject = objectInterface.object();
706 HIObjectRef hiobject = objectInterface.hiObject();
707 if (qobject == 0 || hiobject == 0)
710 if (qobjectElementHash.contains(qobject) == false) {
711 registerInterface(qobject, hiobject, createFactory(interface));
712 HIObjectSetAccessibilityIgnored(hiobject, !isItInteresting(interface));
715 return QAElement(hiobject, interface.id());
722 #ifndef QT_MAC_USE_COCOA
723 #include "qaccessible_mac_carbon.cpp"
726 void QAccessibleHierarchyManager::registerInterface(QObject * qobject, HIObjectRef hiobject, QInterfaceFactory *interfaceFactory)
728 #ifndef QT_MAC_USE_COCOA
729 if (qobjectElementHash.contains(qobject) == false) {
730 qobjectElementHash.insert(qobject, interfaceFactory);
731 qobjectHiobjectHash.insert(qobject, hiobject);
732 connect(qobject, SIGNAL(destroyed(QObject *)), SLOT(objectDestroyed(QObject *)));
735 if (hiobjectInterfaceHash.contains(hiobject) == false) {
736 hiobjectInterfaceHash.insert(hiobject, interfaceFactory);
737 installAcessibilityEventHandler(hiobject);
742 Q_UNUSED(interfaceFactory);
746 void QAccessibleHierarchyManager::registerChildren(const QAInterface &interface)
748 QObject * const object = interface.object();
752 QInterfaceFactory *interfaceFactory = qobjectElementHash.value(object);
754 if (interfaceFactory == 0)
757 interfaceFactory->registerChildren();
760 QAInterface QAccessibleHierarchyManager::lookup(const AXUIElementRef &element)
763 return QAInterface();
764 #ifndef QT_MAC_USE_COCOA
765 HIObjectRef hiObject = AXUIElementGetHIObject(element);
767 QInterfaceFactory *factory = hiobjectInterfaceHash.value(hiObject);
769 return QAInterface();
773 AXUIElementGetIdentifier(element, &id);
774 return factory->interface(id);
776 return QAInterface();
780 QAInterface QAccessibleHierarchyManager::lookup(const QAElement &element)
782 return lookup(element.element());
785 QAElement QAccessibleHierarchyManager::lookup(const QAInterface &interface)
787 if (interface.isValid() == false)
790 QInterfaceFactory *factory = qobjectElementHash.value(interface.objectInterface().object());
794 return factory->element(interface);
797 QAElement QAccessibleHierarchyManager::lookup(QObject * const object, int id)
799 QInterfaceFactory *factory = qobjectElementHash.value(object);
803 return factory->element(id);
807 Standard interface mapping, return the stored interface
808 or HIObjectRef, and there is an one-to-one mapping between
809 the identifier and child.
811 class QStandardInterfaceFactory : public QInterfaceFactory
814 QStandardInterfaceFactory(const QAInterface &interface)
815 : m_interface(interface), object(interface.hiObject())
820 ~QStandardInterfaceFactory()
826 QAInterface interface(UInt64 identifier)
828 const int child = identifier;
829 return QAInterface(m_interface, child);
832 QAElement element(int id)
834 return QAElement(object, id);
837 QAElement element(const QAInterface &interface)
839 if (interface.object() == 0)
841 return QAElement(object, interface.id());
844 void registerChildren()
846 const int childCount = m_interface.childCount();
847 for (int i = 1; i <= childCount; ++i) {
848 accessibleHierarchyManager()->registerInterface(m_interface.navigate(QAccessible::Child, i));
853 QAInterface m_interface;
858 Interface mapping where that creates one HIObject for each interface child.
860 class QMultipleHIObjectFactory : public QInterfaceFactory
863 QMultipleHIObjectFactory(const QAInterface &interface)
864 : m_interface(interface)
867 ~QMultipleHIObjectFactory()
869 foreach (HIObjectRef object, objects) {
874 QAInterface interface(UInt64 identifier)
876 const int child = identifier;
877 return QAInterface(m_interface, child);
880 QAElement element(int child)
883 return QAElement(m_interface.hiObject(), 0);
885 if (child > objects.count())
888 return QAElement(objects.at(child - 1), child);
891 void registerChildren()
893 #ifndef QT_MAC_USE_COCOA
894 const int childCount = m_interface.childCount();
895 for (int i = 1; i <= childCount; ++i) {
896 HIObjectRef hiobject;
897 HIObjectCreate(kObjectQtAccessibility, 0, &hiobject);
898 objects.append(hiobject);
899 accessibleHierarchyManager()->registerInterface(m_interface.object(), hiobject, this);
900 HIObjectSetAccessibilityIgnored(hiobject, !isItInteresting(m_interface.navigate(QAccessible::Child, i)));
906 QAInterface m_interface;
907 QList<HIObjectRef> objects;
910 class QItemViewInterfaceFactory : public QInterfaceFactory
913 QItemViewInterfaceFactory(const QAInterface &interface)
914 : m_interface(interface), object(interface.hiObject())
918 if (QTableView * tableView = qobject_cast<QTableView *>(interface.parent().object())) {
919 if (tableView->model())
920 columnCount = tableView->model()->columnCount();
921 if (tableView->verticalHeader())
926 ~QItemViewInterfaceFactory()
931 QAInterface interface(UInt64 identifier)
936 if (m_interface.role() == QAccessible::List)
937 return m_interface.childAt(identifier);
939 if (m_interface.role() == QAccessible::Table) {
940 const int index = identifier;
942 return m_interface; // return the item view interface.
944 const int rowIndex = (index - 1) / (columnCount + 1);
945 const int cellIndex = (index - 1) % (columnCount + 1);
947 qDebug() << "index" << index;
948 qDebug() << "rowIndex" << rowIndex;
949 qDebug() << "cellIndex" << cellIndex;
951 const QAInterface rowInterface = m_interface.childAt(rowIndex + 1);
953 if ((cellIndex) == 0) // Is it a row?
956 return rowInterface.childAt(cellIndex);
960 return QAInterface();
963 QAElement element(int id)
968 return QAElement(object, 0);
971 QAElement element(const QAInterface &interface)
973 if (interface.object() && interface.object() == m_interface.object()) {
974 return QAElement(object, 0);
975 } else if (m_interface.role() == QAccessible::List) {
976 if (interface.parent().object() && interface.parent().object() == m_interface.object())
977 return QAElement(object, m_interface.indexOfChild(interface));
978 } else if (m_interface.role() == QAccessible::Table) {
979 QAInterface currentInterface = interface;
982 while (currentInterface.isValid() && currentInterface.object() == 0) {
983 const QAInterface parentInterface = currentInterface.parent();
985 qDebug() << "current index" << index;
986 qDebug() << "current interface" << interface;
988 qDebug() << "parent interface" << parentInterface;
989 qDebug() << "grandparent interface" << parentInterface.parent();
990 qDebug() << "childCount" << interface.childCount();
991 qDebug() << "index of child" << parentInterface.indexOfChild(currentInterface);
993 index += ((parentInterface.indexOfChild(currentInterface) - 1) * (currentInterface.childCount() + 1)) + 1;
994 currentInterface = parentInterface;
995 // qDebug() << "new current interface" << currentInterface;
997 if (currentInterface.object() == m_interface.object())
998 return QAElement(object, index);
1005 void registerChildren()
1007 // Item view child interfraces don't have their own qobjects, so there is nothing to register here.
1011 QAInterface m_interface;
1013 int columnCount; // for table views;
1016 #ifndef QT_MAC_USE_COCOA
1017 static bool managesChildren(const QAInterface &interface)
1019 return (interface.childCount() > 0 && interface.childAt(1).id() > 0);
1022 static QInterfaceFactory *createFactory(const QAInterface &interface)
1024 if (isItemView(interface)) {
1025 return new QItemViewInterfaceFactory(interface);
1026 } if (managesChildren(interface)) {
1027 return new QMultipleHIObjectFactory(interface);
1030 return new QStandardInterfaceFactory(interface);
1034 QList<QAElement> lookup(const QList<QAInterface> &interfaces)
1036 QList<QAElement> elements;
1037 foreach (const QAInterface &interface, interfaces)
1038 if (interface.isValid()) {
1039 const QAElement element = accessibleHierarchyManager()->lookup(interface);
1040 if (element.isValid())
1041 elements.append(element);
1046 // Debug output helpers:
1048 static QString nameForEventKind(UInt32 kind)
1051 case kEventAccessibleGetChildAtPoint: return QString("GetChildAtPoint"); break;
1052 case kEventAccessibleGetAllAttributeNames: return QString("GetAllAttributeNames"); break;
1053 case kEventAccessibleGetNamedAttribute: return QString("GetNamedAttribute"); break;
1054 case kEventAccessibleSetNamedAttribute: return QString("SetNamedAttribute"); break;
1055 case kEventAccessibleGetAllActionNames: return QString("GetAllActionNames"); break;
1056 case kEventAccessibleGetFocusedChild: return QString("GetFocusedChild"); break;
1058 return QString("Unknown accessibility event type: %1").arg(kind);
1063 #ifndef QT_MAC_USE_COCOA
1064 static bool qt_mac_append_cf_uniq(CFMutableArrayRef array, CFTypeRef value)
1071 range.length = CFArrayGetCount(array);
1072 if(!CFArrayContainsValue(array, range, value)) {
1073 CFArrayAppendValue(array, value);
1079 static OSStatus setAttributeValue(EventRef event, const QList<QAElement> &elements)
1081 CFMutableArrayRef array = CFArrayCreateMutable(0, 0, &kCFTypeArrayCallBacks);
1082 foreach (const QAElement &element, elements) {
1083 if (element.isValid())
1084 CFArrayAppendValue(array, element.element());
1087 const OSStatus err = SetEventParameter(event, kEventParamAccessibleAttributeValue,
1088 typeCFTypeRef, sizeof(array), &array);
1092 #endif //QT_MAC_USE_COCOA
1095 Gets the AccessibleObject parameter from an event.
1097 static inline AXUIElementRef getAccessibleObjectParameter(EventRef event)
1099 AXUIElementRef element;
1100 GetEventParameter(event, kEventParamAccessibleObject, typeCFTypeRef, 0,
1101 sizeof(element), 0, &element);
1106 The application event handler makes sure that all top-level qt windows are registered
1107 before any accessibility events are handeled.
1109 #ifndef QT_MAC_USE_COCOA
1110 static OSStatus applicationEventHandler(EventHandlerCallRef next_ref, EventRef event, void *)
1112 QAInterface rootInterface(QAccessible::queryAccessibleInterface(rootObject ? rootObject : qApp), 0);
1113 accessibleHierarchyManager()->registerChildren(rootInterface);
1115 return CallNextEventHandler(next_ref, event);
1119 Returns the value for element by combining the QAccessibility::Checked and
1120 QAccessibility::Mixed flags into an int value that the Mac accessibilty
1121 system understands. This works for check boxes, radio buttons, and the like.
1122 The return values are:
1127 static int buttonValue(QAInterface element)
1129 const QAccessible::State state = element.state();
1130 if (state & QAccessible::Mixed)
1132 else if(state & QAccessible::Checked)
1138 static QString getValue(const QAInterface &interface)
1140 const QAccessible::Role role = interface.role();
1141 if (role == QAccessible::RadioButton || role == QAccessible::CheckBox)
1142 return QString::number(buttonValue(interface));
1144 return interface.text(QAccessible::Value);
1146 #endif //QT_MAC_USE_COCOA
1149 Translates a QAccessible::Role into a mac accessibility role.
1151 static CFStringRef macRole(const QAInterface &interface)
1153 const QAccessible::Role qtRole = interface.role();
1155 // qDebug() << "role for" << interface.object() << "interface role" << hex << qtRole;
1157 // Qt accessibility: QAccessible::Splitter contains QAccessible::Grip.
1158 // Mac accessibility: AXSplitGroup contains AXSplitter.
1159 if (qtRole == QAccessible::Grip) {
1160 const QAInterface parent = interface.parent();
1161 if (parent.isValid() && parent.role() == QAccessible::Splitter)
1162 return CFStringRef(QAXSplitterRole);
1165 // Tab widgets and standalone tab bars get the kAXTabGroupRole. Accessibility
1166 // for tab bars emebedded in a tab widget is handled by the tab widget.
1167 if (isTabWidget(interface) || isStandaloneTabBar(interface))
1168 return kAXTabGroupRole;
1170 if (QObject *object = interface.object()) {
1171 // ### The interface for an abstract scroll area returns the generic "Client"
1172 // role, so we have to to an extra detect on the QObject here.
1173 if (object->inherits("QAbstractScrollArea") && interface.id() == 0)
1174 return CFStringRef(QAXScrollAreaRole);
1176 if (object->inherits("QDockWidget"))
1177 return CFStringRef(QAXUnknownRole);
1181 int testRole = text_bindings[i][0].qt;
1182 while (testRole != -1) {
1183 if (testRole == qtRole)
1184 return CFStringRef(text_bindings[i][0].mac);
1186 testRole = text_bindings[i][0].qt;
1189 // qDebug() << "got unknown role!" << interface << interface.parent();
1191 return CFStringRef(QAXUnknownRole);
1195 Translates a QAccessible::Role and an attribute name into a QAccessible::Text, taking into
1196 account execptions listed in text_bindings.
1198 #ifndef QT_MAC_USE_COCOA
1199 static int textForRoleAndAttribute(QAccessible::Role role, CFStringRef attribute)
1201 // Search for exception, return it if found.
1202 int testRole = text_bindings[0][0].qt;
1204 while (testRole != -1) {
1205 if (testRole == role) {
1207 int qtRole = text_bindings[i][j].qt;
1208 CFStringRef testAttribute = CFStringRef(text_bindings[i][j].mac);
1209 while (qtRole != -1) {
1210 if (CFStringCompare(attribute, testAttribute, 0) == kCFCompareEqualTo) {
1211 return (QAccessible::Text)qtRole;
1214 testAttribute = CFStringRef(text_bindings[i][j].mac); /// ### custom compare
1215 qtRole = text_bindings[i][j].qt; /// ### custom compare
1220 testRole = text_bindings[i][0].qt;
1223 // Return default mappping
1224 if (CFStringCompare(attribute, CFStringRef(QAXTitleAttribute), 0) == kCFCompareEqualTo)
1225 return QAccessible::Name;
1226 else if (CFStringCompare(attribute, CFStringRef(QAXValueAttribute), 0) == kCFCompareEqualTo)
1227 return QAccessible::Value;
1228 else if (CFStringCompare(attribute, CFStringRef(QAXHelpAttribute), 0) == kCFCompareEqualTo)
1229 return QAccessible::Help;
1230 else if (CFStringCompare(attribute, CFStringRef(QAXDescriptionAttribute), 0) == kCFCompareEqualTo)
1231 return QAccessible::Description;
1237 Returns the subrole string constant for the interface if it has one,
1238 else returns an empty string.
1240 static QCFString subrole(const QAInterface &interface)
1242 const QAInterface parent = interface.parent();
1243 if (parent.isValid() == false)
1246 if (parent.role() == QAccessible::ScrollBar) {
1248 switch(interface.id()) {
1249 case 1: subrole = CFStringRef(QAXDecrementArrowSubrole); break;
1250 case 2: subrole = CFStringRef(QAXDecrementPageSubrole); break;
1251 case 4: subrole = CFStringRef(QAXIncrementPageSubrole); break;
1252 case 5: subrole = CFStringRef(QAXIncrementArrowSubrole); break;
1261 // Gets the scroll bar orientation by asking the QAbstractSlider object directly.
1262 static Qt::Orientation scrollBarOrientation(const QAInterface &scrollBar)
1264 QObject *const object = scrollBar.object();
1265 if (QAbstractSlider * const sliderObject = qobject_cast<QAbstractSlider * const>(object))
1266 return sliderObject->orientation();
1268 return Qt::Vertical; // D'oh! The interface wasn't a scroll bar.
1271 static QAInterface scrollAreaGetScrollBarInterface(const QAInterface &scrollArea, Qt::Orientation orientation)
1273 if (macRole(scrollArea) != CFStringRef(CFStringRef(QAXScrollAreaRole)))
1274 return QAInterface();
1276 // Child 1 is the contents widget, 2 and 3 are the scroll bar containers wich contains possible scroll bars.
1277 for (int i = 2; i <= 3; ++i) {
1278 QAInterface scrollBarContainer = scrollArea.childAt(i);
1279 for (int i = 1; i <= scrollBarContainer.childCount(); ++i) {
1280 QAInterface scrollBar = scrollBarContainer.childAt(i);
1281 if (scrollBar.isValid() &&
1282 scrollBar.role() == QAccessible::ScrollBar &&
1283 scrollBarOrientation(scrollBar) == orientation)
1288 return QAInterface();
1291 static bool scrollAreaHasScrollBar(const QAInterface &scrollArea, Qt::Orientation orientation)
1293 return scrollAreaGetScrollBarInterface(scrollArea, orientation).isValid();
1296 static QAElement scrollAreaGetScrollBar(const QAInterface &scrollArea, Qt::Orientation orientation)
1298 return accessibleHierarchyManager()->lookup(scrollAreaGetScrollBarInterface(scrollArea, orientation));
1301 static QAElement scrollAreaGetContents(const QAInterface &scrollArea)
1303 // Child 1 is the contents widget,
1304 return accessibleHierarchyManager()->lookup(scrollArea.navigate(QAccessible::Child, 1));
1307 static QAElement tabWidgetGetContents(const QAInterface &interface)
1309 // A kAXTabGroup has a kAXContents attribute, which consists of the
1310 // ui elements for the current tab page. Get the current tab page
1311 // from the QStackedWidget, where the current visible page can
1312 // be found at index 1.
1313 QAInterface stackedWidget = interface.childAt(1);
1314 accessibleHierarchyManager()->registerChildren(stackedWidget);
1315 QAInterface tabPageInterface = stackedWidget.childAt(1);
1316 return accessibleHierarchyManager()->lookup(tabPageInterface);
1319 static QList<QAElement> tabBarGetTabs(const QAInterface &interface)
1321 // Get the tabs by searching for children with the "PageTab" role.
1322 // This filters out the left/right navigation buttons.
1323 accessibleHierarchyManager()->registerChildren(interface);
1324 QList<QAElement> tabs;
1325 const int numChildren = interface.childCount();
1326 for (int i = 1; i < numChildren + 1; ++i) {
1327 QAInterface child = interface.navigate(QAccessible::Child, i);
1328 if (child.isValid() && child.role() == QAccessible::PageTab) {
1329 tabs.append(accessibleHierarchyManager()->lookup(child));
1335 static QList<QAElement> tabWidgetGetTabs(const QAInterface &interface)
1337 // Each QTabWidget has two children, a QStackedWidget and a QTabBar.
1338 // Get the tabs from the QTabBar.
1339 return tabBarGetTabs(interface.childAt(2));
1342 static QList<QAElement> tabWidgetGetChildren(const QAInterface &interface)
1344 // The children for a kAXTabGroup should consist of the tabs and the
1345 // contents of the current open tab page.
1346 QList<QAElement> children = tabWidgetGetTabs(interface);
1347 children += tabWidgetGetContents(interface);
1350 #endif //QT_MAC_USE_COCOA
1353 Returns the label (buddy) interface for interface, or 0 if it has none.
1356 static QAInterface findLabel(const QAInterface &interface)
1358 return interface.navigate(QAccessible::Label, 1);
1362 Returns a list of interfaces this interface labels, or an empty list if it doesn't label any.
1365 static QList<QAInterface> findLabelled(const QAInterface &interface)
1367 QList<QAInterface> interfaceList;
1370 const QAInterface labelled = interface.navigate(QAccessible::Labelled, count);
1371 while (labelled.isValid()) {
1372 interfaceList.append(labelled);
1375 return interfaceList;
1379 Tests if the given QAInterface has data for a mac attribute.
1381 #ifndef QT_MAC_USE_COCOA
1382 static bool supportsAttribute(CFStringRef attribute, const QAInterface &interface)
1384 const int text = textForRoleAndAttribute(interface.role(), attribute);
1386 // Special case: Static texts don't have a title.
1387 if (interface.role() == QAccessible::StaticText && attribute == CFStringRef(QAXTitleAttribute))
1390 // Return true if we the attribute matched a QAccessible::Role and we get text for that role from the interface.
1392 if (text == QAccessible::Value) // Special case for Value, see getValue()
1393 return !getValue(interface).isEmpty();
1395 return !interface.text((QAccessible::Text)text).isEmpty();
1398 if (CFStringCompare(attribute, CFStringRef(QAXChildrenAttribute), 0) == kCFCompareEqualTo) {
1399 if (interface.childCount() > 0)
1403 if (CFStringCompare(attribute, CFStringRef(QAXSubroleAttribute), 0) == kCFCompareEqualTo) {
1404 return (subrole(interface) != QCFString());
1410 static void appendIfSupported(CFMutableArrayRef array, CFStringRef attribute, const QAInterface &interface)
1412 if (supportsAttribute(attribute, interface))
1413 qt_mac_append_cf_uniq(array, attribute);
1417 Returns the names of the attributes the give QAInterface supports.
1419 static OSStatus getAllAttributeNames(EventRef event, const QAInterface &interface, EventHandlerCallRef next_ref)
1421 // Call system event handler.
1422 OSStatus err = CallNextEventHandler(next_ref, event);
1423 if(err != noErr && err != eventNotHandledErr)
1425 CFMutableArrayRef attrs = 0;
1426 GetEventParameter(event, kEventParamAccessibleAttributeNames, typeCFMutableArrayRef, 0,
1427 sizeof(attrs), 0, &attrs);
1430 return eventNotHandledErr;
1432 // Append attribute names that are always supported.
1433 qt_mac_append_cf_uniq(attrs, CFStringRef(QAXPositionAttribute));
1434 qt_mac_append_cf_uniq(attrs, CFStringRef(QAXSizeAttribute));
1435 qt_mac_append_cf_uniq(attrs, CFStringRef(QAXRoleAttribute));
1436 qt_mac_append_cf_uniq(attrs, CFStringRef(QAXEnabledAttribute));
1437 qt_mac_append_cf_uniq(attrs, CFStringRef(QAXWindowAttribute));
1438 qt_mac_append_cf_uniq(attrs, CFStringRef(QAXTopLevelUIElementAttribute));
1440 // Append these names if the QInterafceItem returns any data for them.
1441 appendIfSupported(attrs, CFStringRef(QAXTitleAttribute), interface);
1442 appendIfSupported(attrs, CFStringRef(QAXValueAttribute), interface);
1443 appendIfSupported(attrs, CFStringRef(QAXDescriptionAttribute), interface);
1444 appendIfSupported(attrs, CFStringRef(QAXLinkedUIElementsAttribute), interface);
1445 appendIfSupported(attrs, CFStringRef(QAXHelpAttribute), interface);
1446 appendIfSupported(attrs, CFStringRef(QAXTitleUIElementAttribute), interface);
1447 appendIfSupported(attrs, CFStringRef(QAXChildrenAttribute), interface);
1448 appendIfSupported(attrs, CFStringRef(QAXSubroleAttribute), interface);
1450 // Append attribute names based on the interaface role.
1451 switch (interface.role()) {
1452 case QAccessible::Window:
1453 qt_mac_append_cf_uniq(attrs, CFStringRef(QAXMainAttribute));
1454 qt_mac_append_cf_uniq(attrs, CFStringRef(QAXMinimizedAttribute));
1455 qt_mac_append_cf_uniq(attrs, CFStringRef(QAXCloseButtonAttribute));
1456 qt_mac_append_cf_uniq(attrs, CFStringRef(QAXZoomButtonAttribute));
1457 qt_mac_append_cf_uniq(attrs, CFStringRef(QAXMinimizeButtonAttribute));
1458 qt_mac_append_cf_uniq(attrs, CFStringRef(QAXToolbarButtonAttribute));
1459 qt_mac_append_cf_uniq(attrs, CFStringRef(QAXGrowAreaAttribute));
1461 case QAccessible::RadioButton:
1462 case QAccessible::CheckBox:
1463 qt_mac_append_cf_uniq(attrs, CFStringRef(QAXMinValueAttribute));
1464 qt_mac_append_cf_uniq(attrs, CFStringRef(QAXMaxValueAttribute));
1466 case QAccessible::ScrollBar:
1467 qt_mac_append_cf_uniq(attrs, CFStringRef(QAXOrientationAttribute));
1469 case QAccessible::Splitter:
1470 qt_mac_append_cf_uniq(attrs, CFStringRef(QAXSplittersAttribute));
1472 case QAccessible::Table:
1473 qt_mac_append_cf_uniq(attrs, CFStringRef(QAXRowsAttribute));
1474 qt_mac_append_cf_uniq(attrs, CFStringRef(QAXVisibleRowsAttribute));
1475 qt_mac_append_cf_uniq(attrs, CFStringRef(QAXSelectedRowsAttribute));
1481 // Append attribute names based on the mac accessibility role.
1482 const QCFString mac_role = macRole(interface);
1483 if (mac_role == CFStringRef(QAXSplitterRole)) {
1484 qt_mac_append_cf_uniq(attrs, CFStringRef(QAXPreviousContentsAttribute));
1485 qt_mac_append_cf_uniq(attrs, CFStringRef(QAXNextContentsAttribute));
1486 qt_mac_append_cf_uniq(attrs, CFStringRef(QAXOrientationAttribute));
1487 } else if (mac_role == CFStringRef(QAXScrollAreaRole)) {
1488 if (scrollAreaHasScrollBar(interface, Qt::Horizontal))
1489 qt_mac_append_cf_uniq(attrs, CFStringRef(QAXHorizontalScrollBarAttribute));
1490 if (scrollAreaHasScrollBar(interface, Qt::Vertical))
1491 qt_mac_append_cf_uniq(attrs, CFStringRef(QAXVerticalScrollBarAttribute));
1492 qt_mac_append_cf_uniq(attrs, CFStringRef(QAXContentsAttribute));
1493 } else if (mac_role == CFStringRef(QAXTabGroupRole)) {
1494 qt_mac_append_cf_uniq(attrs, CFStringRef(QAXTabsAttribute));
1495 // Only tab widgets can have the contents attribute, there is no way of getting
1496 // the contents from a QTabBar.
1497 if (isTabWidget(interface))
1498 qt_mac_append_cf_uniq(attrs, CFStringRef(QAXContentsAttribute));
1504 static void handleStringAttribute(EventRef event, QAccessible::Text text, const QAInterface &interface)
1506 QString str = interface.text(text);
1510 // Remove any html markup from the text string, or VoiceOver will read the html tags.
1511 static QTextDocument document;
1512 document.setHtml(str);
1513 str = document.toPlainText();
1515 CFStringRef cfstr = QCFString::toCFStringRef(str);
1516 SetEventParameter(event, kEventParamAccessibleAttributeValue, typeCFStringRef, sizeof(cfstr), &cfstr);
1520 Handles the parent attribute for a interface.
1521 There are basically three cases here:
1522 1. interface is a HIView and has only HIView children.
1523 2. interface is a HIView but has children that is not a HIView
1524 3. interface is not a HIView.
1526 static OSStatus handleChildrenAttribute(EventHandlerCallRef next_ref, EventRef event, QAInterface &interface)
1528 // Add the children for this interface to the global QAccessibelHierachyManager.
1529 accessibleHierarchyManager()->registerChildren(interface);
1531 if (isTabWidget(interface)) {
1532 QList<QAElement> children = tabWidgetGetChildren(interface);
1533 const int childCount = children.count();
1535 CFMutableArrayRef array = 0;
1536 array = CFArrayCreateMutable(0, 0, &kCFTypeArrayCallBacks);
1537 for (int i = 0; i < childCount; ++i) {
1538 qt_mac_append_cf_uniq(array, children.at(i).element());
1542 err = SetEventParameter(event, kEventParamAccessibleAttributeValue, typeCFArrayRef, sizeof(array), &array);
1544 qWarning("Qt:Internal error (%s:%d)", __FILE__, __LINE__);
1549 const QList<QAElement> children = lookup(interface.children());
1550 const int childCount = children.count();
1552 OSStatus err = eventNotHandledErr;
1553 if (interface.isHIView())
1554 err = CallNextEventHandler(next_ref, event);
1556 CFMutableArrayRef array = 0;
1560 err = GetEventParameter(event, kEventParamAccessibleAttributeValue, typeCFTypeRef, NULL , sizeof(obj), NULL, &obj);
1561 if (err == noErr && obj != 0) {
1562 array = (CFMutableArrayRef)obj;
1563 arraySize = CFArrayGetCount(array);
1568 CFArrayRemoveAllValues(array);
1569 for (int i = 0; i < childCount; ++i) {
1570 qt_mac_append_cf_uniq(array, children.at(i).element());
1573 array = CFArrayCreateMutable(0, 0, &kCFTypeArrayCallBacks);
1574 for (int i = 0; i < childCount; ++i) {
1575 qt_mac_append_cf_uniq(array, children.at(i).element());
1578 err = SetEventParameter(event, kEventParamAccessibleAttributeValue, typeCFArrayRef, sizeof(array), &array);
1580 qWarning("Qt:Internal error (%s:%d)", __FILE__, __LINE__);
1589 static OSStatus handleParentAttribute(EventHandlerCallRef next_ref, EventRef event, const QAInterface &interface)
1591 OSStatus err = eventNotHandledErr;
1592 if (interface.isHIView()) {
1593 err = CallNextEventHandler(next_ref, event);
1598 const QAInterface parentInterface = interface.navigate(QAccessible::Ancestor, 1);
1599 const QAElement parentElement = accessibleHierarchyManager()->lookup(parentInterface);
1601 if (parentElement.isValid() == false)
1602 return eventNotHandledErr;
1604 AXUIElementRef elementRef = parentElement.element();
1605 SetEventParameter(event, kEventParamAccessibleAttributeValue, typeCFTypeRef, sizeof(elementRef), &elementRef);
1612 static inline bool test(const QAInterface &interface)
1614 return (interface.role() == QAccessible::Window);
1618 struct IsWindowAndNotDrawerOrSheetTest
1620 static inline bool test(const QAInterface &interface)
1622 QWidget * const widget = qobject_cast<QWidget*>(interface.object());
1623 return (interface.role() == QAccessible::Window &&
1624 widget && widget->isWindow() &&
1625 !qt_mac_is_macdrawer(widget) &&
1626 !qt_mac_is_macsheet(widget));
1631 Navigates up the iterfaces ancestor hierachy until a QAccessibleInterface that
1632 passes the Test is found. If we reach a interface that is a HIView we stop the
1633 search and call AXUIElementCopyAttributeValue.
1635 template <typename TestType>
1636 OSStatus navigateAncestors(EventHandlerCallRef next_ref, EventRef event, const QAInterface &interface, CFStringRef attribute)
1638 if (interface.isHIView())
1639 return CallNextEventHandler(next_ref, event);
1641 QAInterface current = interface;
1643 while (current.isValid()) {
1644 if (TestType::test(interface)) {
1645 element = accessibleHierarchyManager()->lookup(current);
1649 // If we reach an InterfaceItem that is a HiView we can hand of the search to
1650 // the system event handler. This is the common case.
1651 if (current.isHIView()) {
1652 CFTypeRef value = 0;
1653 const QAElement currentElement = accessibleHierarchyManager()->lookup(current);
1654 AXError err = AXUIElementCopyAttributeValue(currentElement.element(), attribute, &value);
1655 AXUIElementRef newElement = (AXUIElementRef)value;
1658 element = QAElement(newElement);
1660 if (newElement != 0)
1661 CFRelease(newElement);
1665 QAInterface next = current.parent();
1666 if (next.isValid() == false)
1668 if (next == current)
1673 if (element.isValid() == false)
1674 return eventNotHandledErr;
1677 AXUIElementRef elementRef = element.element();
1678 SetEventParameter(event, kEventParamAccessibleAttributeValue, typeCFTypeRef,
1679 sizeof(elementRef), &elementRef);
1684 Returns the top-level window for an interface, which is the closest ancestor interface that
1685 has the Window role, but is not a sheet or a drawer.
1687 #ifndef QT_MAC_USE_COCOA
1688 static OSStatus handleWindowAttribute(EventHandlerCallRef next_ref, EventRef event, const QAInterface &interface)
1690 return navigateAncestors<IsWindowAndNotDrawerOrSheetTest>(next_ref, event, interface, CFStringRef(QAXWindowAttribute));
1694 Returns the top-level window for an interface, which is the closest ancestor interface that
1695 has the Window role. (Can also be a sheet or a drawer)
1697 static OSStatus handleTopLevelUIElementAttribute(EventHandlerCallRef next_ref, EventRef event, const QAInterface &interface)
1699 return navigateAncestors<IsWindowTest>(next_ref, event, interface, CFStringRef(QAXTopLevelUIElementAttribute));
1703 Returns the tab buttons for an interface.
1705 static OSStatus handleTabsAttribute(EventHandlerCallRef next_ref, EventRef event, QAInterface &interface)
1708 if (isTabWidget(interface))
1709 return setAttributeValue(event, tabWidgetGetTabs(interface));
1711 return setAttributeValue(event, tabBarGetTabs(interface));
1714 static OSStatus handlePositionAttribute(EventHandlerCallRef, EventRef event, const QAInterface &interface)
1716 QPoint qpoint(interface.rect().topLeft());
1718 point.x = qpoint.x();
1719 point.y = qpoint.y();
1720 SetEventParameter(event, kEventParamAccessibleAttributeValue, typeHIPoint, sizeof(point), &point);
1724 static OSStatus handleSizeAttribute(EventHandlerCallRef, EventRef event, const QAInterface &interface)
1726 QSize qSize(interface.rect().size());
1728 size.width = qSize.width();
1729 size.height = qSize.height();
1730 SetEventParameter(event, kEventParamAccessibleAttributeValue, typeHISize, sizeof(size), &size);
1734 static OSStatus handleSubroleAttribute(EventHandlerCallRef, EventRef event, const QAInterface &interface)
1736 const QCFString role = subrole(interface);
1737 CFStringRef rolestr = (CFStringRef)role;
1738 SetEventParameter(event, kEventParamAccessibleAttributeValue, typeCFTypeRef, sizeof(rolestr), &rolestr);
1742 static OSStatus handleOrientationAttribute(EventHandlerCallRef next_ref, EventRef event, const QAInterface &interface)
1744 QObject *const object = interface.object();
1745 Qt::Orientation orientation;
1746 if (interface.role() == QAccessible::ScrollBar) {
1747 orientation = scrollBarOrientation(interface);
1748 } else if (QSplitterHandle * const splitter = qobject_cast<QSplitterHandle * const>(object)) {
1749 // Qt reports the layout orientation, but we want the splitter handle orientation.
1750 orientation = (splitter->orientation() == Qt::Horizontal) ? Qt::Vertical : Qt::Horizontal;
1752 return CallNextEventHandler(next_ref, event);
1754 const CFStringRef orientationString = (orientation == Qt::Vertical)
1755 ? CFStringRef(QAXVerticalOrientationValue) : CFStringRef(QAXHorizontalOrientationValue);
1756 SetEventParameter(event, kEventParamAccessibleAttributeValue, typeCFStringRef, sizeof(orientationString), &orientationString);
1761 Figures out the next or previous contents for a splitter.
1763 static OSStatus handleSplitterContentsAttribute(EventHandlerCallRef next_ref, EventRef event, const QAInterface &interface, QCFString nextOrPrev)
1765 if (interface.isValid() == false || interface.role() != QAccessible::Grip)
1766 return eventNotHandledErr;
1768 const QAInterface parent = interface.parent();
1769 if (parent.isValid() == false)
1770 return CallNextEventHandler(next_ref, event);
1772 if (parent.role() != QAccessible::Splitter)
1773 return CallNextEventHandler(next_ref, event);
1775 const QSplitter * const splitter = qobject_cast<const QSplitter * const>(parent.object());
1777 return CallNextEventHandler(next_ref, event);
1779 QWidget * const splitterHandle = qobject_cast<QWidget * const>(interface.object());
1780 const int splitterHandleIndex = splitter->indexOf(splitterHandle);
1781 const int widgetIndex = (nextOrPrev == QCFString(CFStringRef(QAXPreviousContentsAttribute))) ? splitterHandleIndex - 1 : splitterHandleIndex;
1782 const QAElement contentsElement = accessibleHierarchyManager()->lookup(splitter->widget(widgetIndex), 0);
1783 return setAttributeValue(event, QList<QAElement>() << contentsElement);
1787 Creates a list of all splitter handles the splitter contains.
1789 static OSStatus handleSplittersAttribute(EventHandlerCallRef next_ref, EventRef event, QAInterface &interface)
1791 const QSplitter * const splitter = qobject_cast<const QSplitter * const>(interface.object());
1793 return CallNextEventHandler(next_ref, event);
1795 accessibleHierarchyManager()->registerChildren(interface);
1797 QList<QAElement> handles;
1798 const int visibleSplitterCount = splitter->count() -1; // skip first handle, it's always invisible.
1799 for (int i = 0; i < visibleSplitterCount; ++i)
1800 handles.append(accessibleHierarchyManager()->lookup(splitter->handle(i + 1), 0));
1802 return setAttributeValue(event, handles);
1805 // This handler gets the scroll bars for a scroll area
1806 static OSStatus handleScrollBarAttribute(EventHandlerCallRef next_ref, EventRef event, QAInterface &scrollArea, Qt::Orientation orientation)
1808 QAElement scrollBar = scrollAreaGetScrollBar(scrollArea, orientation);
1809 if (scrollBar.isValid() == false)
1810 return CallNextEventHandler(next_ref, event);
1812 AXUIElementRef elementRef = scrollBar.element();
1813 SetEventParameter(event, kEventParamAccessibleAttributeValue, typeCFTypeRef, sizeof(elementRef), &elementRef);
1817 // This handler gets the contents for a scroll area or tab widget.
1818 static OSStatus handleContentsAttribute(EventHandlerCallRef next_ref, EventRef event, QAInterface &interface)
1820 const QCFString mac_role = macRole(interface);
1824 if (mac_role == kAXTabGroupRole) {
1825 contents = tabWidgetGetContents(interface);
1827 contents = scrollAreaGetContents(interface);
1828 if (contents.isValid() == false)
1829 return CallNextEventHandler(next_ref, event);
1832 return setAttributeValue(event, QList<QAElement>() << contents);
1835 static OSStatus handleRowsAttribute(EventHandlerCallRef, EventRef event, QAInterface &tableView)
1837 QList<QAElement> rows = lookup(tableView.children());
1839 // kill the first row which is the horizontal header.
1842 return setAttributeValue(event, rows);
1845 static OSStatus handleVisibleRowsAttribute(EventHandlerCallRef, EventRef event, QAInterface &tableView)
1847 QList<QAElement> visibleRows;
1849 QList<QAInterface> rows = tableView.children();
1850 // kill the first row which is the horizontal header.
1853 foreach (const QAInterface &interface, rows)
1854 if ((interface.state() & QAccessible::Invisible) == false)
1855 visibleRows.append(accessibleHierarchyManager()->lookup(interface));
1857 return setAttributeValue(event, visibleRows);
1860 static OSStatus handleSelectedRowsAttribute(EventHandlerCallRef, EventRef event, QAInterface &tableView)
1862 QList<QAElement> selectedRows;
1863 foreach (const QAInterface &interface, tableView.children())
1864 if ((interface.state() & QAccessible::Selected))
1865 selectedRows.append(accessibleHierarchyManager()->lookup(interface));
1867 return setAttributeValue(event, selectedRows);
1870 static OSStatus getNamedAttribute(EventHandlerCallRef next_ref, EventRef event, QAInterface &interface)
1873 GetEventParameter(event, kEventParamAccessibleAttributeName, typeCFStringRef, 0,
1874 sizeof(var), 0, &var);
1876 if (CFStringCompare(var, CFStringRef(QAXChildrenAttribute), 0) == kCFCompareEqualTo) {
1877 return handleChildrenAttribute(next_ref, event, interface);
1878 } else if(CFStringCompare(var, CFStringRef(QAXTopLevelUIElementAttribute), 0) == kCFCompareEqualTo) {
1879 return handleTopLevelUIElementAttribute(next_ref, event, interface);
1880 } else if(CFStringCompare(var, CFStringRef(QAXWindowAttribute), 0) == kCFCompareEqualTo) {
1881 return handleWindowAttribute(next_ref, event, interface);
1882 } else if(CFStringCompare(var, CFStringRef(QAXParentAttribute), 0) == kCFCompareEqualTo) {
1883 return handleParentAttribute(next_ref, event, interface);
1884 } else if (CFStringCompare(var, CFStringRef(QAXPositionAttribute), 0) == kCFCompareEqualTo) {
1885 return handlePositionAttribute(next_ref, event, interface);
1886 } else if (CFStringCompare(var, CFStringRef(QAXSizeAttribute), 0) == kCFCompareEqualTo) {
1887 return handleSizeAttribute(next_ref, event, interface);
1888 } else if (CFStringCompare(var, CFStringRef(QAXRoleAttribute), 0) == kCFCompareEqualTo) {
1889 CFStringRef role = macRole(interface);
1891 // QWidget * const widget = qobject_cast<QWidget *>(interface.object());
1892 // if (role == CFStringRef(QAXUnknownRole) && widget && widget->isWindow())
1893 // role = CFStringRef(QAXWindowRole);
1895 SetEventParameter(event, kEventParamAccessibleAttributeValue, typeCFStringRef,
1896 sizeof(role), &role);
1898 } else if (CFStringCompare(var, CFStringRef(QAXEnabledAttribute), 0) == kCFCompareEqualTo) {
1899 Boolean val = !((interface.state() & QAccessible::Unavailable))
1900 && !((interface.state() & QAccessible::Invisible));
1901 SetEventParameter(event, kEventParamAccessibleAttributeValue, typeBoolean,
1903 } else if (CFStringCompare(var, CFStringRef(QAXExpandedAttribute), 0) == kCFCompareEqualTo) {
1904 Boolean val = (interface.state() & QAccessible::Expanded);
1905 SetEventParameter(event, kEventParamAccessibleAttributeValue, typeBoolean,
1907 } else if (CFStringCompare(var, CFStringRef(QAXSelectedAttribute), 0) == kCFCompareEqualTo) {
1908 Boolean val = (interface.state() & QAccessible::Selection);
1909 SetEventParameter(event, kEventParamAccessibleAttributeValue, typeBoolean,
1911 } else if (CFStringCompare(var, CFStringRef(QAXFocusedAttribute), 0) == kCFCompareEqualTo) {
1912 Boolean val = (interface.state() & QAccessible::Focus);
1913 SetEventParameter(event, kEventParamAccessibleAttributeValue, typeBoolean,
1915 } else if (CFStringCompare(var, CFStringRef(QAXSelectedChildrenAttribute), 0) == kCFCompareEqualTo) {
1916 const int cc = interface.childCount();
1917 QList<QAElement> selected;
1918 for (int i = 1; i <= cc; ++i) {
1919 const QAInterface child_iface = interface.navigate(QAccessible::Child, i);
1920 if (child_iface.isValid() && child_iface.state() & QAccessible::Selected)
1921 selected.append(accessibleHierarchyManager()->lookup(child_iface));
1924 return setAttributeValue(event, selected);
1926 } else if (CFStringCompare(var, CFStringRef(QAXCloseButtonAttribute), 0) == kCFCompareEqualTo) {
1927 if(interface.object() && interface.object()->isWidgetType()) {
1928 Boolean val = true; //do we want to add a WState for this?
1929 SetEventParameter(event, kEventParamAccessibleAttributeValue, typeBoolean,
1932 } else if (CFStringCompare(var, CFStringRef(QAXZoomButtonAttribute), 0) == kCFCompareEqualTo) {
1933 if(interface.object() && interface.object()->isWidgetType()) {
1934 QWidget *widget = (QWidget*)interface.object();
1935 Boolean val = (widget->windowFlags() & Qt::WindowMaximizeButtonHint);
1936 SetEventParameter(event, kEventParamAccessibleAttributeValue, typeBoolean,
1939 } else if (CFStringCompare(var, CFStringRef(QAXMinimizeButtonAttribute), 0) == kCFCompareEqualTo) {
1940 if(interface.object() && interface.object()->isWidgetType()) {
1941 QWidget *widget = (QWidget*)interface.object();
1942 Boolean val = (widget->windowFlags() & Qt::WindowMinimizeButtonHint);
1943 SetEventParameter(event, kEventParamAccessibleAttributeValue, typeBoolean,
1946 } else if (CFStringCompare(var, CFStringRef(QAXToolbarButtonAttribute), 0) == kCFCompareEqualTo) {
1947 if(interface.object() && interface.object()->isWidgetType()) {
1948 QWidget *widget = (QWidget*)interface.object();
1949 Boolean val = qobject_cast<QMainWindow *>(widget) != 0;
1950 SetEventParameter(event, kEventParamAccessibleAttributeValue, typeBoolean,
1953 } else if (CFStringCompare(var, CFStringRef(QAXGrowAreaAttribute), 0) == kCFCompareEqualTo) {
1954 if(interface.object() && interface.object()->isWidgetType()) {
1955 Boolean val = true; //do we want to add a WState for this?
1956 SetEventParameter(event, kEventParamAccessibleAttributeValue, typeBoolean,
1959 } else if (CFStringCompare(var, CFStringRef(QAXMinimizedAttribute), 0) == kCFCompareEqualTo) {
1960 if (interface.object() && interface.object()->isWidgetType()) {
1961 QWidget *widget = (QWidget*)interface.object();
1962 Boolean val = (widget->windowState() & Qt::WindowMinimized);
1963 SetEventParameter(event, kEventParamAccessibleAttributeValue, typeBoolean,
1966 } else if (CFStringCompare(var, CFStringRef(QAXSubroleAttribute), 0) == kCFCompareEqualTo) {
1967 return handleSubroleAttribute(next_ref, event, interface);
1968 } else if (CFStringCompare(var, CFStringRef(QAXRoleDescriptionAttribute), 0) == kCFCompareEqualTo) {
1969 #if !defined(QT_MAC_USE_COCOA)
1970 if (HICopyAccessibilityRoleDescription) {
1971 const CFStringRef roleDescription = HICopyAccessibilityRoleDescription(macRole(interface), 0);
1972 SetEventParameter(event, kEventParamAccessibleAttributeValue, typeCFStringRef,
1973 sizeof(roleDescription), &roleDescription);
1977 // Just use Qt::Description on 10.3
1978 handleStringAttribute(event, QAccessible::Description, interface);
1980 } else if (CFStringCompare(var, CFStringRef(QAXTitleAttribute), 0) == kCFCompareEqualTo) {
1981 const QAccessible::Role role = interface.role();
1982 const QAccessible::Text text = (QAccessible::Text)textForRoleAndAttribute(role, var);
1983 handleStringAttribute(event, text, interface);
1984 } else if (CFStringCompare(var, CFStringRef(QAXValueAttribute), 0) == kCFCompareEqualTo) {
1985 const QAccessible::Role role = interface.role();
1986 const QAccessible::Text text = (QAccessible::Text)textForRoleAndAttribute(role, var);
1987 if (role == QAccessible::CheckBox || role == QAccessible::RadioButton) {
1988 int value = buttonValue(interface);
1989 SetEventParameter(event, kEventParamAccessibleAttributeValue, typeUInt32, sizeof(value), &value);
1991 handleStringAttribute(event, text, interface);
1993 } else if (CFStringCompare(var, CFStringRef(QAXDescriptionAttribute), 0) == kCFCompareEqualTo) {
1994 const QAccessible::Role role = interface.role();
1995 const QAccessible::Text text = (QAccessible::Text)textForRoleAndAttribute(role, var);
1996 handleStringAttribute(event, text, interface);
1997 } else if (CFStringCompare(var, CFStringRef(QAXLinkedUIElementsAttribute), 0) == kCFCompareEqualTo) {
1998 return CallNextEventHandler(next_ref, event);
1999 } else if (CFStringCompare(var, CFStringRef(QAXHelpAttribute), 0) == kCFCompareEqualTo) {
2000 const QAccessible::Role role = interface.role();
2001 const QAccessible::Text text = (QAccessible::Text)textForRoleAndAttribute(role, var);
2002 handleStringAttribute(event, text, interface);
2003 } else if (CFStringCompare(var, kAXTitleUIElementAttribute, 0) == kCFCompareEqualTo) {
2004 return CallNextEventHandler(next_ref, event);
2005 } else if (CFStringCompare(var, CFStringRef(QAXTabsAttribute), 0) == kCFCompareEqualTo) {
2006 return handleTabsAttribute(next_ref, event, interface);
2007 } else if (CFStringCompare(var, CFStringRef(QAXMinValueAttribute), 0) == kCFCompareEqualTo) {
2008 // tabs we first go to the tab bar which is child #2.
2009 QAInterface tabBarInterface = interface.childAt(2);
2010 return handleTabsAttribute(next_ref, event, tabBarInterface);
2011 } else if (CFStringCompare(var, CFStringRef(QAXMinValueAttribute), 0) == kCFCompareEqualTo) {
2012 if (interface.role() == QAccessible::RadioButton || interface.role() == QAccessible::CheckBox) {
2014 SetEventParameter(event, kEventParamAccessibleAttributeValue, typeUInt32, sizeof(value), &value);
2016 return CallNextEventHandler(next_ref, event);
2018 } else if (CFStringCompare(var, CFStringRef(QAXMaxValueAttribute), 0) == kCFCompareEqualTo) {
2019 if (interface.role() == QAccessible::RadioButton || interface.role() == QAccessible::CheckBox) {
2021 SetEventParameter(event, kEventParamAccessibleAttributeValue, typeUInt32, sizeof(value), &value);
2023 return CallNextEventHandler(next_ref, event);
2025 } else if (CFStringCompare(var, CFStringRef(QAXOrientationAttribute), 0) == kCFCompareEqualTo) {
2026 return handleOrientationAttribute(next_ref, event, interface);
2027 } else if (CFStringCompare(var, CFStringRef(QAXPreviousContentsAttribute), 0) == kCFCompareEqualTo) {
2028 return handleSplitterContentsAttribute(next_ref, event, interface, CFStringRef(QAXPreviousContentsAttribute));
2029 } else if (CFStringCompare(var, CFStringRef(QAXNextContentsAttribute), 0) == kCFCompareEqualTo) {
2030 return handleSplitterContentsAttribute(next_ref, event, interface, CFStringRef(QAXNextContentsAttribute));
2031 } else if (CFStringCompare(var, CFStringRef(QAXSplittersAttribute), 0) == kCFCompareEqualTo) {
2032 return handleSplittersAttribute(next_ref, event, interface);
2033 } else if (CFStringCompare(var, CFStringRef(QAXHorizontalScrollBarAttribute), 0) == kCFCompareEqualTo) {
2034 return handleScrollBarAttribute(next_ref, event, interface, Qt::Horizontal);
2035 } else if (CFStringCompare(var, CFStringRef(QAXVerticalScrollBarAttribute), 0) == kCFCompareEqualTo) {
2036 return handleScrollBarAttribute(next_ref, event, interface, Qt::Vertical);
2037 } else if (CFStringCompare(var, CFStringRef(QAXContentsAttribute), 0) == kCFCompareEqualTo) {
2038 return handleContentsAttribute(next_ref, event, interface);
2039 } else if (CFStringCompare(var, CFStringRef(QAXRowsAttribute), 0) == kCFCompareEqualTo) {
2040 return handleRowsAttribute(next_ref, event, interface);
2041 } else if (CFStringCompare(var, CFStringRef(QAXVisibleRowsAttribute), 0) == kCFCompareEqualTo) {
2042 return handleVisibleRowsAttribute(next_ref, event, interface);
2043 } else if (CFStringCompare(var, CFStringRef(QAXSelectedRowsAttribute), 0) == kCFCompareEqualTo) {
2044 return handleSelectedRowsAttribute(next_ref, event, interface);
2046 return CallNextEventHandler(next_ref, event);
2051 static OSStatus isNamedAttributeSettable(EventRef event, const QAInterface &interface)
2054 GetEventParameter(event, kEventParamAccessibleAttributeName, typeCFStringRef, 0,
2055 sizeof(var), 0, &var);
2056 Boolean settable = false;
2057 if (CFStringCompare(var, CFStringRef(QAXFocusedAttribute), 0) == kCFCompareEqualTo) {
2060 for (int r = 0; text_bindings[r][0].qt != -1; r++) {
2061 if(interface.role() == (QAccessible::Role)text_bindings[r][0].qt) {
2062 for (int a = 1; text_bindings[r][a].qt != -1; a++) {
2063 if (CFStringCompare(var, CFStringRef(text_bindings[r][a].mac), 0) == kCFCompareEqualTo) {
2064 settable = text_bindings[r][a].settable;
2071 SetEventParameter(event, kEventParamAccessibleAttributeSettable, typeBoolean,
2072 sizeof(settable), &settable);
2076 static OSStatus getChildAtPoint(EventHandlerCallRef next_ref, EventRef event, QAInterface &interface)
2079 if (interface.isValid() == false)
2080 return eventNotHandledErr;
2082 // Add the children for this interface to the global QAccessibelHierachyManager.
2083 accessibleHierarchyManager()->registerChildren(interface);
2086 GetEventParameter(event, kEventParamMouseLocation, typeQDPoint, 0, sizeof(where), 0, &where);
2087 const QAInterface childInterface = interface.childAt(where.h, where.v);
2089 if (childInterface.isValid() == false || childInterface == interface)
2090 return eventNotHandledErr;
2092 const QAElement element = accessibleHierarchyManager()->lookup(childInterface);
2093 if (element.isValid() == false)
2094 return eventNotHandledErr;
2096 AXUIElementRef elementRef = element.element();
2097 CFRetain(elementRef);
2098 SetEventParameter(event, kEventParamAccessibleChild, typeCFTypeRef,
2099 sizeof(elementRef), &elementRef);
2105 Returns a list of actions the given interface supports.
2106 Currently implemented by getting the interface role and deciding based on that.
2108 static QList<QAccessible::Action> supportedPredefinedActions(const QAInterface &interface)
2110 QList<QAccessible::Action> actions;
2111 switch (interface.role()) {
2113 // Most things can be pressed.
2114 actions.append(QAccessible::Press);
2122 Translates a predefined QAccessible::Action to a Mac action constant.
2123 Returns an empty string if the Qt Action has no mac equivalent.
2125 static QCFString translateAction(const QAccessible::Action action)
2128 case QAccessible::Press:
2129 return CFStringRef(QAXPressAction);
2131 case QAccessible::Increase:
2132 return CFStringRef(QAXIncrementAction);
2134 case QAccessible::Decrease:
2135 return CFStringRef(QAXDecrementAction);
2137 case QAccessible::Accept:
2138 return CFStringRef(QAXConfirmAction);
2140 case QAccessible::Select:
2141 return CFStringRef(QAXPickAction);
2143 case QAccessible::Cancel:
2144 return CFStringRef(QAXCancelAction);
2153 Translates between a Mac action constant and a QAccessible::Action.
2154 Returns QAccessible::Default action if there is no Qt predefined equivalent.
2156 static QAccessible::Action translateAction(const CFStringRef actionName)
2158 if(CFStringCompare(actionName, CFStringRef(QAXPressAction), 0) == kCFCompareEqualTo) {
2159 return QAccessible::Press;
2160 } else if(CFStringCompare(actionName, CFStringRef(QAXIncrementAction), 0) == kCFCompareEqualTo) {
2161 return QAccessible::Increase;
2162 } else if(CFStringCompare(actionName, CFStringRef(QAXDecrementAction), 0) == kCFCompareEqualTo) {
2163 return QAccessible::Decrease;
2164 } else if(CFStringCompare(actionName, CFStringRef(QAXConfirmAction), 0) == kCFCompareEqualTo) {
2165 return QAccessible::Accept;
2166 } else if(CFStringCompare(actionName, CFStringRef(QAXPickAction), 0) == kCFCompareEqualTo) {
2167 return QAccessible::Select;
2168 } else if(CFStringCompare(actionName, CFStringRef(QAXCancelAction), 0) == kCFCompareEqualTo) {
2169 return QAccessible::Cancel;
2171 return QAccessible::DefaultAction;
2174 #endif // QT_MAC_USE_COCOA
2177 Copies the translated names all supported actions for an interface into the kEventParamAccessibleActionNames
2180 #ifndef QT_MAC_USE_COCOA
2181 static OSStatus getAllActionNames(EventHandlerCallRef next_ref, EventRef event, const QAInterface &interface)
2185 CFMutableArrayRef actions = 0;
2186 GetEventParameter(event, kEventParamAccessibleActionNames, typeCFMutableArrayRef, 0,
2187 sizeof(actions), 0, &actions);
2189 // Add supported predefined actions.
2190 const QList<QAccessible::Action> predefinedActions = supportedPredefinedActions(interface);
2191 for (int i = 0; i < predefinedActions.count(); ++i) {
2192 const QCFString action = translateAction(predefinedActions.at(i));
2193 if (action != QCFString())
2194 qt_mac_append_cf_uniq(actions, action);
2198 const int actionCount = interface.userActionCount();
2199 for (int i = 0; i < actionCount; ++i) {
2200 const QString actionName = interface.actionText(i, QAccessible::Name);
2201 qt_mac_append_cf_uniq(actions, QCFString::toCFStringRef(actionName));
2209 Handles the perforNamedAction event.
2211 #ifndef QT_MAC_USE_COCOA
2212 static OSStatus performNamedAction(EventHandlerCallRef next_ref, EventRef event, const QAInterface& interface)
2217 GetEventParameter(event, kEventParamAccessibleActionName, typeCFStringRef, 0,
2218 sizeof(act), 0, &act);
2220 const QAccessible::Action action = translateAction(act);
2222 // Perform built-in action
2223 if (action != QAccessible::DefaultAction) {
2224 interface.doAction(action, QVariantList());
2228 // Search for user-defined actions and perform it if found.
2229 const int actCount = interface.userActionCount();
2230 const QString qAct = QCFString::toQString(act);
2231 for(int i = 0; i < actCount; i++) {
2232 if(interface.actionText(i, QAccessible::Name) == qAct) {
2233 interface.doAction(i, QVariantList());
2240 static OSStatus setNamedAttribute(EventHandlerCallRef next_ref, EventRef event, const QAInterface &interface)
2246 GetEventParameter(event, kEventParamAccessibleAttributeName, typeCFStringRef, 0,
2247 sizeof(var), 0, &var);
2248 if(CFStringCompare(var, CFStringRef(QAXFocusedAttribute), 0) == kCFCompareEqualTo) {
2250 if(GetEventParameter(event, kEventParamAccessibleAttributeValue, typeCFTypeRef, 0,
2251 sizeof(val), 0, &val) == noErr) {
2252 if(CFGetTypeID(val) == CFBooleanGetTypeID() &&
2253 CFEqual(static_cast<CFBooleanRef>(val), kCFBooleanTrue)) {
2254 interface.doAction(QAccessible::SetFocus);
2259 for(int r = 0; text_bindings[r][0].qt != -1; r++) {
2260 if(interface.role() == (QAccessible::Role)text_bindings[r][0].qt) {
2261 for(int a = 1; text_bindings[r][a].qt != -1; a++) {
2262 if(CFStringCompare(var, CFStringRef(text_bindings[r][a].mac), 0) == kCFCompareEqualTo) {
2263 if(!text_bindings[r][a].settable) {
2266 if(GetEventParameter(event, kEventParamAccessibleAttributeValue, typeCFTypeRef, 0,
2267 sizeof(val), 0, &val) == noErr) {
2268 if(CFGetTypeID(val) == CFStringGetTypeID())
2269 interface.setText((QAccessible::Text)text_bindings[r][a].qt,
2270 QCFString::toQString(static_cast<CFStringRef>(val)));
2286 This is the main accessibility event handler.
2288 static OSStatus accessibilityEventHandler(EventHandlerCallRef next_ref, EventRef event, void *data)
2292 // Return if this event is not a AccessibleGetNamedAttribute event.
2293 const UInt32 eclass = GetEventClass(event);
2294 if (eclass != kEventClassAccessibility)
2295 return eventNotHandledErr;
2297 // Get the AXUIElementRef and QAInterface pointer
2298 AXUIElementRef element = 0;
2299 GetEventParameter(event, kEventParamAccessibleObject, typeCFTypeRef, 0, sizeof(element), 0, &element);
2300 QAInterface interface = accessibleHierarchyManager()->lookup(element);
2301 if (interface.isValid() == false)
2302 return eventNotHandledErr;
2304 const UInt32 ekind = GetEventKind(event);
2305 OSStatus status = noErr;
2307 case kEventAccessibleGetAllAttributeNames:
2308 status = getAllAttributeNames(event, interface, next_ref);
2310 case kEventAccessibleGetNamedAttribute:
2311 status = getNamedAttribute(next_ref, event, interface);
2313 case kEventAccessibleIsNamedAttributeSettable:
2314 status = isNamedAttributeSettable(event, interface);
2316 case kEventAccessibleGetChildAtPoint:
2317 status = getChildAtPoint(next_ref, event, interface);
2319 case kEventAccessibleGetAllActionNames:
2320 status = getAllActionNames(next_ref, event, interface);
2322 case kEventAccessibleGetFocusedChild:
2323 status = CallNextEventHandler(next_ref, event);
2325 case kEventAccessibleSetNamedAttribute:
2326 status = setNamedAttribute(next_ref, event, interface);
2328 case kEventAccessiblePerformNamedAction:
2329 status = performNamedAction(next_ref, event, interface);
2332 status = CallNextEventHandler(next_ref, event);
2339 void QAccessible::initialize()
2341 #ifndef QT_MAC_USE_COCOA
2342 registerQtAccessibilityHIObjectSubclass();
2343 installApplicationEventhandler();
2347 // Sets thre root object for the application
2348 void QAccessible::setRootObject(QObject *object)
2350 // Call installed root object handler if we have one
2351 if (rootObjectHandler) {
2352 rootObjectHandler(object);
2356 rootObject = object;
2359 void QAccessible::cleanup()
2361 accessibleHierarchyManager()->reset();
2362 #ifndef QT_MAC_USE_COCOA
2363 removeEventhandler(applicationEventHandlerUPP);
2364 removeEventhandler(objectCreateEventHandlerUPP);
2365 removeEventhandler(accessibilityEventHandlerUPP);
2369 void QAccessible::updateAccessibility(QObject *object, int child, Event reason)
2371 // Call installed update handler if we have one.
2372 if (updateHandler) {
2373 updateHandler(object, child, reason);
2377 #ifndef QT_MAC_USE_COCOA
2378 // Return if the mac accessibility is not enabled.
2382 // Work around crash, disable accessiblity for focus frames.
2383 if (qstrcmp(object->metaObject()->className(), "QFocusFrame") == 0)
2386 // qDebug() << "updateAccessibility" << object << child << hex << reason;
2388 if (reason == ObjectShow) {
2389 QAInterface interface = QAInterface(QAccessible::queryAccessibleInterface(object), child);
2390 accessibleHierarchyManager()->registerInterface(interface);
2393 const QAElement element = accessibleHierarchyManager()->lookup(object, child);
2394 if (element.isValid() == false)
2398 CFStringRef notification = 0;
2399 if(object && object->isWidgetType() && reason == ObjectCreated) {
2400 notification = CFStringRef(QAXWindowCreatedNotification);
2401 } else if(reason == ValueChanged) {
2402 notification = CFStringRef(QAXValueChangedNotification);
2403 } else if(reason == MenuStart) {
2404 notification = CFStringRef(QAXMenuOpenedNotification);
2405 } else if(reason == MenuEnd) {
2406 notification = CFStringRef(QAXMenuClosedNotification);
2407 } else if(reason == LocationChanged) {
2408 notification = CFStringRef(QAXWindowMovedNotification);
2409 } else if(reason == ObjectShow || reason == ObjectHide ) {
2410 // When a widget is deleted we get a ObjectHide before the destroyed(QObject *)
2411 // signal is emitted (which makes sense). However, at this point we are in the
2412 // middle of the QWidget destructor which means that we have to be careful when
2413 // using the widget pointer. Since we can't control what the accessibilty interfaces
2414 // does when navigate() is called below we ignore the hide update in this case.
2415 // (the widget will be deleted soon anyway.)
2416 extern QWidgetPrivate * qt_widget_private(QWidget *);
2417 if (QWidget *widget = qobject_cast<QWidget*>(object)) {
2418 if (qt_widget_private(widget)->data.in_destructor)
2421 // Check widget parent as well, special case for preventing crash
2422 // when the viewport() of an abstract scroll area is hidden when
2423 // the QWidget destructor hides all its children.
2424 QWidget *parentWidget = widget->parentWidget();
2425 if (parentWidget && qt_widget_private(parentWidget)->data.in_destructor)
2429 // There is no equivalent Mac notification for ObjectShow/Hide, so we call HIObjectSetAccessibilityIgnored
2430 // and isItInteresting which will mark the HIObject accociated with the element as ignored if the
2431 // QAccessible::Invisible state bit is set.
2432 QAInterface interface = accessibleHierarchyManager()->lookup(element);
2433 if (interface.isValid()) {
2434 HIObjectSetAccessibilityIgnored(element.object(), !isItInteresting(interface));
2437 // If the interface manages its own children, also check if we should ignore those.
2438 if (isItemView(interface) == false && managesChildren(interface)) {
2439 for (int i = 1; i <= interface.childCount(); ++i) {
2440 QAInterface childInterface = interface.navigate(QAccessible::Child, i);
2441 if (childInterface.isValid() && childInterface.isHIView() == false) {
2442 const QAElement element = accessibleHierarchyManager()->lookup(childInterface);
2443 if (element.isValid()) {
2444 HIObjectSetAccessibilityIgnored(element.object(), !isItInteresting(childInterface));
2450 } else if(reason == Focus) {
2451 if(object && object->isWidgetType()) {
2452 QWidget *w = static_cast<QWidget*>(object);
2454 notification = CFStringRef(QAXFocusedWindowChangedNotification);
2456 notification = CFStringRef(QAXFocusedUIElementChangedNotification);
2463 AXNotificationHIObjectNotify(notification, element.object(), element.id());
2469 #endif // QT_NO_ACCESSIBILITY