src/plugins/accessible/shared/qqmlaccessible.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the QtQml module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/contact-us.
  16 **
  17 ** GNU Lesser General Public License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QQMLACCESSIBLE_H
  43 #define QQMLACCESSIBLE_H
  44
  45 #include <QtGui/qaccessibleobject.h>
  46 #include <QtGui/qaccessible2.h>
  47 //#include <QtQuick1/qdeclarativeview.h>
  48 //#include <QtQuick1/qdeclarativeitem.h>
  49 #include <QtQml/qqmlproperty.h>
  50
  51 //#include <private/qdeclarativeaccessible_p.h>
  52
  53 QT_BEGIN_NAMESPACE
  54
  55 #ifndef QT_NO_ACCESSIBILITY
  56
  57 /*
  58     -- Declarative Accessibility Overview. --
  59
  60     * Item interface classes:
  61     QAccessibleDeclarativeItem for QtQuick1
  62     QAccessibleQuickItem for for QtQuick2
  63     Common base class: QQmlAccessible
  64
  65     * View interface classes.
  66
  67     These are the root of the QML accessible tree and connects it to the widget hierarchy.
  68
  69     QAccessbileDeclarativeView is the root for the QGraphicsView implementation
  70     QAccessbileQuickView is the root for the SceneGraph implementation
  71
  72 */
  73 class QQmlAccessible: public QAccessibleObject, public QAccessibleActionInterface
  74 {
  75 public:
  76     ~QQmlAccessible();
  77     void *interface_cast(QAccessible::InterfaceType t);
  78
  79     virtual QRect viewRect() const = 0;
  80     QAccessibleInterface *childAt(int, int) const;
  81     QAccessible::State state() const;
  82
  83     QStringList actionNames() const;
  84     void doAction(const QString &actionName);
  85     QStringList keyBindingsForAction(const QString &actionName) const;
  86
  87 protected:
  88     virtual bool clipsChildren() const = 0;
  89     // For subclasses, use instantiateObject factory method outside the class.
  90     QQmlAccessible(QObject *object);
  91 };
  92
  93 #endif // QT_NO_ACCESSIBILITY
  94
  95 QT_END_NAMESPACE
  96
  97 #endif // QQMLACCESSIBLE_H