src/quick/items/qquickaccessibleattached_p.h

   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 #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             QAccessible::updateAccessibility(parent(), 0, QAccessible::NameChanged);
  89         }
  90     }
  91
  92     QString description() const { return m_description; }
  93     void setDescription(const QString &description)
  94     {
  95         if (m_description != description) {
  96             m_description = description;
  97             emit descriptionChanged();
  98             QAccessible::updateAccessibility(parent(), 0, QAccessible::DescriptionChanged);
  99         }
 100     }
 101
 102     // Factory function
 103     static QQuickAccessibleAttached *qmlAttachedProperties(QObject *obj);
 104
 105     // Property getter
 106     static QObject *attachedProperties(const QObject *obj)
 107     {
 108         return qmlAttachedPropertiesObject<QQuickAccessibleAttached>(obj, false);
 109     }
 110
 111     static QVariant property(const QObject *object, const char *propertyName)
 112     {
 113         if (QObject *attachedObject = QQuickAccessibleAttached::attachedProperties(object))
 114             return attachedObject->property(propertyName);
 115         return QVariant();
 116     }
 117
 118     static bool setProperty(QObject *object, const char *propertyName, const QVariant &value)
 119     {
 120         QObject *obj = qmlAttachedPropertiesObject<QQuickAccessibleAttached>(object, true);
 121         if (!obj) {
 122             qWarning("cannot set property Accessible.%s of QObject %s", propertyName, object->metaObject()->className());
 123             return false;
 124         }
 125         return obj->setProperty(propertyName, value);
 126     }
 127
 128
 129 Q_SIGNALS:
 130     void roleChanged();
 131     void nameChanged();
 132     void descriptionChanged();
 133 private:
 134     QAccessible::Role m_role;
 135     QString m_name;
 136     QString m_description;
 137
 138 public:
 139     using QObject::property;
 140 };
 141
 142
 143 QT_END_NAMESPACE
 144
 145 QML_DECLARE_TYPE(QQuickAccessibleAttached)
 146 QML_DECLARE_TYPEINFO(QQuickAccessibleAttached, QML_HAS_ATTACHED_PROPERTIES)
 147
 148 QT_END_HEADER
 149
 150 #endif // QT_NO_ACCESSIBILITY
 151
 152 #endif