8#pragma qt_class(QAccessible)
13#include <QtGui/qtguiglobal.h>
15#if QT_CONFIG(accessibility)
17#include <QtCore/qcoreapplication.h>
18#include <QtCore/qglobal.h>
19#include <QtCore/qlist.h>
20#include <QtCore/qobject.h>
21#include <QtCore/qrect.h>
22#include <QtCore/qset.h>
23#include <QtCore/qvariant.h>
24#include <QtGui/qcolor.h>
25#include <QtGui/qevent.h>
26#include <QtGui/qaccessible_base.h>
31class QAccessibleInterface;
32class QAccessibleEvent;
36class QAccessible2Interface;
37class QAccessibleTextInterface;
38class QAccessibleEditableTextInterface;
39class QAccessibleValueInterface;
40class QAccessibleActionInterface;
41class QAccessibleImageInterface;
42class QAccessibleTableInterface;
43class QAccessibleTableCellInterface;
44class QAccessibleHyperlinkInterface;
45class QAccessibleSelectionInterface;
46class QAccessibleAttributesInterface;
47class QAccessibleTableModelChangeEvent;
49class Q_GUI_EXPORT QAccessibleInterface
52 virtual ~QAccessibleInterface();
56 virtual bool isValid()
const = 0;
57 virtual QObject *object()
const = 0;
58 virtual QWindow *window()
const;
61 virtual QList<std::pair<QAccessibleInterface *, QAccessible::Relation>>
62 relations(QAccessible::Relation match = QAccessible::AllRelations)
const;
63 virtual QAccessibleInterface *focusChild()
const;
65 virtual QAccessibleInterface *childAt(
int x,
int y)
const = 0;
68 virtual QAccessibleInterface *parent()
const = 0;
69 virtual QAccessibleInterface *child(
int index)
const = 0;
70 virtual int childCount()
const = 0;
71 virtual int indexOfChild(
const QAccessibleInterface *)
const = 0;
74 virtual QString text(QAccessible::Text t)
const = 0;
75 virtual void setText(QAccessible::Text t,
const QString &text) = 0;
76 virtual QRect rect()
const = 0;
77 virtual QAccessible::Role role()
const = 0;
78 virtual QAccessible::State state()
const = 0;
80 virtual QColor foregroundColor()
const;
81 virtual QColor backgroundColor()
const;
83 inline QAccessibleTextInterface *textInterface()
84 {
return reinterpret_cast<QAccessibleTextInterface *>(interface_cast(QAccessible::TextInterface)); }
86 inline QAccessibleEditableTextInterface *editableTextInterface()
87 {
return reinterpret_cast<QAccessibleEditableTextInterface *>(interface_cast(QAccessible::EditableTextInterface)); }
89 inline QAccessibleValueInterface *valueInterface()
90 {
return reinterpret_cast<QAccessibleValueInterface *>(interface_cast(QAccessible::ValueInterface)); }
92 inline QAccessibleActionInterface *actionInterface()
93 {
return reinterpret_cast<QAccessibleActionInterface *>(interface_cast(QAccessible::ActionInterface)); }
95 inline QAccessibleImageInterface *imageInterface()
96 {
return reinterpret_cast<QAccessibleImageInterface *>(interface_cast(QAccessible::ImageInterface)); }
98 inline QAccessibleTableInterface *tableInterface()
99 {
return reinterpret_cast<QAccessibleTableInterface *>(interface_cast(QAccessible::TableInterface)); }
101 inline QAccessibleTableCellInterface *tableCellInterface()
102 {
return reinterpret_cast<QAccessibleTableCellInterface *>(interface_cast(QAccessible::TableCellInterface)); }
104 inline QAccessibleHyperlinkInterface *hyperlinkInterface()
105 {
return reinterpret_cast<QAccessibleHyperlinkInterface *>(interface_cast(QAccessible::HyperlinkInterface)); }
107 inline QAccessibleSelectionInterface *selectionInterface()
108 {
return reinterpret_cast<QAccessibleSelectionInterface *>(interface_cast(QAccessible::SelectionInterface)); }
110 inline QAccessibleAttributesInterface *attributesInterface()
111 {
return reinterpret_cast<QAccessibleAttributesInterface *>(interface_cast(QAccessible::AttributesInterface)); }
113 virtual void virtual_hook(
int id,
void *data);
115 virtual void *interface_cast(QAccessible::InterfaceType)
119 friend class QAccessibleCache;
122class Q_GUI_EXPORT QAccessibleTextInterface
125 virtual ~QAccessibleTextInterface();
127 virtual void selection(
int selectionIndex,
int *startOffset,
int *endOffset)
const = 0;
128 virtual int selectionCount()
const = 0;
129 virtual void addSelection(
int startOffset,
int endOffset) = 0;
130 virtual void removeSelection(
int selectionIndex) = 0;
131 virtual void setSelection(
int selectionIndex,
int startOffset,
int endOffset) = 0;
134 virtual int cursorPosition()
const = 0;
135 virtual void setCursorPosition(
int position) = 0;
138 virtual QString text(
int startOffset,
int endOffset)
const = 0;
139 virtual QString textBeforeOffset(
int offset, QAccessible::TextBoundaryType boundaryType,
140 int *startOffset,
int *endOffset)
const;
141 virtual QString textAfterOffset(
int offset, QAccessible::TextBoundaryType boundaryType,
142 int *startOffset,
int *endOffset)
const;
143 virtual QString textAtOffset(
int offset, QAccessible::TextBoundaryType boundaryType,
144 int *startOffset,
int *endOffset)
const;
145 virtual int characterCount()
const = 0;
148 virtual QRect characterRect(
int offset)
const = 0;
149 virtual int offsetAtPoint(
const QPoint &point)
const = 0;
151 virtual void scrollToSubstring(
int startIndex,
int endIndex) = 0;
152 virtual QString attributes(
int offset,
int *startOffset,
int *endOffset)
const = 0;
155class Q_GUI_EXPORT QAccessibleEditableTextInterface
158 virtual ~QAccessibleEditableTextInterface();
160 virtual void deleteText(
int startOffset,
int endOffset) = 0;
161 virtual void insertText(
int offset,
const QString &text) = 0;
162 virtual void replaceText(
int startOffset,
int endOffset,
const QString &text) = 0;
165class Q_GUI_EXPORT QAccessibleValueInterface
168 virtual ~QAccessibleValueInterface();
170 virtual QVariant currentValue()
const = 0;
171 virtual void setCurrentValue(
const QVariant &value) = 0;
172 virtual QVariant maximumValue()
const = 0;
173 virtual QVariant minimumValue()
const = 0;
174 virtual QVariant minimumStepSize()
const = 0;
177class Q_GUI_EXPORT QAccessibleTableCellInterface
180 virtual ~QAccessibleTableCellInterface();
182 virtual bool isSelected()
const = 0;
184 virtual QList<QAccessibleInterface*> columnHeaderCells()
const = 0;
185 virtual QList<QAccessibleInterface*> rowHeaderCells()
const = 0;
186 virtual int columnIndex()
const = 0;
187 virtual int rowIndex()
const = 0;
188 virtual int columnExtent()
const = 0;
189 virtual int rowExtent()
const = 0;
191 virtual QAccessibleInterface* table()
const = 0;
194class Q_GUI_EXPORT QAccessibleTableInterface
197 virtual ~QAccessibleTableInterface();
199 virtual QAccessibleInterface *caption()
const = 0;
200 virtual QAccessibleInterface *summary()
const = 0;
202 virtual QAccessibleInterface *cellAt (
int row,
int column)
const = 0;
203 virtual int selectedCellCount()
const = 0;
204 virtual QList<QAccessibleInterface*> selectedCells()
const = 0;
206 virtual QString columnDescription(
int column)
const = 0;
207 virtual QString rowDescription(
int row)
const = 0;
208 virtual int selectedColumnCount()
const = 0;
209 virtual int selectedRowCount()
const = 0;
210 virtual int columnCount()
const = 0;
211 virtual int rowCount()
const = 0;
212 virtual QList<
int> selectedColumns()
const = 0;
213 virtual QList<
int> selectedRows()
const = 0;
214 virtual bool isColumnSelected(
int column)
const = 0;
215 virtual bool isRowSelected(
int row)
const = 0;
216 virtual bool selectRow(
int row) = 0;
217 virtual bool selectColumn(
int column) = 0;
218 virtual bool unselectRow(
int row) = 0;
219 virtual bool unselectColumn(
int column) = 0;
221 virtual void modelChange(QAccessibleTableModelChangeEvent *event) = 0;
224friend class QAbstractItemView;
225friend class QAbstractItemViewPrivate;
228class Q_GUI_EXPORT QAccessibleActionInterface
230 Q_DECLARE_TR_FUNCTIONS(QAccessibleActionInterface)
232 virtual ~QAccessibleActionInterface();
234 virtual QStringList actionNames()
const = 0;
235 virtual QString localizedActionName(
const QString &name)
const;
236 virtual QString localizedActionDescription(
const QString &name)
const;
237 virtual void doAction(
const QString &actionName) = 0;
238 virtual QStringList keyBindingsForAction(
const QString &actionName)
const = 0;
240 static const QString &pressAction();
241 static const QString &increaseAction();
242 static const QString &decreaseAction();
243 static const QString &showMenuAction();
244 static const QString &setFocusAction();
245 static const QString &toggleAction();
246 static QString scrollLeftAction();
247 static QString scrollRightAction();
248 static QString scrollUpAction();
249 static QString scrollDownAction();
250 static QString nextPageAction();
251 static QString previousPageAction();
254class Q_GUI_EXPORT QAccessibleImageInterface
257 virtual ~QAccessibleImageInterface();
259 virtual QString imageDescription()
const = 0;
260 virtual QSize imageSize()
const = 0;
261 virtual QPoint imagePosition()
const = 0;
264class Q_GUI_EXPORT QAccessibleHyperlinkInterface
267 virtual ~QAccessibleHyperlinkInterface();
269 virtual QString anchor()
const = 0;
270 virtual QString anchorTarget()
const = 0;
271 virtual int startIndex()
const = 0;
272 virtual int endIndex()
const = 0;
273 virtual bool isValid()
const = 0;
276class Q_GUI_EXPORT QAccessibleSelectionInterface
279 virtual ~QAccessibleSelectionInterface();
281 virtual int selectedItemCount()
const = 0;
282 virtual QList<QAccessibleInterface*> selectedItems()
const = 0;
283 virtual QAccessibleInterface* selectedItem(
int selectionIndex)
const;
284 virtual bool isSelected(QAccessibleInterface *childItem)
const;
285 virtual bool select(QAccessibleInterface *childItem) = 0;
286 virtual bool unselect(QAccessibleInterface *childItem) = 0;
287 virtual bool selectAll() = 0;
288 virtual bool clear() = 0;
291class Q_GUI_EXPORT QAccessibleAttributesInterface
294 virtual ~QAccessibleAttributesInterface();
295 virtual QList<QAccessible::Attribute> attributeKeys()
const = 0;
296 virtual QVariant attributeValue(QAccessible::Attribute key)
const = 0;
300class Q_GUI_EXPORT QAccessibleEvent
302 Q_DISABLE_COPY(QAccessibleEvent)
305 inline QAccessibleEvent(QObject *obj, QAccessible::Event typ)
306 : m_type(typ), m_object(obj), m_child(-1)
308 if (m_type != QAccessible::ObjectDestroyed)
312 Q_ASSERT(m_type != QAccessible::ValueChanged);
313 Q_ASSERT(m_type != QAccessible::StateChanged);
314 Q_ASSERT(m_type != QAccessible::TextCaretMoved);
315 Q_ASSERT(m_type != QAccessible::TextSelectionChanged);
316 Q_ASSERT(m_type != QAccessible::TextInserted);
317 Q_ASSERT(m_type != QAccessible::TextRemoved);
318 Q_ASSERT(m_type != QAccessible::TextUpdated);
319 Q_ASSERT(m_type != QAccessible::TableModelChanged);
320 Q_ASSERT(m_type != QAccessible::Announcement);
323 inline QAccessibleEvent(QAccessibleInterface *iface, QAccessible::Event typ)
327 Q_ASSERT(m_type != QAccessible::ValueChanged);
328 Q_ASSERT(m_type != QAccessible::StateChanged);
329 Q_ASSERT(m_type != QAccessible::TextCaretMoved);
330 Q_ASSERT(m_type != QAccessible::TextSelectionChanged);
331 Q_ASSERT(m_type != QAccessible::TextInserted);
332 Q_ASSERT(m_type != QAccessible::TextRemoved);
333 Q_ASSERT(m_type != QAccessible::TextUpdated);
334 Q_ASSERT(m_type != QAccessible::TableModelChanged);
335 Q_ASSERT(m_type != QAccessible::Announcement);
336 m_uniqueId = QAccessible::uniqueId(iface);
337 m_object = iface->object();
340 virtual ~QAccessibleEvent();
342 QAccessible::Event type()
const {
return m_type; }
343 QObject *object()
const {
return m_object; }
344 QAccessible::Id uniqueId()
const;
346 void setChild(
int chld);
347 int child()
const {
return m_child; }
349 virtual QAccessibleInterface *accessibleInterface()
const;
352 QAccessible::Event m_type;
356 QAccessible::Id m_uniqueId;
359 friend class QTestAccessibility;
362class Q_GUI_EXPORT QAccessibleStateChangeEvent :
public QAccessibleEvent
365 inline QAccessibleStateChangeEvent(QObject *obj, QAccessible::State state)
366 : QAccessibleEvent(obj, QAccessible::InvalidEvent), m_changedStates(state)
368 m_type = QAccessible::StateChanged;
370 inline QAccessibleStateChangeEvent(QAccessibleInterface *iface, QAccessible::State state)
371 : QAccessibleEvent(iface, QAccessible::InvalidEvent), m_changedStates(state)
373 m_type = QAccessible::StateChanged;
375 ~QAccessibleStateChangeEvent();
377 QAccessible::State changedStates()
const {
378 return m_changedStates;
382 QAccessible::State m_changedStates;
386class Q_GUI_EXPORT QAccessibleTextCursorEvent :
public QAccessibleEvent
389 inline QAccessibleTextCursorEvent(QObject *obj,
int cursorPos)
390 : QAccessibleEvent(obj, QAccessible::InvalidEvent)
391 , m_cursorPosition(cursorPos)
393 m_type = QAccessible::TextCaretMoved;
395 inline QAccessibleTextCursorEvent(QAccessibleInterface *iface,
int cursorPos)
396 : QAccessibleEvent(iface, QAccessible::InvalidEvent)
397 , m_cursorPosition(cursorPos)
399 m_type = QAccessible::TextCaretMoved;
402 ~QAccessibleTextCursorEvent();
404 void setCursorPosition(
int position) { m_cursorPosition = position; }
405 int cursorPosition()
const {
return m_cursorPosition; }
408 int m_cursorPosition;
412class Q_GUI_EXPORT QAccessibleTextSelectionEvent :
public QAccessibleTextCursorEvent
415 inline QAccessibleTextSelectionEvent(QObject *obj,
int start,
int end)
416 : QAccessibleTextCursorEvent(obj, (start == -1) ? 0 : end)
417 , m_selectionStart(start), m_selectionEnd(end)
419 m_type = QAccessible::TextSelectionChanged;
421 inline QAccessibleTextSelectionEvent(QAccessibleInterface *iface,
int start,
int end)
422 : QAccessibleTextCursorEvent(iface, (start == -1) ? 0 : end)
423 , m_selectionStart(start), m_selectionEnd(end)
425 m_type = QAccessible::TextSelectionChanged;
428 ~QAccessibleTextSelectionEvent();
430 void setSelection(
int start,
int end) {
431 m_selectionStart = start;
432 m_selectionEnd = end;
435 int selectionStart()
const {
return m_selectionStart; }
436 int selectionEnd()
const {
return m_selectionEnd; }
439 int m_selectionStart;
443class Q_GUI_EXPORT QAccessibleTextInsertEvent :
public QAccessibleTextCursorEvent
446 inline QAccessibleTextInsertEvent(QObject *obj,
int position,
const QString &text)
447 : QAccessibleTextCursorEvent(obj, position +
int(text.size()))
448 , m_position(position), m_text(text)
450 m_type = QAccessible::TextInserted;
452 inline QAccessibleTextInsertEvent(QAccessibleInterface *iface,
int position,
const QString &text)
453 : QAccessibleTextCursorEvent(iface, position +
int(text.size()))
454 , m_position(position), m_text(text)
456 m_type = QAccessible::TextInserted;
459 ~QAccessibleTextInsertEvent();
461 QString textInserted()
const {
464 int changePosition()
const {
473class Q_GUI_EXPORT QAccessibleTextRemoveEvent :
public QAccessibleTextCursorEvent
476 inline QAccessibleTextRemoveEvent(QObject *obj,
int position,
const QString &text)
477 : QAccessibleTextCursorEvent(obj, position)
478 , m_position(position), m_text(text)
480 m_type = QAccessible::TextRemoved;
482 inline QAccessibleTextRemoveEvent(QAccessibleInterface *iface,
int position,
const QString &text)
483 : QAccessibleTextCursorEvent(iface, position)
484 , m_position(position), m_text(text)
486 m_type = QAccessible::TextRemoved;
489 ~QAccessibleTextRemoveEvent();
491 QString textRemoved()
const {
494 int changePosition()
const {
503class Q_GUI_EXPORT QAccessibleTextUpdateEvent :
public QAccessibleTextCursorEvent
506 inline QAccessibleTextUpdateEvent(QObject *obj,
int position,
const QString &oldText,
const QString &text)
507 : QAccessibleTextCursorEvent(obj, position +
int(text.size()))
508 , m_position(position), m_oldText(oldText), m_text(text)
510 m_type = QAccessible::TextUpdated;
512 inline QAccessibleTextUpdateEvent(QAccessibleInterface *iface,
int position,
const QString &oldText,
const QString &text)
513 : QAccessibleTextCursorEvent(iface, position +
int(text.size()))
514 , m_position(position), m_oldText(oldText), m_text(text)
516 m_type = QAccessible::TextUpdated;
519 ~QAccessibleTextUpdateEvent();
521 QString textRemoved()
const {
524 QString textInserted()
const {
527 int changePosition()
const {
537class Q_GUI_EXPORT QAccessibleValueChangeEvent :
public QAccessibleEvent
540 inline QAccessibleValueChangeEvent(QObject *obj,
const QVariant &val)
541 : QAccessibleEvent(obj, QAccessible::InvalidEvent)
544 m_type = QAccessible::ValueChanged;
546 inline QAccessibleValueChangeEvent(QAccessibleInterface *iface,
const QVariant &val)
547 : QAccessibleEvent(iface, QAccessible::InvalidEvent)
550 m_type = QAccessible::ValueChanged;
553 ~QAccessibleValueChangeEvent();
555 void setValue(
const QVariant & val) { m_value= val; }
556 QVariant value()
const {
return m_value; }
562class Q_GUI_EXPORT QAccessibleTableModelChangeEvent :
public QAccessibleEvent
565 enum ModelChangeType {
574 inline QAccessibleTableModelChangeEvent(QObject *obj, ModelChangeType changeType)
575 : QAccessibleEvent(obj, QAccessible::InvalidEvent)
576 , m_modelChangeType(changeType)
577 , m_firstRow(-1), m_firstColumn(-1), m_lastRow(-1), m_lastColumn(-1)
579 m_type = QAccessible::TableModelChanged;
581 inline QAccessibleTableModelChangeEvent(QAccessibleInterface *iface, ModelChangeType changeType)
582 : QAccessibleEvent(iface, QAccessible::InvalidEvent)
583 , m_modelChangeType(changeType)
584 , m_firstRow(-1), m_firstColumn(-1), m_lastRow(-1), m_lastColumn(-1)
586 m_type = QAccessible::TableModelChanged;
589 ~QAccessibleTableModelChangeEvent();
591 void setModelChangeType(ModelChangeType changeType) { m_modelChangeType = changeType; }
592 ModelChangeType modelChangeType()
const {
return m_modelChangeType; }
594 void setFirstRow(
int row) { m_firstRow = row; }
595 void setFirstColumn(
int col) { m_firstColumn = col; }
596 void setLastRow(
int row) { m_lastRow = row; }
597 void setLastColumn(
int col) { m_lastColumn = col; }
598 int firstRow()
const {
return m_firstRow; }
599 int firstColumn()
const {
return m_firstColumn; }
600 int lastRow()
const {
return m_lastRow; }
601 int lastColumn()
const {
return m_lastColumn; }
604 ModelChangeType m_modelChangeType;
611class Q_GUI_EXPORT QAccessibleAnnouncementEvent :
public QAccessibleEvent
614 explicit QAccessibleAnnouncementEvent(QObject *object,
const QString &message)
615 : QAccessibleEvent(object, QAccessible::InvalidEvent)
617 , m_politeness(QAccessible::AnnouncementPoliteness::Polite)
619 m_type = QAccessible::Announcement;
622 explicit QAccessibleAnnouncementEvent(QAccessibleInterface *iface,
const QString &message)
623 : QAccessibleEvent(iface, QAccessible::InvalidEvent)
625 , m_politeness(QAccessible::AnnouncementPoliteness::Polite)
627 m_type = QAccessible::Announcement;
630 ~QAccessibleAnnouncementEvent() override;
632 QString message()
const {
return m_message; }
633 QAccessible::AnnouncementPoliteness politeness()
const {
return m_politeness; }
634 void setPoliteness(QAccessible::AnnouncementPoliteness politeness)
635 { m_politeness = politeness; }
639 QAccessible::AnnouncementPoliteness m_politeness;
643#define QAccessibleInterface_iid "org.qt-project.Qt.QAccessibleInterface"
644Q_DECLARE_INTERFACE(QAccessibleInterface, QAccessibleInterface_iid)
647Q_GUI_EXPORT
const char *qAccessibleRoleString(QAccessible::Role role);
648Q_GUI_EXPORT
const char *qAccessibleEventString(QAccessible::Event event);
649Q_GUI_EXPORT QString qAccessibleLocalizedActionDescription(
const QString &actionName);
651#ifndef QT_NO_DEBUG_STREAM
652Q_GUI_EXPORT QDebug operator<<(QDebug d,
const QAccessibleInterface *iface);
653Q_GUI_EXPORT QDebug operator<<(QDebug d,
const QAccessibleEvent &ev);
Q_STATIC_LOGGING_CATEGORY(lcAccessibilityCore, "qt.accessibility.core")