summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFrederik Gladhorn <frederik.gladhorn@nokia.com>2012-02-09 11:21:18 +0100
committerQt by Nokia <qt-info@nokia.com>2012-02-10 00:27:44 +0100
commit8522cb5c97e092d83484768152704f7d9a69901d (patch)
tree41fc9ea7f13e8c0e9649e4dd2c08bf7b4b756ebb
parentc6a1cb701ce1a973d9c950161d72db0e7f9a6b7c (diff)
Update docs for QAccessibleEvent.
This class completely changed, the old docs were still around. Change-Id: Ice7b106b33ffc60f45f7af1b4f44dc01462ee0da Reviewed-by: Jan-Arve Sæther <jan-arve.saether@nokia.com>
-rw-r--r--src/gui/accessible/qaccessible.cpp56
1 files changed, 10 insertions, 46 deletions
diff --git a/src/gui/accessible/qaccessible.cpp b/src/gui/accessible/qaccessible.cpp
index b45c7e8d84..dd0468d9f9 100644
--- a/src/gui/accessible/qaccessible.cpp
+++ b/src/gui/accessible/qaccessible.cpp
@@ -1158,60 +1158,24 @@ QColor QAccessibleInterface::backgroundColor() const
/*!
\class QAccessibleEvent
- \internal
-
- \brief The QAccessibleEvent class is used to query addition
- accessibility information about complex widgets.
-
- The event can be of type QEvent::AccessibilityDescription or
- QEvent::AccessibilityHelp.
+ \brief The QAccessibleEvent class is used to give detailed updates to the
+ accessibility framework. It is used together with \l QAccessible::updateAccessibility.
- Some QAccessibleInterface implementations send QAccessibleEvents
- to the widget they wrap to obtain the description or help text of
- a widget or of its children. The widget can answer by calling
- setValue() with the requested information.
-
- The default QWidget::event() implementation simply sets the text
- to be the widget's \l{QWidget::toolTip}{tooltip} (for \l
- AccessibilityDescription event) or its
- \l{QWidget::whatsThis}{"What's This?" text} (for \l
- AccessibilityHelp event).
+ The event is one of the \l QAccessible::Event which depending on the type of event needs to use
+ one of the subclasses of QAccessibleEvent.
\ingroup accessibility
- \ingroup events
- \inmodule QtWidgets
-*/
-
-/*!
- \fn QAccessibleEvent::QAccessibleEvent(Type type)
-
- Constructs an accessibility event of the given \a type, which
- must be QEvent::AccessibilityDescription or
- QEvent::AccessibilityHelp.
-*/
-
-/*!
- \fn int QAccessibleEvent::child() const
-
- Returns the (1-based) index of the child to which the request
- applies. If the child is 0, the request is for the widget itself.
-*/
-
-/*!
- \fn QString QAccessibleEvent::value() const
-
- Returns the text set using setValue().
-
- \sa setValue()
+ \inmodule QtGui
*/
/*!
- \fn void QAccessibleEvent::setValue(const QString &text)
+ \fn QAccessibleEvent::QAccessibleEvent(QAccessible::Event type, QObject *object, int child = -1)
- Set the description or help text for the given child() to \a
- text, thereby answering the request.
+ Constructs an accessibility event of the given \a type.
+ It also requires an \a object as source of the event and optionally a \a child index,
+ if the event comes from a child of the object.
- \sa value()
+ Using a \a child index maybe more efficient than creating the accessible interface for the child.
*/
/*!