Add documenation about QAccessibleStateChange event.

Change-Id: Iea34d71d71a6dd58f761722ce20ae8ec2b81ae58
Reviewed-by: Jan-Arve Sæther <jan-arve.saether@nokia.com>

1 files changed, 23 insertions, 0 deletions

diff --git a/src/gui/accessible/qaccessible.cpp b/src/gui/accessible/qaccessible.cpp
index 91b0b5fbe6..cb89fccc2d 100644
--- a/src/gui/accessible/qaccessible.cpp
+++ b/src/gui/accessible/qaccessible.cpp
@@ -697,9 +697,32 @@ void QAccessible::updateAccessibility(const QAccessibleEvent &event)
 
     This class should be created on the stack and used as parameter for
     \l QAccessible::updateAccessibility().
+    \sa QAccessibleStateChangedEvent
 */
 
 /*!
+    \class QAccessibleStateChangedEvent
+    \brief This subclass of QAccessibleEvent is used to inform about state changes.
+    \internal
+
+    \ingroup accessibility
+    \inmodule QtGui
+
+    This class should be created on the stack and used as parameter for
+    \l QAccessible::updateAccessibility().
+    In addition to the regular \l QAccessibleEvent it contains details about which states
+    changed.
+    \sa QAccessibleEvent
+*/
+
+/*!
+    \fn QAccessibleStateChangeEvent::changedStates() const
+    All states that have changed are set to true. This does not reflect the state of the object,
+    but indicates which states are changed.
+    Use the \l QAccessibleInterface::state() function to get the current state.
+ */
+
+/*!
     Returns the QAccessibleInterface associated with the event.
 
     The caller of this function takes ownership of the returned interface.