1/****************************************************************************
2**
3** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4** Contact: http://www.qt-project.org/legal
5**
6** This file is part of the QtGui 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 QACCESSIBLEOBJECT_H
43#define QACCESSIBLEOBJECT_H
44
45#include <QtGui/qaccessible.h>
46
47QT_BEGIN_HEADER
48
49QT_BEGIN_NAMESPACE
50
51QT_MODULE(Gui)
52
53#ifndef QT_NO_ACCESSIBILITY
54
55class QAccessibleObjectPrivate;
56class QObject;
57
58class Q_GUI_EXPORT QAccessibleObject : public QAccessibleInterface
59{
60public:
61 explicit QAccessibleObject(QObject *object);
62
63 bool isValid() const;
64 QObject *object() const;
65
66 // properties
67 QRect rect(int child) const;
68 void setText(Text t, int child, const QString &text);
69
70 // actions
71 int userActionCount(int child) const;
72 bool doAction(int action, int child, const QVariantList &params);
73 QString actionText(int action, Text t, int child) const;
74
75protected:
76 virtual ~QAccessibleObject();
77
78private:
79 friend class QAccessibleObjectEx;
80 QAccessibleObjectPrivate *d;
81 Q_DISABLE_COPY(QAccessibleObject)
82};
83
84class Q_GUI_EXPORT QAccessibleObjectEx : public QAccessibleInterfaceEx
85{
86public:
87 explicit QAccessibleObjectEx(QObject *object);
88
89 bool isValid() const;
90 QObject *object() const;
91
92 // properties
93 QRect rect(int child) const;
94 void setText(Text t, int child, const QString &text);
95
96 // actions
97 int userActionCount(int child) const;
98 bool doAction(int action, int child, const QVariantList &params);
99 QString actionText(int action, Text t, int child) const;
100
101protected:
102 virtual ~QAccessibleObjectEx();
103
104private:
105 QAccessibleObjectPrivate *d;
106 Q_DISABLE_COPY(QAccessibleObjectEx)
107};
108
109class Q_GUI_EXPORT QAccessibleApplication : public QAccessibleObject
110{
111public:
112 QAccessibleApplication();
113
114 // relations
115 int childCount() const;
116 int indexOfChild(const QAccessibleInterface*) const;
117 Relation relationTo(int, const QAccessibleInterface *, int) const;
118
119 // navigation
120 int childAt(int x, int y) const;
121 int navigate(RelationFlag, int, QAccessibleInterface **) const;
122
123 // properties and state
124 QString text(Text t, int child) const;
125 Role role(int child) const;
126 State state(int child) const;
127
128 // actions
129 int userActionCount(int child) const;
130 bool doAction(int action, int child, const QVariantList &params);
131 QString actionText(int action, Text t, int child) const;
132};
133
134#endif // QT_NO_ACCESSIBILITY
135
136QT_END_NAMESPACE
137
138QT_END_HEADER
139
140#endif // QACCESSIBLEOBJECT_H
141