diff options
authorFrederik Gladhorn <>2011-11-22 23:12:01 +0100
committerQt by Nokia <>2011-11-23 16:30:26 +0100
commit013a3ee5dcecd18da9ed05ac2b064629f8eaed61 (patch)
parent88834ffe78e7734fa2f759f649935060ef45b4c1 (diff)
Improve docs for Accessibility.
While still lacking, at least try to reflect reality a bit. Change-Id: I8fcd0bd540806f3d1e314c60d854d2a90f66c14e Reviewed-by: Casper van Donderen <>
1 files changed, 16 insertions, 30 deletions
diff --git a/src/gui/accessible/qaccessible.cpp b/src/gui/accessible/qaccessible.cpp
index 34484ad352..5faadc8dfb 100644
--- a/src/gui/accessible/qaccessible.cpp
+++ b/src/gui/accessible/qaccessible.cpp
@@ -709,7 +709,7 @@ void QAccessible::updateAccessibility(QObject *o, int who, Event reason)
about accessible objects.
\ingroup accessibility
- \inmodule QtWidgets
+ \inmodule QtGui
Accessibility tools (also called AT Clients), such as screen readers
or braille displays, require high-level information about
@@ -772,39 +772,25 @@ void QAccessible::updateAccessibility(QObject *o, int who, Event reason)
accessible object. This information is usually only available for
visual objects.
- \section1 Actions and Selection
+ \section1 Interfaces
To enable the user to interact with an accessible object the
- object must expose information about the actions that it can
- perform. userActionCount() returns the number of actions supported by
- an accessible object, and actionText() returns textual information
- about those actions. doAction() invokes an action.
+ object must implement QAccessibleActionInterface in addition to
+ QAccessibleInterface.
Objects that support selections can define actions to change the selection.
- \section2 Objects and children
- A QAccessibleInterface provides information about the accessible
- object, and can also provide information for the children of that
- object if those children don't provide a QAccessibleInterface
- implementation themselves. This is practical if the object has
- many similar children (e.g. items in a list view), or if the
- children are an integral part of the object itself, for example, the
- different sections in a scroll bar.
- If an accessible object provides information about its children
- through one QAccessibleInterface, the children are referenced
- using indexes. The index is 1-based for the children, i.e. 0
- refers to the object itself, 1 to the first child, 2 to the second
- child, and so on.
- All functions in QAccessibleInterface that take a child index
- relate to the object itself if the index is 0, or to the child
- specified. If a child provides its own interface implementation
- (which can be retrieved through navigation) asking the parent for
- information about that child will usually not succeed.
- \sa QAccessible
+ There are several other interfaces that should be implemented as required.
+ QAccessibleTextInterface should be used for bigger texts edits such as document views.
+ This interface should not be implemented for labels/single line edits.
+ The complementary QAccessibleEditableTextInterface should be added when the
+ Text is editable.
+ For sliders, scrollbars and other numerical value selectors QAccessibleValueInterface
+ should be implemented.
+ Lists, tables and trees should implement QAccessibleTableInterface.
+ \sa QAccessible, QAccessibleActionInterface, QAccessibleTextInterface, QAccessibleEditableTextInterface, QAccessibleValueInterface, QAccessibleTableInterface