src/quick/items/qquickaccessibleattached_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtQml module of the Qt Toolkit.
   7 **
   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.
  16 **
  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.
  20 **
  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.
  28 **
  29 ** Other Usage
  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.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QQUICKACCESSIBLEATTACHED_H
  43 #define QQUICKACCESSIBLEATTACHED_H
  44
  45 #include <QtQuick/qquickitem.h>
  46
  47 #include <QtCore/qobject.h>
  48 #include <QtCore/qstring.h>
  49
  50 #ifndef QT_NO_ACCESSIBILITY
  51
  52 #include <QtGui/qaccessible.h>
  53 #include <private/qtquickglobal_p.h>
  54
  55 QT_BEGIN_HEADER
  56
  57 QT_BEGIN_NAMESPACE
  58
  59
  60 class Q_QUICK_PRIVATE_EXPORT QQuickAccessibleAttached : public QObject
  61 {
  62     Q_OBJECT
  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)
  66
  67 public:
  68     Q_ENUMS(QAccessible::Role QAccessible::Event QAccessible::State)
  69
  70     QQuickAccessibleAttached(QObject *parent);
  71     ~QQuickAccessibleAttached();
  72
  73     QAccessible::Role role() const { return m_role; }
  74     void setRole(QAccessible::Role role)
  75     {
  76         if (role != m_role) {
  77             m_role = role;
  78             emit roleChanged();
  79             // There is no way to signify role changes at the moment.
  80             // QAccessible::updateAccessibility(parent(), 0, QAccessible::);
  81         }
  82     }
  83     QString name() const { return m_name; }
  84     void setName(const QString &name) {
  85         if (name != m_name) {
  86             m_name = name;
  87             emit nameChanged();
  88 #ifndef QT_NO_ACCESSIBILITY
  89             QAccessibleEvent ev(parent(), QAccessible::NameChanged);
  90             QAccessible::updateAccessibility(&ev);
  91 #endif
  92         }
  93     }
  94
  95     QString description() const { return m_description; }
  96     void setDescription(const QString &description)
  97     {
  98         if (m_description != description) {
  99             m_description = description;
 100             emit descriptionChanged();
 101 #ifndef QT_NO_ACCESSIBILITY
 102             QAccessibleEvent ev(parent(), QAccessible::DescriptionChanged);
 103             QAccessible::updateAccessibility(&ev);
 104 #endif
 105         }
 106     }
 107
 108     // Factory function
 109     static QQuickAccessibleAttached *qmlAttachedProperties(QObject *obj);
 110
 111     // Property getter
 112     static QObject *attachedProperties(const QObject *obj)
 113     {
 114         return qmlAttachedPropertiesObject<QQuickAccessibleAttached>(obj, false);
 115     }
 116
 117     static QVariant property(const QObject *object, const char *propertyName)
 118     {
 119         if (QObject *attachedObject = QQuickAccessibleAttached::attachedProperties(object))
 120             return attachedObject->property(propertyName);
 121         return QVariant();
 122     }
 123
 124     static bool setProperty(QObject *object, const char *propertyName, const QVariant &value)
 125     {
 126         QObject *obj = qmlAttachedPropertiesObject<QQuickAccessibleAttached>(object, true);
 127         if (!obj) {
 128             qWarning("cannot set property Accessible.%s of QObject %s", propertyName, object->metaObject()->className());
 129             return false;
 130         }
 131         return obj->setProperty(propertyName, value);
 132     }
 133
 134
 135 Q_SIGNALS:
 136     void roleChanged();
 137     void nameChanged();
 138     void descriptionChanged();
 139 private:
 140     QAccessible::Role m_role;
 141     QString m_name;
 142     QString m_description;
 143
 144 public:
 145     using QObject::property;
 146 };
 147
 148
 149 QT_END_NAMESPACE
 150
 151 QML_DECLARE_TYPE(QQuickAccessibleAttached)
 152 QML_DECLARE_TYPEINFO(QQuickAccessibleAttached, QML_HAS_ATTACHED_PROPERTIES)
 153
 154 QT_END_HEADER
 155
 156 #endif // QT_NO_ACCESSIBILITY
 157
 158 #endif