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: Nokia Corporation (qt-info@nokia.com)
   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 QT_MODULE(Declarative)
  60
  61 class Q_QUICK_PRIVATE_EXPORT QQuickAccessibleAttached : public QObject
  62 {
  63     Q_OBJECT
  64     Q_PROPERTY(QAccessible::Role role READ role WRITE setRole NOTIFY roleChanged)
  65     Q_PROPERTY(QString name READ name WRITE setName NOTIFY nameChanged)
  66     Q_PROPERTY(QString description READ description WRITE setDescription NOTIFY descriptionChanged)
  67
  68 public:
  69     Q_ENUMS(QAccessible::Role QAccessible::Event QAccessible::State)
  70
  71     QQuickAccessibleAttached(QObject *parent);
  72     ~QQuickAccessibleAttached();
  73
  74     QAccessible::Role role() const { return m_role; }
  75     void setRole(QAccessible::Role role)
  76     {
  77         if (role != m_role) {
  78             m_role = role;
  79             emit roleChanged();
  80             // There is no way to signify role changes at the moment.
  81             // QAccessible::updateAccessibility(parent(), 0, QAccessible::);
  82         }
  83     }
  84     QString name() const { return m_name; }
  85     void setName(const QString &name) {
  86         if (name != m_name) {
  87             m_name = name;
  88             emit nameChanged();
  89             QAccessible::updateAccessibility(parent(), 0, QAccessible::NameChanged);
  90         }
  91     }
  92
  93     QString description() const { return m_description; }
  94     void setDescription(const QString &description)
  95     {
  96         if (m_description != description) {
  97             m_description = description;
  98             emit descriptionChanged();
  99             QAccessible::updateAccessibility(parent(), 0, QAccessible::DescriptionChanged);
 100         }
 101     }
 102
 103     // Factory function
 104     static QQuickAccessibleAttached *qmlAttachedProperties(QObject *obj);
 105
 106     // Property getter
 107     static QObject *attachedProperties(const QObject *obj)
 108     {
 109         return qmlAttachedPropertiesObject<QQuickAccessibleAttached>(obj, false);
 110     }
 111
 112     static QVariant property(const QObject *object, const char *propertyName)
 113     {
 114         if (QObject *attachedObject = QQuickAccessibleAttached::attachedProperties(object))
 115             return attachedObject->property(propertyName);
 116         return QVariant();
 117     }
 118
 119     static bool setProperty(QObject *object, const char *propertyName, const QVariant &value)
 120     {
 121         QObject *obj = qmlAttachedPropertiesObject<QQuickAccessibleAttached>(object, true);
 122         if (!obj) {
 123             qWarning("cannot set property Accessible.%s of QObject %s", propertyName, object->metaObject()->className());
 124             return false;
 125         }
 126         return obj->setProperty(propertyName, value);
 127     }
 128
 129
 130 Q_SIGNALS:
 131     void roleChanged();
 132     void nameChanged();
 133     void descriptionChanged();
 134 private:
 135     QAccessible::Role m_role;
 136     QString m_name;
 137     QString m_description;
 138
 139 public:
 140     using QObject::property;
 141 };
 142
 143
 144 QT_END_NAMESPACE
 145
 146 QML_DECLARE_TYPE(QQuickAccessibleAttached)
 147 QML_DECLARE_TYPEINFO(QQuickAccessibleAttached, QML_HAS_ATTACHED_PROPERTIES)
 148
 149 QT_END_HEADER
 150
 151 #endif // QT_NO_ACCESSIBILITY
 152
 153 #endif