1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtQuick 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 The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/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 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QACCESSIBLEQUICKITEM_H
41#define QACCESSIBLEQUICKITEM_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists purely as an
48// implementation detail. This header file may change from version to
49// version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include <QtQuick/QQuickItem>
55#include <QtQuick/QQuickView>
56#include <QtGui/qaccessibleobject.h>
57
58QT_BEGIN_NAMESPACE
59
60#if QT_CONFIG(accessibility)
61
62class QTextDocument;
63
64class QAccessibleQuickItem : public QAccessibleObject, public QAccessibleActionInterface, public QAccessibleValueInterface, public QAccessibleTextInterface
65{
66public:
67 QAccessibleQuickItem(QQuickItem *item);
68
69 QWindow *window() const override;
70
71 QRect rect() const override;
72 QRect viewRect() const;
73
74 bool clipsChildren() const;
75 QAccessibleInterface *childAt(int x, int y) const override;
76
77 QAccessibleInterface *parent() const override;
78 QAccessibleInterface *child(int index) const override;
79 int childCount() const override;
80 int indexOfChild(const QAccessibleInterface *iface) const override;
81 QList<QQuickItem *> childItems() const;
82
83 QAccessible::State state() const override;
84 QAccessible::Role role() const override;
85 QString text(QAccessible::Text) const override;
86 void setText(QAccessible::Text, const QString &text) override;
87
88 bool isAccessible() const;
89
90 // Action Interface
91 QStringList actionNames() const override;
92 void doAction(const QString &actionName) override;
93 QStringList keyBindingsForAction(const QString &actionName) const override;
94
95 // Value Interface
96 QVariant currentValue() const override;
97 void setCurrentValue(const QVariant &value) override;
98 QVariant maximumValue() const override;
99 QVariant minimumValue() const override;
100 QVariant minimumStepSize() const override;
101
102
103 // Text Interface
104 void selection(int selectionIndex, int *startOffset, int *endOffset) const override;
105 int selectionCount() const override;
106 void addSelection(int startOffset, int endOffset) override;
107 void removeSelection(int selectionIndex) override;
108 void setSelection(int selectionIndex, int startOffset, int endOffset) override;
109
110 // cursor
111 int cursorPosition() const override;
112 void setCursorPosition(int position) override;
113
114 // text
115 QString text(int startOffset, int endOffset) const override;
116 QString textBeforeOffset(int offset, QAccessible::TextBoundaryType boundaryType,
117 int *startOffset, int *endOffset) const override;
118 QString textAfterOffset(int offset, QAccessible::TextBoundaryType boundaryType,
119 int *startOffset, int *endOffset) const override;
120 QString textAtOffset(int offset, QAccessible::TextBoundaryType boundaryType,
121 int *startOffset, int *endOffset) const override;
122 int characterCount() const override;
123
124 // character <-> geometry
125 QRect characterRect(int /* offset */) const override { return QRect(); }
126 int offsetAtPoint(const QPoint & /* point */) const override { return -1; }
127
128 void scrollToSubstring(int /* startIndex */, int /* endIndex */) override {}
129 QString attributes(int /* offset */, int *startOffset, int *endOffset) const override
130 { *startOffset = 0; *endOffset = 0; return QString(); }
131
132 QTextDocument *textDocument() const;
133
134protected:
135 QQuickItem *item() const { return static_cast<QQuickItem*>(object()); }
136 void *interface_cast(QAccessible::InterfaceType t) override;
137
138private:
139 QTextDocument *m_doc;
140};
141
142QRect itemScreenRect(QQuickItem *item);
143QList<QQuickItem *> accessibleUnignoredChildren(QQuickItem *item, bool paintOrder = false);
144
145#endif // accessibility
146
147QT_END_NAMESPACE
148
149#endif // QACCESSIBLEQUICKITEM_H
150