1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
6 ** This file is part of the QtQml module of the Qt Toolkit.
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** GNU Lesser General Public License Usage
10 ** This file may be used under the terms of the GNU Lesser General Public
11 ** License version 2.1 as published by the Free Software Foundation and
12 ** appearing in the file LICENSE.LGPL included in the packaging of this
13 ** file. Please review the following information to ensure the GNU Lesser
14 ** General Public License version 2.1 requirements will be met:
15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
17 ** In addition, as a special exception, Nokia gives you certain additional
18 ** rights. These rights are described in the Nokia Qt LGPL Exception
19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
21 ** GNU General Public License Usage
22 ** Alternatively, this file may be used under the terms of the GNU General
23 ** Public License version 3.0 as published by the Free Software Foundation
24 ** and appearing in the file LICENSE.GPL included in the packaging of this
25 ** file. Please review the following information to ensure the GNU General
26 ** Public License version 3.0 requirements will be met:
27 ** http://www.gnu.org/copyleft/gpl.html.
30 ** Alternatively, this file may be used in accordance with the terms and
31 ** conditions contained in a signed written agreement between you and Nokia.
40 ****************************************************************************/
42 #include "qquickaccessibleattached_p.h"
44 #ifndef QT_NO_ACCESSIBILITY
46 #include "private/qquickitem_p.h"
51 \qmlclass Accessible QQuickAccessibleAttached
52 \brief Attached property to enable accessibility of QML items.
54 \inqmlmodule QtQuick 2
55 \ingroup qml-basic-interaction-elements
56 \ingroup accessibility
58 This class is part of \l {Accessibility for Qt Quick Applications}.
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.
65 This enables Qt Quick applications to be used with screen-readers for example.
67 The most important properties to set are \l name and \l role.
73 \qmlproperty string QtQuick2::Accessible::name
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.
83 \qmlproperty string QtQuick2::Accessible::description
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.
92 \qmlproperty enumeration QtQuick2::Accessible::role
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 .
105 Accessible.name: label.text
106 Accessible.role: Accessible.Button
107 funtion accessiblePressAction { ... }
111 Some roles have special semantics.
112 In order to implement check boxes for example a "checked" property is expected.
117 \o \bold {Expected property}
122 \o function accessiblePressAction
123 \o Called when the button receives a press action. The implementation should visually simulate a button click and perform the button action.
125 \o CheckBox, Radiobutton
127 \o The check state of the check box. Updated on Press, Check and Uncheck actions.
129 \o Slider, SpinBox, Dial, ScrollBar
130 \o value, minimumValue, maximumValue, stepSize
131 \o value will be updated on increase and decrase actions, in accordance with the other properties
136 QQuickAccessibleAttached::QQuickAccessibleAttached(QObject *parent)
137 : QObject(parent), m_role(QAccessible::NoRole)
140 QQuickItem *item = qobject_cast<QQuickItem*>(parent);
144 // Enable accessibility for items with accessible content. This also
145 // enables accessibility for the ancestors of souch items.
146 item->d_func()->setAccessibleFlagAndListener();
147 QAccessible::updateAccessibility(QAccessibleEvent(QAccessible::ObjectCreated, item));
150 QQuickAccessibleAttached::~QQuickAccessibleAttached()
154 QQuickAccessibleAttached *QQuickAccessibleAttached::qmlAttachedProperties(QObject *obj)
156 return new QQuickAccessibleAttached(obj);