src/quick/items/qquickaccessibleattached.cpp

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: http://www.qt-project.org/
   6 **
   7 ** This file is part of the QtDeclarative module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #include "qquickaccessibleattached_p.h"
  43
  44 #ifndef QT_NO_ACCESSIBILITY
  45
  46 #include "private/qquickitem_p.h"
  47
  48 QT_BEGIN_NAMESPACE
  49
  50 /*!
  51     \qmlclass Accessible QQuickAccessibleAttached
  52     \brief Attached property to enable accessibility of QML items.
  53
  54     \inqmlmodule QtQuick 2
  55     \ingroup qml-basic-interaction-elements
  56     \ingroup accessibility
  57
  58     This class is part of \l {Accessibility for Qt Quick Applications}.
  59
  60     Items the user interacts with or that give information to the user
  61     need to expose their information in a semantic way.
  62     Then assistive tools can make use of that information to enable
  63     users to interact with the application in various ways.
  64
  65     This enables Qt Quick applications to be used with screen-readers for example.
  66
  67     The most important properties to set are \l name and \l role.
  68
  69     \sa Accessibility
  70 */
  71
  72 /*!
  73     \qmlproperty string QtQuick2::Accessible::name
  74
  75     This property sets an accessible name.
  76     For a button for example, this should have a binding to its text.
  77     In general this property should be set to a simple and concise
  78     but human readable name. Do not include the type of control
  79     you want to represent but just the name.
  80 */
  81
  82 /*!
  83     \qmlproperty string QtQuick2::Accessible::description
  84
  85     This property sets an accessible description.
  86     Similar to the name it describes the item. The description
  87     can be a little more verbose and tell what the item does,
  88     for example the functionallity of the button it describes.
  89 */
  90
  91 /*!
  92     \qmlproperty enumeration QtQuick2::Accessible::role
  93
  94     This flags sets the semantic type of the widget.
  95     A button for example would have "Button" as type.
  96     The value must be one of \l QAccessible::Role .
  97     Example:
  98     \qml
  99     Item {
 100         id: myButton
 101         Text {
 102             id: label
 103             // ...
 104         }
 105         Accessible.name: label.text
 106         Accessible.role: Accessible.Button
 107     }
 108     \endqml
 109
 110     Some roles have special semantics.
 111     In order to implement check boxes for example a "checked" property is expected.
 112
 113     \table
 114     \header
 115         \o \bold {Role}
 116         \o \bold {Expected property}
 117         \o
 118
 119     \row
 120        \o CheckBox
 121        \o checked
 122        \o The check state of the check box.
 123     \row
 124        \o RadioButton
 125        \o checked
 126        \o The selected state of the radio button.
 127     \row
 128        \o Button
 129        \o checkable
 130        \o Whether the button is checkable.
 131     \row
 132        \o Button
 133        \o checked
 134        \o Whether the button is checked (only if checkable is true).
 135
 136     \endtable
 137
 138 */
 139
 140 QQuickAccessibleAttached::QQuickAccessibleAttached(QObject *parent)
 141     : QObject(parent)
 142 {
 143     Q_ASSERT(parent);
 144     QQuickItem *item = qobject_cast<QQuickItem*>(parent);
 145     if (!item)
 146         return;
 147
 148     // Enable accessibility for items with accessible content. This also
 149     // enables accessibility for the ancestors of souch items.
 150     item->d_func()->setAccessibleFlagAndListener();
 151     QAccessible::updateAccessibility(item, 0, QAccessible::ObjectCreated);
 152 }
 153
 154 QQuickAccessibleAttached::~QQuickAccessibleAttached()
 155 {
 156 }
 157
 158 QQuickAccessibleAttached *QQuickAccessibleAttached::qmlAttachedProperties(QObject *obj)
 159 {
 160     return new QQuickAccessibleAttached(obj);
 161 }
 162
 163 QT_END_NAMESPACE
 164
 165 #endif