| /**************************************************************************** |
| ** |
| ** Copyright (C) 2016 The Qt Company Ltd. |
| ** Contact: https://www.qt.io/licensing/ |
| ** |
| ** This file is part of the plugins of the Qt Toolkit. |
| ** |
| ** $QT_BEGIN_LICENSE:LGPL$ |
| ** Commercial License Usage |
| ** Licensees holding valid commercial Qt licenses may use this file in |
| ** accordance with the commercial license agreement provided with the |
| ** Software or, alternatively, in accordance with the terms contained in |
| ** a written agreement between you and The Qt Company. For licensing terms |
| ** and conditions see https://www.qt.io/terms-conditions. For further |
| ** information use the contact form at https://www.qt.io/contact-us. |
| ** |
| ** GNU Lesser General Public License Usage |
| ** Alternatively, this file may be used under the terms of the GNU Lesser |
| ** General Public License version 3 as published by the Free Software |
| ** Foundation and appearing in the file LICENSE.LGPL3 included in the |
| ** packaging of this file. Please review the following information to |
| ** ensure the GNU Lesser General Public License version 3 requirements |
| ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. |
| ** |
| ** GNU General Public License Usage |
| ** Alternatively, this file may be used under the terms of the GNU |
| ** General Public License version 2.0 or (at your option) the GNU General |
| ** Public license version 3 or any later version approved by the KDE Free |
| ** Qt Foundation. The licenses are as published by the Free Software |
| ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 |
| ** included in the packaging of this file. Please review the following |
| ** information to ensure the GNU General Public License requirements will |
| ** be met: https://www.gnu.org/licenses/gpl-2.0.html and |
| ** https://www.gnu.org/licenses/gpl-3.0.html. |
| ** |
| ** $QT_END_LICENSE$ |
| ** |
| ****************************************************************************/ |
| |
| #ifndef QACCESSIBLEWIDGETS_H |
| #define QACCESSIBLEWIDGETS_H |
| |
| // |
| // W A R N I N G |
| // ------------- |
| // |
| // This file is not part of the Qt API. It exists purely as an |
| // implementation detail. This header file may change from version to |
| // version without notice, or even be removed. |
| // |
| // We mean it. |
| // |
| |
| #include <QtWidgets/private/qtwidgetsglobal_p.h> |
| #include <QtWidgets/qaccessiblewidget.h> |
| |
| #ifndef QT_NO_ACCESSIBILITY |
| |
| #include <QtCore/QPointer> |
| #include <QtCore/QPair> |
| |
| QT_BEGIN_NAMESPACE |
| |
| class QTextEdit; |
| class QStackedWidget; |
| class QToolBox; |
| class QMdiArea; |
| class QMdiSubWindow; |
| class QRubberBand; |
| class QTextBrowser; |
| class QCalendarWidget; |
| class QAbstractItemView; |
| class QDockWidget; |
| class QDockWidgetLayout; |
| class QMainWindow; |
| class QPlainTextEdit; |
| class QTextCursor; |
| class QTextDocument; |
| |
| #ifndef QT_NO_CURSOR |
| class QAccessibleTextWidget : public QAccessibleWidget, |
| public QAccessibleTextInterface, |
| public QAccessibleEditableTextInterface |
| { |
| public: |
| QAccessibleTextWidget(QWidget *o, QAccessible::Role r = QAccessible::EditableText, const QString &name = QString()); |
| |
| QAccessible::State state() const override; |
| |
| // QAccessibleTextInterface |
| // selection |
| void selection(int selectionIndex, int *startOffset, int *endOffset) const override; |
| int selectionCount() const override; |
| void addSelection(int startOffset, int endOffset) override; |
| void removeSelection(int selectionIndex) override; |
| void setSelection(int selectionIndex, int startOffset, int endOffset) override; |
| |
| // cursor |
| int cursorPosition() const override; |
| void setCursorPosition(int position) override; |
| |
| // text |
| QString text(int startOffset, int endOffset) const override; |
| QString textBeforeOffset(int offset, QAccessible::TextBoundaryType boundaryType, |
| int *startOffset, int *endOffset) const override; |
| QString textAfterOffset(int offset, QAccessible::TextBoundaryType boundaryType, |
| int *startOffset, int *endOffset) const override; |
| QString textAtOffset(int offset, QAccessible::TextBoundaryType boundaryType, |
| int *startOffset, int *endOffset) const override; |
| int characterCount() const override; |
| |
| // character <-> geometry |
| QRect characterRect(int offset) const override; |
| int offsetAtPoint(const QPoint &point) const override; |
| |
| QString attributes(int offset, int *startOffset, int *endOffset) const override; |
| |
| // QAccessibleEditableTextInterface |
| void deleteText(int startOffset, int endOffset) override; |
| void insertText(int offset, const QString &text) override; |
| void replaceText(int startOffset, int endOffset, const QString &text) override; |
| |
| using QAccessibleWidget::text; |
| |
| protected: |
| QTextCursor textCursorForRange(int startOffset, int endOffset) const; |
| virtual QPoint scrollBarPosition() const; |
| // return the current text cursor at the caret position including a potential selection |
| virtual QTextCursor textCursor() const = 0; |
| virtual void setTextCursor(const QTextCursor &) = 0; |
| virtual QTextDocument *textDocument() const = 0; |
| virtual QWidget *viewport() const = 0; |
| }; |
| |
| #if QT_CONFIG(textedit) |
| class QAccessiblePlainTextEdit : public QAccessibleTextWidget |
| { |
| public: |
| explicit QAccessiblePlainTextEdit(QWidget *o); |
| |
| QString text(QAccessible::Text t) const override; |
| void setText(QAccessible::Text t, const QString &text) override; |
| QAccessible::State state() const override; |
| |
| void *interface_cast(QAccessible::InterfaceType t) override; |
| |
| // QAccessibleTextInterface |
| void scrollToSubstring(int startIndex, int endIndex) override; |
| |
| using QAccessibleTextWidget::text; |
| |
| protected: |
| QPlainTextEdit *plainTextEdit() const; |
| |
| QPoint scrollBarPosition() const override; |
| QTextCursor textCursor() const override; |
| void setTextCursor(const QTextCursor &textCursor) override; |
| QTextDocument *textDocument() const override; |
| QWidget *viewport() const override; |
| }; |
| |
| class QAccessibleTextEdit : public QAccessibleTextWidget |
| { |
| public: |
| explicit QAccessibleTextEdit(QWidget *o); |
| |
| QString text(QAccessible::Text t) const override; |
| void setText(QAccessible::Text t, const QString &text) override; |
| QAccessible::State state() const override; |
| |
| void *interface_cast(QAccessible::InterfaceType t) override; |
| |
| // QAccessibleTextInterface |
| void scrollToSubstring(int startIndex, int endIndex) override; |
| |
| using QAccessibleTextWidget::text; |
| |
| protected: |
| QTextEdit *textEdit() const; |
| |
| QPoint scrollBarPosition() const override; |
| QTextCursor textCursor() const override; |
| void setTextCursor(const QTextCursor &textCursor) override; |
| QTextDocument *textDocument() const override; |
| QWidget *viewport() const override; |
| }; |
| #endif // QT_CONFIG(textedit) |
| #endif //QT_NO_CURSOR |
| |
| class QAccessibleStackedWidget : public QAccessibleWidget |
| { |
| public: |
| explicit QAccessibleStackedWidget(QWidget *widget); |
| |
| QAccessibleInterface *childAt(int x, int y) const override; |
| int childCount() const override; |
| int indexOfChild(const QAccessibleInterface *child) const override; |
| QAccessibleInterface *child(int index) const override; |
| |
| protected: |
| QStackedWidget *stackedWidget() const; |
| }; |
| |
| class QAccessibleToolBox : public QAccessibleWidget |
| { |
| public: |
| explicit QAccessibleToolBox(QWidget *widget); |
| |
| // FIXME we currently expose the toolbox but it is not keyboard navigatable |
| // and the accessible hierarchy is not exactly beautiful. |
| // int childCount() const; |
| // QAccessibleInterface *child(int index) const; |
| // int indexOfChild(const QAccessibleInterface *child) const; |
| |
| protected: |
| QToolBox *toolBox() const; |
| }; |
| |
| #if QT_CONFIG(mdiarea) |
| class QAccessibleMdiArea : public QAccessibleWidget |
| { |
| public: |
| explicit QAccessibleMdiArea(QWidget *widget); |
| |
| int childCount() const override; |
| QAccessibleInterface *child(int index) const override; |
| int indexOfChild(const QAccessibleInterface *child) const override; |
| |
| protected: |
| QMdiArea *mdiArea() const; |
| }; |
| |
| class QAccessibleMdiSubWindow : public QAccessibleWidget |
| { |
| public: |
| explicit QAccessibleMdiSubWindow(QWidget *widget); |
| |
| QString text(QAccessible::Text textType) const override; |
| void setText(QAccessible::Text textType, const QString &text) override; |
| QAccessible::State state() const override; |
| int childCount() const override; |
| QAccessibleInterface *child(int index) const override; |
| int indexOfChild(const QAccessibleInterface *child) const override; |
| QRect rect() const override; |
| |
| protected: |
| QMdiSubWindow *mdiSubWindow() const; |
| }; |
| #endif // QT_CONFIG(mdiarea) |
| |
| #if QT_CONFIG(dialogbuttonbox) |
| class QAccessibleDialogButtonBox : public QAccessibleWidget |
| { |
| public: |
| explicit QAccessibleDialogButtonBox(QWidget *widget); |
| }; |
| #endif |
| |
| #if QT_CONFIG(textbrowser) && !defined(QT_NO_CURSOR) |
| class QAccessibleTextBrowser : public QAccessibleTextEdit |
| { |
| public: |
| explicit QAccessibleTextBrowser(QWidget *widget); |
| |
| QAccessible::Role role() const override; |
| }; |
| #endif // QT_CONFIG(textbrowser) && QT_NO_CURSOR |
| |
| #if QT_CONFIG(calendarwidget) |
| class QAccessibleCalendarWidget : public QAccessibleWidget |
| { |
| public: |
| explicit QAccessibleCalendarWidget(QWidget *widget); |
| |
| int childCount() const override; |
| int indexOfChild(const QAccessibleInterface *child) const override; |
| |
| QAccessibleInterface *child(int index) const override; |
| |
| protected: |
| QCalendarWidget *calendarWidget() const; |
| |
| private: |
| QAbstractItemView *calendarView() const; |
| QWidget *navigationBar() const; |
| }; |
| #endif // QT_CONFIG(calendarwidget) |
| |
| #if QT_CONFIG(dockwidget) |
| class QAccessibleDockWidget: public QAccessibleWidget |
| { |
| public: |
| explicit QAccessibleDockWidget(QWidget *widget); |
| QAccessibleInterface *child(int index) const override; |
| int indexOfChild(const QAccessibleInterface *child) const override; |
| int childCount() const override; |
| QRect rect () const override; |
| QString text(QAccessible::Text t) const override; |
| |
| QDockWidget *dockWidget() const; |
| protected: |
| QDockWidgetLayout *dockWidgetLayout() const; |
| }; |
| |
| #endif // QT_CONFIG(dockwidget) |
| |
| #if QT_CONFIG(mainwindow) |
| class QAccessibleMainWindow : public QAccessibleWidget |
| { |
| public: |
| explicit QAccessibleMainWindow(QWidget *widget); |
| |
| QAccessibleInterface *child(int index) const override; |
| int childCount() const override; |
| int indexOfChild(const QAccessibleInterface *iface) const override; |
| QAccessibleInterface *childAt(int x, int y) const override; |
| QMainWindow *mainWindow() const; |
| |
| }; |
| #endif // QT_CONFIG(mainwindow) |
| |
| #endif // QT_NO_ACCESSIBILITY |
| |
| QT_END_NAMESPACE |
| |
| #endif // QACESSIBLEWIDGETS_H |