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 QACCESSIBLEWIDGET_H
43#define QACCESSIBLEWIDGET_H
44
45#include <QtGui/qaccessibleobject.h>
46
47QT_BEGIN_HEADER
48
49QT_BEGIN_NAMESPACE
50
51QT_MODULE(Gui)
52
53#ifndef QT_NO_ACCESSIBILITY
54
55class QAccessibleWidgetPrivate;
56
57class Q_GUI_EXPORT QAccessibleWidget : public QAccessibleObject
58{
59public:
60 explicit QAccessibleWidget(QWidget *o, Role r = Client, const QString& name = QString());
61
62 int childCount() const;
63 int indexOfChild(const QAccessibleInterface *child) const;
64 Relation relationTo(int child, const QAccessibleInterface *other, int otherChild) const;
65
66 int childAt(int x, int y) const;
67 QRect rect(int child) const;
68 int navigate(RelationFlag rel, int entry, QAccessibleInterface **target) const;
69
70 QString text(Text t, int child) const;
71 Role role(int child) const;
72 State state(int child) const;
73
74#ifndef QT_NO_ACTION
75 int userActionCount(int child) const;
76 QString actionText(int action, Text t, int child) const;
77 bool doAction(int action, int child, const QVariantList &params);
78#endif
79
80protected:
81 ~QAccessibleWidget();
82 QWidget *widget() const;
83 QObject *parentObject() const;
84
85 void addControllingSignal(const QString &signal);
86 void setValue(const QString &value);
87 void setDescription(const QString &desc);
88 void setHelp(const QString &help);
89 void setAccelerator(const QString &accel);
90
91private:
92 friend class QAccessibleWidgetEx;
93 QAccessibleWidgetPrivate *d;
94 Q_DISABLE_COPY(QAccessibleWidget)
95};
96
97class Q_GUI_EXPORT QAccessibleWidgetEx : public QAccessibleObjectEx
98{
99public:
100 explicit QAccessibleWidgetEx(QWidget *o, Role r = Client, const QString& name = QString());
101
102 int childCount() const;
103 int indexOfChild(const QAccessibleInterface *child) const;
104 Relation relationTo(int child, const QAccessibleInterface *other, int otherChild) const;
105
106 int childAt(int x, int y) const;
107 QRect rect(int child) const;
108 int navigate(RelationFlag rel, int entry, QAccessibleInterface **target) const;
109
110 QString text(Text t, int child) const;
111 Role role(int child) const;
112 State state(int child) const;
113
114 QString actionText(int action, Text t, int child) const;
115 bool doAction(int action, int child, const QVariantList &params);
116
117 QVariant invokeMethodEx(Method method, int child, const QVariantList &params);
118
119protected:
120 ~QAccessibleWidgetEx();
121 QWidget *widget() const;
122 QObject *parentObject() const;
123
124 void addControllingSignal(const QString &signal);
125 void setValue(const QString &value);
126 void setDescription(const QString &desc);
127 void setHelp(const QString &help);
128 void setAccelerator(const QString &accel);
129
130private:
131 QAccessibleWidgetPrivate *d;
132 Q_DISABLE_COPY(QAccessibleWidgetEx)
133};
134
135#endif // QT_NO_ACCESSIBILITY
136
137QT_END_NAMESPACE
138
139QT_END_HEADER
140
141#endif // QACCESSIBLEWIDGET_H
142