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