Remove "All rights reserved" line from license headers.
[profile/ivi/qtdeclarative.git] / src / quick / items / qquickaccessibleattached.cpp
index 4fa3b87..ed52055 100644 (file)
@@ -1,8 +1,7 @@
 /****************************************************************************
 **
-** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
-** All rights reserved.
-** Contact: Nokia Corporation (qt-info@nokia.com)
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
 **
 ** This file is part of the QtDeclarative module of the Qt Toolkit.
 **
@@ -35,6 +34,7 @@
 **
 **
 **
+**
 ** $QT_END_LICENSE$
 **
 ****************************************************************************/
@@ -49,9 +49,13 @@ QT_BEGIN_NAMESPACE
 
 /*!
     \qmlclass Accessible QQuickAccessibleAttached
+    \brief Attached property to enable accessibility of QML items.
+
     \inqmlmodule QtQuick 2
     \ingroup qml-basic-interaction-elements
-    \brief Attached property to enable accessibility of QML items.
+    \ingroup accessibility
+
+    This class is part of \l {Accessibility for Qt Quick Applications}.
 
     Items the user interacts with or that give information to the user
     need to expose their information in a semantic way.
@@ -102,6 +106,35 @@ QT_BEGIN_NAMESPACE
         Accessible.role: Accessible.Button
     }
     \endqml
+
+    Some roles have special semantics.
+    In order to implement check boxes for example a "checked" property is expected.
+
+    \table
+    \header
+        \o \bold {Role}
+        \o \bold {Expected property}
+        \o
+
+    \row
+       \o CheckBox
+       \o checked
+       \o The check state of the check box.
+    \row
+       \o RadioButton
+       \o checked
+       \o The selected state of the radio button.
+    \row
+       \o Button
+       \o checkable
+       \o Whether the button is checkable.
+    \row
+       \o Button
+       \o checked
+       \o Whether the button is checked (only if checkable is true).
+
+    \endtable
+
 */
 
 QQuickAccessibleAttached::QQuickAccessibleAttached(QObject *parent)