1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
6 ** This file is part of the QtGui module of the Qt Toolkit.
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** GNU Lesser General Public License Usage
10 ** This file may be used under the terms of the GNU Lesser General Public
11 ** License version 2.1 as published by the Free Software Foundation and
12 ** appearing in the file LICENSE.LGPL included in the packaging of this
13 ** file. Please review the following information to ensure the GNU Lesser
14 ** General Public License version 2.1 requirements will be met:
15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
17 ** In addition, as a special exception, Nokia gives you certain additional
18 ** rights. These rights are described in the Nokia Qt LGPL Exception
19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
21 ** GNU General Public License Usage
22 ** Alternatively, this file may be used under the terms of the GNU General
23 ** Public License version 3.0 as published by the Free Software Foundation
24 ** and appearing in the file LICENSE.GPL included in the packaging of this
25 ** file. Please review the following information to ensure the GNU General
26 ** Public License version 3.0 requirements will be met:
27 ** http://www.gnu.org/copyleft/gpl.html.
30 ** Alternatively, this file may be used in accordance with the terms and
31 ** conditions contained in a signed written agreement between you and Nokia.
40 ****************************************************************************/
45 #include <QtCore/qglobal.h>
46 #include <QtCore/qobject.h>
47 #include <QtCore/qrect.h>
48 #include <QtCore/qset.h>
49 #include <QtCore/qvector.h>
50 #include <QtCore/qvariant.h>
51 #include <QtGui/qcolor.h>
52 #include <QtGui/qevent.h>
59 #ifndef QT_NO_ACCESSIBILITY
61 class QAccessibleInterface;
62 class QAccessibleEvent;
65 // We need to inherit QObject to expose the enums to QML.
66 class Q_GUI_EXPORT QAccessible
72 Q_ENUMS(Role Event State)
78 ForegroundChanged = 0x0003,
81 PopupMenuStart = 0x0006,
82 PopupMenuEnd = 0x0007,
83 ContextHelpStart = 0x000C,
84 ContextHelpEnd = 0x000D,
85 DragDropStart = 0x000E,
89 ScrollingStart = 0x0012,
90 ScrollingEnd = 0x0013,
94 // Values from IAccessible2
95 ActionChanged = 0x0101,
96 ActiveDescendantChanged = 0x0102,
97 AttributeChanged = 0x0103,
98 DocumentContentChanged = 0x0104,
99 DocumentLoadComplete = 0x0105,
100 DocumentLoadStopped = 0x0106,
101 DocumentReload = 0x0107,
102 HyperlinkEndIndexChanged = 0x0108,
103 HyperlinkNumberOfAnchorsChanged = 0x0109,
104 HyperlinkSelectedLinkChanged = 0x010A,
105 HypertextLinkActivated = 0x010B,
106 HypertextLinkSelected = 0x010C,
107 HyperlinkStartIndexChanged = 0x010D,
108 HypertextChanged = 0x010E,
109 HypertextNLinksChanged = 0x010F,
110 ObjectAttributeChanged = 0x0110,
111 PageChanged = 0x0111,
112 SectionChanged = 0x0112,
113 TableCaptionChanged = 0x0113,
114 TableColumnDescriptionChanged = 0x0114,
115 TableColumnHeaderChanged = 0x0115,
116 TableModelChanged = 0x0116,
117 TableRowDescriptionChanged = 0x0117,
118 TableRowHeaderChanged = 0x0118,
119 TableSummaryChanged = 0x0119,
120 TextAttributeChanged = 0x011A,
121 TextCaretMoved = 0x011B,
122 // TextChanged = 0x011C, is deprecated in IA2, use TextUpdated
123 TextColumnChanged = 0x011D,
124 TextInserted = 0x011E,
125 TextRemoved = 0x011F,
126 TextUpdated = 0x0120,
127 TextSelectionChanged = 0x0121,
128 VisibleDataChanged = 0x0122,
130 ObjectCreated = 0x8000,
131 ObjectDestroyed = 0x8001,
134 ObjectReorder = 0x8004,
137 SelectionAdd = 0x8007,
138 SelectionRemove = 0x8008,
139 SelectionWithin = 0x8009,
140 StateChanged = 0x800A,
141 LocationChanged = 0x800B,
142 NameChanged = 0x800C,
143 DescriptionChanged = 0x800D,
144 ValueChanged = 0x800E,
145 ParentChanged = 0x800F,
146 HelpChanged = 0x80A0,
147 DefaultActionChanged = 0x80B0,
148 AcceleratorChanged = 0x80C0
151 // 64 bit enums seem hard on some platforms (windows...)
152 // which makes using a bit field a sensible alternative
154 // http://msdn.microsoft.com/en-us/library/ms697270.aspx
155 quint64 disabled : 1; // used to be Unavailable
156 quint64 selected : 1;
157 quint64 focusable : 1;
160 quint64 checkable : 1;
162 quint64 checkStateMixed : 1; // used to be Mixed
163 quint64 readOnly : 1;
164 quint64 hotTracked : 1;
165 quint64 defaultButton : 1;
166 quint64 expanded : 1;
167 quint64 collapsed : 1;
169 quint64 expandable : 1;
170 quint64 marqueed : 1;
171 quint64 animated : 1;
172 quint64 invisible : 1;
173 quint64 offscreen : 1;
174 quint64 sizeable : 1;
176 quint64 selfVoicing : 1;
177 quint64 selectable : 1;
179 quint64 traversed : 1;
180 quint64 multiSelectable : 1;
181 quint64 extSelectable : 1;
182 quint64 passwordEdit : 1; // used to be Protected
183 quint64 hasPopup : 1;
186 // IA2 - we chose to not add some IA2 states for now
187 // Below the ones that seem helpful
189 quint64 invalid : 1; // = defunct
190 quint64 editable : 1;
191 quint64 multiLine : 1;
192 quint64 selectableText : 1;
193 quint64 supportsAutoCompletion : 1;
195 // quint64 horizontal : 1;
196 // quint64 vertical : 1;
197 // quint64 invalidEntry : 1;
198 // quint64 managesDescendants : 1;
199 // quint64 singleLine : 1; // we have multi line, this is redundant.
200 // quint64 stale : 1;
201 // quint64 transient : 1;
202 // quint64 pinned : 1;
204 // Apple - see http://mattgemmell.com/2010/12/19/accessibility-for-iphone-and-ipad-apps/
205 // quint64 playsSound : 1;
206 // quint64 summaryElement : 1;
207 // quint64 updatesFrequently : 1;
208 // quint64 adjustable : 1;
209 // more and not included here: http://developer.apple.com/library/mac/#documentation/UserExperience/Reference/Accessibility_RoleAttribute_Ref/Attributes.html
212 // quint64 alertLow : 1;
213 // quint64 alertMedium : 1;
214 // quint64 alertHigh : 1;
217 qMemSet(this, 0, sizeof(State));
227 TitleBar = 0x00000001,
228 MenuBar = 0x00000002,
229 ScrollBar = 0x00000003,
234 AlertMessage = 0x00000008,
237 PopupMenu = 0x0000000B,
238 MenuItem = 0x0000000C,
239 ToolTip = 0x0000000D,
240 Application = 0x0000000E,
241 Document = 0x0000000F,
246 Grouping = 0x00000014,
247 Separator = 0x00000015,
248 ToolBar = 0x00000016,
249 StatusBar = 0x00000017,
251 ColumnHeader = 0x00000019,
252 RowHeader = 0x0000001A,
257 HelpBalloon = 0x0000001F,
258 Assistant = 0x00000020,
260 ListItem = 0x00000022,
262 TreeItem = 0x00000024,
263 PageTab = 0x00000025,
264 PropertyPage = 0x00000026,
265 Indicator = 0x00000027,
266 Graphic = 0x00000028,
267 StaticText = 0x00000029,
268 EditableText = 0x0000002A, // Editable, selectable, etc.
271 PushButton = Button, // deprecated
273 CheckBox = 0x0000002C,
274 RadioButton = 0x0000002D,
275 ComboBox = 0x0000002E,
276 // DropList = 0x0000002F,
277 ProgressBar = 0x00000030,
279 HotkeyField = 0x00000032,
281 SpinBox = 0x00000034,
283 Animation = 0x00000036,
284 Equation = 0x00000037,
285 ButtonDropDown = 0x00000038,
286 ButtonMenu = 0x00000039,
287 ButtonDropGrid = 0x0000003A,
288 Whitespace = 0x0000003B,
289 PageTabList = 0x0000003C,
291 Splitter = 0x0000003E,
292 // Additional Qt roles where enum value does not map directly to MSAA:
293 LayeredPane = 0x0000003F,
294 Terminal = 0x00000040,
295 UserRole = 0x0000ffff
305 UserText = 0x0000ffff
310 Labelled = 0x00040000,
311 Controller = 0x00080000,
312 Controlled = 0x00100000,
313 AllRelations = 0xffffffff
315 Q_DECLARE_FLAGS(Relation, RelationFlag)
320 EditableTextInterface,
328 typedef QAccessibleInterface*(*InterfaceFactory)(const QString &key, QObject*);
329 typedef void(*UpdateHandler)(const QAccessibleEvent &event);
330 typedef void(*RootObjectHandler)(QObject*);
332 static void installFactory(InterfaceFactory);
333 static void removeFactory(InterfaceFactory);
334 static UpdateHandler installUpdateHandler(UpdateHandler);
335 static RootObjectHandler installRootObjectHandler(RootObjectHandler);
337 static QAccessibleInterface *queryAccessibleInterface(QObject *);
339 static void updateAccessibility(QObject *object, int child, Event reason);
340 static void updateAccessibility(const QAccessibleEvent &event);
342 static bool isActive();
343 static void setRootObject(QObject *object);
345 static void cleanup();
348 static UpdateHandler updateHandler;
349 static RootObjectHandler rootObjectHandler;
352 This class is purely a collection of enums and static functions,
353 it is not supposed to be instantiated.
358 Q_GUI_EXPORT bool operator==(const QAccessible::State &first, const QAccessible::State &second);
360 Q_DECLARE_OPERATORS_FOR_FLAGS(QAccessible::Relation)
362 class QAccessible2Interface;
363 class QAccessibleTextInterface;
364 class QAccessibleEditableTextInterface;
365 class QAccessibleValueInterface;
366 class QAccessibleActionInterface;
367 class QAccessibleImageInterface;
368 class QAccessibleTableInterface;
369 class QAccessibleTableCellInterface;
371 class Q_GUI_EXPORT QAccessibleInterface
374 virtual ~QAccessibleInterface() {}
375 // check for valid pointers
376 virtual bool isValid() const = 0;
377 virtual QObject *object() const = 0;
378 virtual QWindow *window() const;
381 virtual QVector<QPair<QAccessibleInterface*, QAccessible::Relation> > relations(QAccessible::Relation match = QAccessible::AllRelations) const;
382 virtual QAccessibleInterface *focusChild() const;
384 virtual QAccessibleInterface *childAt(int x, int y) const = 0;
386 // navigation, hierarchy
387 virtual QAccessibleInterface *parent() const = 0;
388 virtual QAccessibleInterface *child(int index) const = 0;
389 virtual int childCount() const = 0;
390 virtual int indexOfChild(const QAccessibleInterface *) const = 0;
392 // properties and state
393 virtual QString text(QAccessible::Text t) const = 0;
394 virtual void setText(QAccessible::Text t, const QString &text) = 0;
395 virtual QRect rect() const = 0;
396 virtual QAccessible::Role role() const = 0;
397 virtual QAccessible::State state() const = 0;
399 virtual QColor foregroundColor() const;
400 virtual QColor backgroundColor() const;
402 inline QAccessibleTextInterface *textInterface()
403 { return reinterpret_cast<QAccessibleTextInterface *>(interface_cast(QAccessible::TextInterface)); }
405 inline QAccessibleEditableTextInterface *editableTextInterface()
406 { return reinterpret_cast<QAccessibleEditableTextInterface *>(interface_cast(QAccessible::EditableTextInterface)); }
408 inline QAccessibleValueInterface *valueInterface()
409 { return reinterpret_cast<QAccessibleValueInterface *>(interface_cast(QAccessible::ValueInterface)); }
411 inline QAccessibleActionInterface *actionInterface()
412 { return reinterpret_cast<QAccessibleActionInterface *>(interface_cast(QAccessible::ActionInterface)); }
414 inline QAccessibleImageInterface *imageInterface()
415 { return reinterpret_cast<QAccessibleImageInterface *>(interface_cast(QAccessible::ImageInterface)); }
417 inline QAccessibleTableInterface *tableInterface()
418 { return reinterpret_cast<QAccessibleTableInterface *>(interface_cast(QAccessible::TableInterface)); }
420 inline QAccessibleTableCellInterface *tableCellInterface()
421 { return reinterpret_cast<QAccessibleTableCellInterface *>(interface_cast(QAccessible::TableCellInterface)); }
423 virtual void virtual_hook(int id, void *data);
425 virtual void *interface_cast(QAccessible::InterfaceType)
430 class Q_GUI_EXPORT QAccessibleEvent
433 inline QAccessibleEvent(QAccessible::Event typ, QObject *obj, int chld = -1)
434 : m_type(typ), m_object(obj), m_child(chld)
439 QAccessible::Event type() const { return m_type; }
440 QObject *object() const { return m_object; }
441 int child() const { return m_child; }
443 QAccessibleInterface *accessibleInterface() const;
446 QAccessible::Event m_type;
452 #define QAccessibleInterface_iid "org.qt-project.Qt.QAccessibleInterface"
453 Q_DECLARE_INTERFACE(QAccessibleInterface, QAccessibleInterface_iid)
455 Q_GUI_EXPORT const char *qAccessibleRoleString(QAccessible::Role role);
456 Q_GUI_EXPORT const char *qAccessibleEventString(QAccessible::Event event);
458 #ifndef QT_NO_DEBUG_STREAM
459 Q_GUI_EXPORT QDebug operator<<(QDebug d, const QAccessibleInterface *iface);
462 #endif // QT_NO_ACCESSIBILITY
468 #endif // QACCESSIBLE_H