Remove QWorkspace.
[qt:rb-qtbase.git] / src / plugins / accessible / widgets / qaccessiblewidgets.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
5 **
6 ** This file is part of the plugins of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** GNU Lesser General Public License Usage
10 ** This file may be used under the terms of the GNU Lesser General Public
11 ** License version 2.1 as published by the Free Software Foundation and
12 ** appearing in the file LICENSE.LGPL included in the packaging of this
13 ** file. Please review the following information to ensure the GNU Lesser
14 ** General Public License version 2.1 requirements will be met:
15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
16 **
17 ** In addition, as a special exception, Nokia gives you certain additional
18 ** rights. These rights are described in the Nokia Qt LGPL Exception
19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
20 **
21 ** GNU General Public License Usage
22 ** Alternatively, this file may be used under the terms of the GNU General
23 ** Public License version 3.0 as published by the Free Software Foundation
24 ** and appearing in the file LICENSE.GPL included in the packaging of this
25 ** file. Please review the following information to ensure the GNU General
26 ** Public License version 3.0 requirements will be met:
27 ** http://www.gnu.org/copyleft/gpl.html.
28 **
29 ** Other Usage
30 ** Alternatively, this file may be used in accordance with the terms and
31 ** conditions contained in a signed written agreement between you and Nokia.
32 **
33 **
34 **
35 **
36 **
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41
42 #ifndef QACCESSIBLEWIDGETS_H
43 #define QACCESSIBLEWIDGETS_H
44
45 #include <QtGui/qaccessible2.h>
46 #include <QtWidgets/qaccessiblewidget.h>
47
48 #ifndef QT_NO_ACCESSIBILITY
49
50 #include <QtCore/QPointer>
51
52 QT_BEGIN_NAMESPACE
53
54 class QTextEdit;
55 class QStackedWidget;
56 class QToolBox;
57 class QMdiArea;
58 class QMdiSubWindow;
59 class QRubberBand;
60 class QTextBrowser;
61 class QCalendarWidget;
62 class QAbstractItemView;
63 class QDockWidget;
64 class QDockWidgetLayout;
65 class QMainWindow;
66
67 #ifndef QT_NO_TEXTEDIT
68 class QAccessibleTextEdit : public QAccessibleWidget, public QAccessibleTextInterface,
69                             public QAccessibleEditableTextInterface
70 {
71 public:
72     explicit QAccessibleTextEdit(QWidget *o);
73
74     QString text(QAccessible::Text t) const;
75     void setText(QAccessible::Text t, const QString &text);
76
77     void *interface_cast(QAccessible::InterfaceType t);
78
79     // QAccessibleTextInterface
80     void addSelection(int startOffset, int endOffset);
81     QString attributes(int offset, int *startOffset, int *endOffset) const;
82     int cursorPosition() const;
83     QRect characterRect(int offset, QAccessible2::CoordinateType coordType) const;
84     int selectionCount() const;
85     int offsetAtPoint(const QPoint &point, QAccessible2::CoordinateType coordType) const;
86     void selection(int selectionIndex, int *startOffset, int *endOffset) const;
87     QString text(int startOffset, int endOffset) const;
88     QString textBeforeOffset (int offset, QAccessible2::BoundaryType boundaryType,
89             int *startOffset, int *endOffset) const;
90     QString textAfterOffset(int offset, QAccessible2::BoundaryType boundaryType,
91             int *startOffset, int *endOffset) const;
92     QString textAtOffset(int offset, QAccessible2::BoundaryType boundaryType,
93             int *startOffset, int *endOffset) const;
94     void removeSelection(int selectionIndex);
95     void setCursorPosition(int position);
96     void setSelection(int selectionIndex, int startOffset, int endOffset);
97     int characterCount() const;
98     void scrollToSubstring(int startIndex, int endIndex);
99
100     // QAccessibleEditableTextInterface
101     void copyText(int startOffset, int endOffset) const;
102     void deleteText(int startOffset, int endOffset);
103     void insertText(int offset, const QString &text);
104     void cutText(int startOffset, int endOffset);
105     void pasteText(int offset);
106     void replaceText(int startOffset, int endOffset, const QString &text);
107     void setAttributes(int startOffset, int endOffset, const QString &attributes);
108
109 protected:
110     QTextEdit *textEdit() const;
111
112 private:
113     int childOffset;
114 };
115 #endif // QT_NO_TEXTEDIT
116
117 class QAccessibleStackedWidget : public QAccessibleWidget
118 {
119 public:
120     explicit QAccessibleStackedWidget(QWidget *widget);
121
122     QAccessibleInterface *childAt(int x, int y) const;
123     int childCount() const;
124     int indexOfChild(const QAccessibleInterface *child) const;
125     QAccessibleInterface *child(int index) const;
126
127 protected:
128     QStackedWidget *stackedWidget() const;
129 };
130
131 class QAccessibleToolBox : public QAccessibleWidget
132 {
133 public:
134     explicit QAccessibleToolBox(QWidget *widget);
135
136 // FIXME we currently expose the toolbox but it is not keyboard navigatable
137 // and the accessible hierarchy is not exactly beautiful.
138 //    int childCount() const;
139 //    QAccessibleInterface *child(int index) const;
140 //    int indexOfChild(const QAccessibleInterface *child) const;
141
142 protected:
143     QToolBox *toolBox() const;
144 };
145
146 #ifndef QT_NO_MDIAREA
147 class QAccessibleMdiArea : public QAccessibleWidget
148 {
149 public:
150     explicit QAccessibleMdiArea(QWidget *widget);
151
152     int childCount() const;
153     QAccessibleInterface *child(int index) const;
154     int indexOfChild(const QAccessibleInterface *child) const;
155
156 protected:
157     QMdiArea *mdiArea() const;
158 };
159
160 class QAccessibleMdiSubWindow : public QAccessibleWidget
161 {
162 public:
163     explicit QAccessibleMdiSubWindow(QWidget *widget);
164
165     QString text(QAccessible::Text textType) const;
166     void setText(QAccessible::Text textType, const QString &text);
167     QAccessible::State state() const;
168     int childCount() const;
169     QAccessibleInterface *child(int index) const;
170     int indexOfChild(const QAccessibleInterface *child) const;
171     QRect rect() const;
172
173 protected:
174     QMdiSubWindow *mdiSubWindow() const;
175 };
176 #endif // QT_NO_MDIAREA
177
178 class QAccessibleDialogButtonBox : public QAccessibleWidget
179 {
180 public:
181     explicit QAccessibleDialogButtonBox(QWidget *widget);
182 };
183
184 #ifndef QT_NO_TEXTBROWSER
185 class QAccessibleTextBrowser : public QAccessibleTextEdit
186 {
187 public:
188     explicit QAccessibleTextBrowser(QWidget *widget);
189
190     QAccessible::Role role() const;
191 };
192 #endif // QT_NO_TEXTBROWSER
193
194 #ifndef QT_NO_CALENDARWIDGET
195 class QAccessibleCalendarWidget : public QAccessibleWidget
196 {
197 public:
198     explicit QAccessibleCalendarWidget(QWidget *widget);
199
200     int childCount() const;
201     int indexOfChild(const QAccessibleInterface *child) const;
202
203     QAccessibleInterface *child(int index) const;
204
205 protected:
206     QCalendarWidget *calendarWidget() const;
207
208 private:
209     QAbstractItemView *calendarView() const;
210     QWidget *navigationBar() const;
211 };
212 #endif // QT_NO_CALENDARWIDGET
213
214 #ifndef QT_NO_DOCKWIDGET
215 class QAccessibleDockWidget: public QAccessibleWidget
216 {
217 public:
218     explicit QAccessibleDockWidget(QWidget *widget);
219     QAccessibleInterface *child(int index) const;
220     int indexOfChild(const QAccessibleInterface *child) const;
221     int childCount() const;
222     QRect rect () const;
223     QAccessible::Role role() const;
224
225     QDockWidget *dockWidget() const;
226 };
227
228 class QAccessibleTitleBar : public QAccessibleInterface
229 {
230 public:
231     explicit QAccessibleTitleBar(QDockWidget *widget);
232
233     QAccessibleInterface *parent() const;
234     QAccessibleInterface *child(int index) const;
235     int indexOfChild(const QAccessibleInterface *child) const;
236     int childCount() const;
237     QAccessibleInterface *childAt(int x, int y) const;
238     void setText(QAccessible::Text t, const QString &text);
239     QString text(QAccessible::Text t) const;
240     QAccessible::Role role() const;
241     QRect rect () const;
242     QAccessible::State state() const;
243     QObject *object() const;
244     bool isValid() const;
245
246     QPointer<QDockWidget> m_dockWidget;
247
248     QDockWidget *dockWidget() const;
249     QDockWidgetLayout *dockWidgetLayout() const;
250 };
251
252 #endif // QT_NO_DOCKWIDGET
253
254 #ifndef QT_NO_MAINWINDOW
255 class QAccessibleMainWindow : public QAccessibleWidget
256 {
257 public:
258     explicit QAccessibleMainWindow(QWidget *widget);
259
260     QAccessibleInterface *child(int index) const;
261     int childCount() const;
262     int indexOfChild(const QAccessibleInterface *iface) const;
263     QAccessibleInterface *childAt(int x, int y) const;
264     QMainWindow *mainWindow() const;
265
266 };
267 #endif //QT_NO_MAINWINDOW
268
269 #endif // QT_NO_ACCESSIBILITY
270
271 QT_END_NAMESPACE
272
273 #endif // QACESSIBLEWIDGETS_H