src/qtquick1/graphicsitems/qdeclarativeaccessibleattached_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 QQUICK1ACCESSIBLEATTACHED_H
  43 #define QQUICK1ACCESSIBLEATTACHED_H
  44
  45 #include <qdeclarativeitem.h>
  46
  47 #include <QtCore/qobject.h>
  48 #include <QtCore/qstring.h>
  49
  50 #ifndef QT_NO_ACCESSIBILITY
  51
  52 #include <private/qdeclarativeglobal_p.h>
  53 #include <QtGui/qaccessible.h>
  54
  55 QT_BEGIN_HEADER
  56
  57 QT_BEGIN_NAMESPACE
  58
  59
  60 class Q_QTQUICK1_EXPORT QDeclarativeAccessibleAttached : 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     QDeclarativeAccessibleAttached(QObject *parent);
  71     ~QDeclarativeAccessibleAttached();
  72
  73     QAccessible::Role role() const { return m_role; }
  74     void setRole(QAccessible::Role role)
  75     {
  76         m_role = role;
  77         emit roleChanged();
  78         // There is no way to signify role changes at the moment.
  79         // QAccessible::updateAccessibility(parent(), 0, QAccessible::);
  80     }
  81     QString name() const { return m_name; }
  82     void setName(const QString &name)
  83     {
  84         m_name = name;
  85         emit nameChanged();
  86         QAccessible::updateAccessibility(parent(), 0, QAccessible::NameChanged);
  87     }
  88
  89     QString description() const { return m_description; }
  90     void setDescription(const QString &description)
  91     {
  92         m_description = description;
  93         emit descriptionChanged();
  94         QAccessible::updateAccessibility(parent(), 0, QAccessible::DescriptionChanged);
  95     }
  96
  97     // Factory function
  98     static QDeclarativeAccessibleAttached *qmlAttachedProperties(QObject *);
  99
 100     // Property getter
 101     static QObject *attachedProperties(const QObject *obj)
 102     {
 103         return qmlAttachedPropertiesObject<QDeclarativeAccessibleAttached>(obj, false);
 104     }
 105
 106     static QVariant property(const QObject *object, const char *propertyName)
 107     {
 108         if (QObject *attachedObject = QDeclarativeAccessibleAttached::attachedProperties(object))
 109             return attachedObject->property(propertyName);
 110         return QVariant();
 111     }
 112
 113     static bool setProperty(QObject *object, const char *propertyName, const QVariant &value)
 114     {
 115         QObject *obj = qmlAttachedPropertiesObject<QDeclarativeAccessibleAttached>(object, true);
 116         if (!obj) {
 117             qWarning("cannot set property Accessible.%s of QObject %s", propertyName, object->metaObject()->className());
 118             return false;
 119         }
 120         return obj->setProperty(propertyName, value);
 121     }
 122
 123
 124 Q_SIGNALS:
 125     void roleChanged();
 126     void nameChanged();
 127     void descriptionChanged();
 128 private:
 129     QAccessible::Role m_role;
 130     QString m_name;
 131     QString m_description;
 132 public:
 133     using QObject::property;
 134 };
 135
 136
 137 QT_END_NAMESPACE
 138
 139 QML_DECLARE_TYPE(QDeclarativeAccessibleAttached)
 140 QML_DECLARE_TYPEINFO(QDeclarativeAccessibleAttached, QML_HAS_ATTACHED_PROPERTIES)
 141
 142 QT_END_HEADER
 143
 144 #endif // QT_NO_ACCESSIBILITY
 145
 146 #endif
 147