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 QWorkspace;
  60 class QRubberBand;
  61 class QTextBrowser;
  62 class QCalendarWidget;
  63 class QAbstractItemView;
  64 class QDockWidget;
  65 class QDockWidgetLayout;
  66 class QMainWindow;
  67
  68 #ifndef QT_NO_TEXTEDIT
  69 class QAccessibleTextEdit : public QAccessibleWidget, public QAccessibleTextInterface,
  70                             public QAccessibleEditableTextInterface
  71 {
  72 public:
  73     explicit QAccessibleTextEdit(QWidget *o);
  74
  75     QString text(QAccessible::Text t) const;
  76     void setText(QAccessible::Text t, const QString &text);
  77
  78     void *interface_cast(QAccessible::InterfaceType t);
  79
  80     // QAccessibleTextInterface
  81     void addSelection(int startOffset, int endOffset);
  82     QString attributes(int offset, int *startOffset, int *endOffset) const;
  83     int cursorPosition() const;
  84     QRect characterRect(int offset, QAccessible2::CoordinateType coordType) const;
  85     int selectionCount() const;
  86     int offsetAtPoint(const QPoint &point, QAccessible2::CoordinateType coordType) const;
  87     void selection(int selectionIndex, int *startOffset, int *endOffset) const;
  88     QString text(int startOffset, int endOffset) const;
  89     QString textBeforeOffset (int offset, QAccessible2::BoundaryType boundaryType,
  90             int *startOffset, int *endOffset) const;
  91     QString textAfterOffset(int offset, QAccessible2::BoundaryType boundaryType,
  92             int *startOffset, int *endOffset) const;
  93     QString textAtOffset(int offset, QAccessible2::BoundaryType boundaryType,
  94             int *startOffset, int *endOffset) const;
  95     void removeSelection(int selectionIndex);
  96     void setCursorPosition(int position);
  97     void setSelection(int selectionIndex, int startOffset, int endOffset);
  98     int characterCount() const;
  99     void scrollToSubstring(int startIndex, int endIndex);
 100
 101     // QAccessibleEditableTextInterface
 102     void copyText(int startOffset, int endOffset) const;
 103     void deleteText(int startOffset, int endOffset);
 104     void insertText(int offset, const QString &text);
 105     void cutText(int startOffset, int endOffset);
 106     void pasteText(int offset);
 107     void replaceText(int startOffset, int endOffset, const QString &text);
 108     void setAttributes(int startOffset, int endOffset, const QString &attributes);
 109
 110 protected:
 111     QTextEdit *textEdit() const;
 112
 113 private:
 114     int childOffset;
 115 };
 116 #endif // QT_NO_TEXTEDIT
 117
 118 class QAccessibleStackedWidget : public QAccessibleWidget
 119 {
 120 public:
 121     explicit QAccessibleStackedWidget(QWidget *widget);
 122
 123     QAccessibleInterface *childAt(int x, int y) const;
 124     int childCount() const;
 125     int indexOfChild(const QAccessibleInterface *child) const;
 126     QAccessibleInterface *child(int index) const;
 127
 128 protected:
 129     QStackedWidget *stackedWidget() const;
 130 };
 131
 132 class QAccessibleToolBox : public QAccessibleWidget
 133 {
 134 public:
 135     explicit QAccessibleToolBox(QWidget *widget);
 136
 137 // FIXME we currently expose the toolbox but it is not keyboard navigatable
 138 // and the accessible hierarchy is not exactly beautiful.
 139 //    int childCount() const;
 140 //    QAccessibleInterface *child(int index) const;
 141 //    int indexOfChild(const QAccessibleInterface *child) const;
 142
 143 protected:
 144     QToolBox *toolBox() const;
 145 };
 146
 147 #ifndef QT_NO_MDIAREA
 148 class QAccessibleMdiArea : public QAccessibleWidget
 149 {
 150 public:
 151     explicit QAccessibleMdiArea(QWidget *widget);
 152
 153     int childCount() const;
 154     QAccessibleInterface *child(int index) const;
 155     int indexOfChild(const QAccessibleInterface *child) const;
 156
 157 protected:
 158     QMdiArea *mdiArea() const;
 159 };
 160
 161 class QAccessibleMdiSubWindow : public QAccessibleWidget
 162 {
 163 public:
 164     explicit QAccessibleMdiSubWindow(QWidget *widget);
 165
 166     QString text(QAccessible::Text textType) const;
 167     void setText(QAccessible::Text textType, const QString &text);
 168     QAccessible::State state() const;
 169     int childCount() const;
 170     QAccessibleInterface *child(int index) const;
 171     int indexOfChild(const QAccessibleInterface *child) const;
 172     QRect rect() const;
 173
 174 protected:
 175     QMdiSubWindow *mdiSubWindow() const;
 176 };
 177 #endif // QT_NO_MDIAREA
 178
 179 #ifndef QT_NO_WORKSPACE
 180 class QAccessibleWorkspace : public QAccessibleWidget
 181 {
 182 public:
 183     explicit QAccessibleWorkspace(QWidget *widget);
 184
 185     int childCount() const;
 186     QAccessibleInterface *child(int index) const;
 187     int indexOfChild(const QAccessibleInterface *child) const;
 188
 189 protected:
 190     QWorkspace *workspace() const;
 191 };
 192 #endif
 193
 194 class QAccessibleDialogButtonBox : public QAccessibleWidget
 195 {
 196 public:
 197     explicit QAccessibleDialogButtonBox(QWidget *widget);
 198 };
 199
 200 #ifndef QT_NO_TEXTBROWSER
 201 class QAccessibleTextBrowser : public QAccessibleTextEdit
 202 {
 203 public:
 204     explicit QAccessibleTextBrowser(QWidget *widget);
 205
 206     QAccessible::Role role() const;
 207 };
 208 #endif // QT_NO_TEXTBROWSER
 209
 210 #ifndef QT_NO_CALENDARWIDGET
 211 class QAccessibleCalendarWidget : public QAccessibleWidget
 212 {
 213 public:
 214     explicit QAccessibleCalendarWidget(QWidget *widget);
 215
 216     int childCount() const;
 217     int indexOfChild(const QAccessibleInterface *child) const;
 218
 219     QAccessibleInterface *child(int index) const;
 220
 221 protected:
 222     QCalendarWidget *calendarWidget() const;
 223
 224 private:
 225     QAbstractItemView *calendarView() const;
 226     QWidget *navigationBar() const;
 227 };
 228 #endif // QT_NO_CALENDARWIDGET
 229
 230 #ifndef QT_NO_DOCKWIDGET
 231 class QAccessibleDockWidget: public QAccessibleWidget
 232 {
 233 public:
 234     explicit QAccessibleDockWidget(QWidget *widget);
 235     QAccessibleInterface *child(int index) const;
 236     int indexOfChild(const QAccessibleInterface *child) const;
 237     int childCount() const;
 238     QRect rect () const;
 239     QAccessible::Role role() const;
 240
 241     QDockWidget *dockWidget() const;
 242 };
 243
 244 class QAccessibleTitleBar : public QAccessibleInterface
 245 {
 246 public:
 247     explicit QAccessibleTitleBar(QDockWidget *widget);
 248
 249     QAccessibleInterface *parent() const;
 250     QAccessibleInterface *child(int index) const;
 251     int indexOfChild(const QAccessibleInterface *child) const;
 252     int childCount() const;
 253     QAccessibleInterface *childAt(int x, int y) const;
 254     void setText(QAccessible::Text t, const QString &text);
 255     QString text(QAccessible::Text t) const;
 256     QAccessible::Role role() const;
 257     QRect rect () const;
 258     QAccessible::State state() const;
 259     QObject *object() const;
 260     bool isValid() const;
 261
 262     QPointer<QDockWidget> m_dockWidget;
 263
 264     QDockWidget *dockWidget() const;
 265     QDockWidgetLayout *dockWidgetLayout() const;
 266 };
 267
 268 #endif // QT_NO_DOCKWIDGET
 269
 270 #ifndef QT_NO_MAINWINDOW
 271 class QAccessibleMainWindow : public QAccessibleWidget
 272 {
 273 public:
 274     explicit QAccessibleMainWindow(QWidget *widget);
 275
 276     QAccessibleInterface *child(int index) const;
 277     int childCount() const;
 278     int indexOfChild(const QAccessibleInterface *iface) const;
 279     QAccessibleInterface *childAt(int x, int y) const;
 280     QMainWindow *mainWindow() const;
 281
 282 };
 283 #endif //QT_NO_MAINWINDOW
 284
 285 #endif // QT_NO_ACCESSIBILITY
 286
 287 QT_END_NAMESPACE
 288
 289 #endif // QACESSIBLEWIDGETS_H