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 QtDeclarative 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 #ifndef QQUICKACCESSIBLEATTACHED_H
43 #define QQUICKACCESSIBLEATTACHED_H
45 #include <QtQuick/qquickitem.h>
47 #include <QtCore/qobject.h>
48 #include <QtCore/qstring.h>
50 #ifndef QT_NO_ACCESSIBILITY
52 #include <QtGui/qaccessible.h>
53 #include <private/qtquickglobal_p.h>
60 class Q_QUICK_PRIVATE_EXPORT QQuickAccessibleAttached : public QObject
63 Q_PROPERTY(QAccessible::Role role READ role WRITE setRole NOTIFY roleChanged)
64 Q_PROPERTY(QString name READ name WRITE setName NOTIFY nameChanged)
65 Q_PROPERTY(QString description READ description WRITE setDescription NOTIFY descriptionChanged)
68 Q_ENUMS(QAccessible::Role QAccessible::Event QAccessible::State)
70 QQuickAccessibleAttached(QObject *parent);
71 ~QQuickAccessibleAttached();
73 QAccessible::Role role() const { return m_role; }
74 void setRole(QAccessible::Role role)
79 // There is no way to signify role changes at the moment.
80 // QAccessible::updateAccessibility(parent(), 0, QAccessible::);
83 QString name() const { return m_name; }
84 void setName(const QString &name) {
88 QAccessible::updateAccessibility(parent(), 0, QAccessible::NameChanged);
92 QString description() const { return m_description; }
93 void setDescription(const QString &description)
95 if (m_description != description) {
96 m_description = description;
97 emit descriptionChanged();
98 QAccessible::updateAccessibility(parent(), 0, QAccessible::DescriptionChanged);
103 static QQuickAccessibleAttached *qmlAttachedProperties(QObject *obj);
106 static QObject *attachedProperties(const QObject *obj)
108 return qmlAttachedPropertiesObject<QQuickAccessibleAttached>(obj, false);
111 static QVariant property(const QObject *object, const char *propertyName)
113 if (QObject *attachedObject = QQuickAccessibleAttached::attachedProperties(object))
114 return attachedObject->property(propertyName);
118 static bool setProperty(QObject *object, const char *propertyName, const QVariant &value)
120 QObject *obj = qmlAttachedPropertiesObject<QQuickAccessibleAttached>(object, true);
122 qWarning("cannot set property Accessible.%s of QObject %s", propertyName, object->metaObject()->className());
125 return obj->setProperty(propertyName, value);
132 void descriptionChanged();
134 QAccessible::Role m_role;
136 QString m_description;
139 using QObject::property;
145 QML_DECLARE_TYPE(QQuickAccessibleAttached)
146 QML_DECLARE_TYPEINFO(QQuickAccessibleAttached, QML_HAS_ATTACHED_PROPERTIES)
150 #endif // QT_NO_ACCESSIBILITY