aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/accessible/shared/qdeclarativeaccessible.h
diff options
context:
space:
mode:
authorFrederik Gladhorn <[email protected]>2011-12-07 07:48:22 +0100
committerQt by Nokia <[email protected]>2012-01-02 15:33:52 +0100
commit27a497b3a7581a0cd76407635afca91d1f42aeef (patch)
treee4b65e5dcfc9a5be6053c24ec06d56fb82fe4c0d /src/plugins/accessible/shared/qdeclarativeaccessible.h
parent017a82c6702768aed68c34f319fa14da591f3df2 (diff)
Add accessibility to qml
This consists of two parts: An attached property for QML items and a plugin for the accessibility framework. The attached property simply takes care of some properties (name, role) that are needed in order to expose semantics of the application to assistive tools. The plugin exposes the hierarchy of QML items to the accessibility framework. Change-Id: I32f5603d0d9549b01b3645b205b710b9801762f7 Reviewed-by: Jan-Arve Sæther <[email protected]>
Diffstat (limited to 'src/plugins/accessible/shared/qdeclarativeaccessible.h')
-rw-r--r--src/plugins/accessible/shared/qdeclarativeaccessible.h98
1 files changed, 98 insertions, 0 deletions
diff --git a/src/plugins/accessible/shared/qdeclarativeaccessible.h b/src/plugins/accessible/shared/qdeclarativeaccessible.h
new file mode 100644
index 0000000000..16b61508c0
--- /dev/null
+++ b/src/plugins/accessible/shared/qdeclarativeaccessible.h
@@ -0,0 +1,98 @@
+/****************************************************************************
+**
+** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation ([email protected])
+**
+** This file is part of the QtDeclarative module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** GNU Lesser General Public License Usage
+** This file may be used under the terms of the GNU Lesser General Public
+** License version 2.1 as published by the Free Software Foundation and
+** appearing in the file LICENSE.LGPL included in the packaging of this
+** file. Please review the following information to ensure the GNU Lesser
+** General Public License version 2.1 requirements will be met:
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights. These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU General
+** Public License version 3.0 as published by the Free Software Foundation
+** and appearing in the file LICENSE.GPL included in the packaging of this
+** file. Please review the following information to ensure the GNU General
+** Public License version 3.0 requirements will be met:
+** http://www.gnu.org/copyleft/gpl.html.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms and
+** conditions contained in a signed written agreement between you and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QDECLARATIVEACCESSIBLE_H
+#define QDECLARATIVEACCESSIBLE_H
+
+#include <QtGui/qaccessibleobject.h>
+#include <QtGui/qaccessible2.h>
+//#include <QtQuick1/qdeclarativeview.h>
+//#include <QtQuick1/qdeclarativeitem.h>
+#include <QtDeclarative/qdeclarativeproperty.h>
+
+//#include <private/qdeclarativeaccessible_p.h>
+
+QT_BEGIN_NAMESPACE
+
+#ifndef QT_NO_ACCESSIBILITY
+
+/*
+ -- Declarative Accessibility Overview. --
+
+ * Item interface classes:
+ QAccessibleDeclarativeItem for QtQuick1
+ QAccessibleQuickItem for for QtQuick2
+ Common base class: QDeclarativeAccessible
+
+ * View interface classes.
+
+ These are the root of the QML accessible tree and connects it to the widget hierarchy.
+
+ QAccessbileDeclarativeView is the root for the QGraphicsView implementation
+ QAccessbileQuickView is the root for the SceneGraph implementation
+
+*/
+class QDeclarativeAccessible: public QAccessibleObject, public QAccessibleActionInterface
+{
+public:
+ ~QDeclarativeAccessible();
+
+ virtual QRect viewRect() const = 0;
+ QFlags<QAccessible::RelationFlag> relationTo(const QAccessibleInterface*) const;
+ QAccessibleInterface *childAt(int, int) const;
+ QFlags<QAccessible::StateFlag> state() const;
+ QVariant invokeMethod(QAccessible::Method, const QVariantList &);
+
+ QStringList actionNames() const;
+ void doAction(const QString &actionName);
+ QStringList keyBindingsForAction(const QString &actionName) const;
+
+protected:
+ virtual bool clipsChildren() const = 0;
+ // For subclasses, use instantiateObject factory method outside the class.
+ QDeclarativeAccessible(QObject *object);
+};
+
+#endif // QT_NO_ACCESSIBILITY
+
+QT_END_NAMESPACE
+
+#endif // QDECLARATIVEACCESSIBLE_H