src/plugins/accessible/shared/qdeclarativeaccessible.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 QDECLARATIVEACCESSIBLE_H
  43 #define QDECLARATIVEACCESSIBLE_H
  44
  45 #include <QtGui/qaccessibleobject.h>
  46 #include <QtGui/qaccessible2.h>
  47 //#include <QtQuick1/qdeclarativeview.h>
  48 //#include <QtQuick1/qdeclarativeitem.h>
  49 #include <QtDeclarative/qdeclarativeproperty.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: QDeclarativeAccessible
  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 QDeclarativeAccessible: public QAccessibleObject, public QAccessibleActionInterface
  74 {
  75 public:
  76     ~QDeclarativeAccessible();
  77
  78     virtual QRect viewRect() const = 0;
  79     QFlags<QAccessible::RelationFlag> relationTo(const QAccessibleInterface*) const;
  80     QAccessibleInterface *childAt(int, int) const;
  81     QAccessible::State state() const;
  82     QVariant invokeMethod(QAccessible::Method, const QVariantList &);
  83
  84     QStringList actionNames() const;
  85     void doAction(const QString &actionName);
  86     QStringList keyBindingsForAction(const QString &actionName) const;
  87
  88 protected:
  89     virtual bool clipsChildren() const = 0;
  90     // For subclasses, use instantiateObject factory method outside the class.
  91     QDeclarativeAccessible(QObject *object);
  92 };
  93
  94 #endif // QT_NO_ACCESSIBILITY
  95
  96 QT_END_NAMESPACE
  97
  98 #endif // QDECLARATIVEACCESSIBLE_H