1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of the plugins of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 #ifndef QCOCOAACCESIBILITY_H
40 #define QCOCOAACCESIBILITY_H
41 
42 #include <AppKit/AppKit.h>
43 
44 #include <QtGui>
45 #include <qpa/qplatformaccessibility.h>
46 
47 #include "qcocoaaccessibilityelement.h"
48 
49 #ifndef QT_NO_ACCESSIBILITY
50 
51 QT_BEGIN_NAMESPACE
52 
53 class QCocoaAccessibility : public QPlatformAccessibility
54 {
55 public:
56     QCocoaAccessibility();
57     ~QCocoaAccessibility();
58     void notifyAccessibilityUpdate(QAccessibleEvent *event) override;
59     void setRootObject(QObject *o) override;
60     void initialize() override;
61     void cleanup() override;
62 };
63 
64 namespace QCocoaAccessible {
65 
66 /*
67     Qt Cocoa Accessibility Overview
68 
69     Cocoa accessibility is implemented in the following files:
70 
71     - qcocoaaccessibility (this file) : QCocoaAccessibility "plugin", conversion and helper functions.
72     - qnsviewaccessibility            : Root accessibility implementation for QNSView
73     - qcocoaaccessibilityelement      : Cocoa accessibility protocol wrapper for QAccessibleInterface
74 
75     The accessibility implementation wraps QAccessibleInterfaces in QCocoaAccessibleElements, which
76     implements the cocoa accessibility protocol. The root QAccessibleInterface (the one returned
77     by QWindow::accessibleRoot), is anchored to the QNSView in qnsviewaccessibility.mm.
78 
79     Cocoa explores the accessibility tree by walking the tree using the parent/child
80     relationships or hit testing. When this happens we create QCocoaAccessibleElements on
81     demand.
82 */
83 
84 NSString *macRole(QAccessibleInterface *interface);
85 NSString *macSubrole(QAccessibleInterface *interface);
86 bool shouldBeIgnored(QAccessibleInterface *interface);
87 NSArray<QMacAccessibilityElement *> *unignoredChildren(QAccessibleInterface *interface);
88 NSString *getTranslatedAction(const QString &qtAction);
89 QString translateAction(NSString *nsAction, QAccessibleInterface *interface);
90 bool hasValueAttribute(QAccessibleInterface *interface);
91 id getValueAttribute(QAccessibleInterface *interface);
92 
93 }
94 
95 QT_END_NAMESPACE
96 
97 #endif // QT_NO_ACCESSIBILITY
98 
99 #endif // QCOCOAACCESIBILITY_H
100