Line data Source code
1 : /*
2 : * SPDX-License-Identifier: GPL-3.0-only
3 : * MuseScore-CLA-applies
4 : *
5 : * MuseScore Studio
6 : * Music Composition & Notation
7 : *
8 : * Copyright (C) 2021 MuseScore Limited and others
9 : *
10 : * This program is free software: you can redistribute it and/or modify
11 : * it under the terms of the GNU General Public License version 3 as
12 : * published by the Free Software Foundation.
13 : *
14 : * This program is distributed in the hope that it will be useful,
15 : * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 : * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 : * GNU General Public License for more details.
18 : *
19 : * You should have received a copy of the GNU General Public License
20 : * along with this program. If not, see <https://www.gnu.org/licenses/>.
21 : */
22 : #ifndef MUSE_ACCESSIBILITY_IACCESSIBLE_H
23 : #define MUSE_ACCESSIBILITY_IACCESSIBLE_H
24 :
25 : #include <QString>
26 : #include <QRect>
27 : #include <QVariant>
28 : #include <QMap>
29 :
30 : #include "modularity/ioc.h"
31 : #include "global/async/channel.h"
32 : #include "global/types/val.h"
33 :
34 : class QWindow;
35 :
36 : namespace muse::accessibility {
37 : class IAccessible
38 : {
39 : public:
40 :
41 4692 : virtual ~IAccessible() = default;
42 :
43 : //! NOTE Please sync with ui::MUAccessible::Role (src/framework/ui/view/qmlaccessible.h)
44 : enum Role {
45 : NoRole = 0,
46 : Application,
47 : Dialog,
48 : Panel,
49 : StaticText,
50 : EditableText,
51 : SilentRole, // avoids reading "button", "text", etc. after item name
52 : Button,
53 : CheckBox,
54 : RadioButton,
55 : ComboBox,
56 : List,
57 : ListItem,
58 : MenuItem,
59 : SpinBox,
60 : Range,
61 : Group,
62 : Table,
63 : ColumnHeader,
64 : RowHeader,
65 : Column,
66 : Row,
67 : Cell,
68 :
69 : // Custom roles
70 : Information, // just text
71 :
72 : // Score roles
73 : ElementOnScore
74 : };
75 :
76 : enum class State {
77 : Undefined = 0,
78 : Enabled,
79 : Active,
80 : Focused,
81 : Selected,
82 : Checked
83 : };
84 :
85 : enum class Property {
86 : Undefined = 0,
87 : Parent,
88 : Name,
89 : Description,
90 : Value,
91 : TextCursor,
92 : TextInsert,
93 : TextRemove
94 : };
95 :
96 : enum TextBoundaryType {
97 : CharBoundary,
98 : WordBoundary,
99 : SentenceBoundary,
100 : ParagraphBoundary,
101 : LineBoundary,
102 : NoBoundary
103 : };
104 :
105 : struct TextRange {
106 : int startPosition = 0;
107 : int endPosition = 0;
108 : QString text;
109 :
110 0 : TextRange(int startPosition, int endPosition, const QString& text)
111 0 : : startPosition(startPosition), endPosition(endPosition), text(text) {}
112 0 : TextRange(const QVariantMap& map)
113 0 : {
114 0 : startPosition = map.value("startPosition").toInt();
115 0 : endPosition = map.value("endPosition").toInt();
116 0 : text = map.value("startPosition").toString();
117 0 : }
118 :
119 0 : QVariantMap toMap() const
120 : {
121 : return {
122 0 : { "startPosition", startPosition },
123 0 : { "endPosition", endPosition },
124 0 : { "text", text }
125 0 : };
126 0 : }
127 : };
128 :
129 : virtual const IAccessible* accessibleParent() const = 0;
130 : virtual size_t accessibleChildCount() const = 0;
131 : virtual IAccessible* accessibleChild(size_t i) const = 0;
132 : virtual QWindow* accessibleWindow() const = 0;
133 : virtual muse::modularity::ContextPtr iocContext() const = 0;
134 :
135 : virtual IAccessible::Role accessibleRole() const = 0;
136 : virtual QString accessibleName() const = 0;
137 : virtual QString accessibleDescription() const = 0;
138 : virtual bool accessibleState(State st) const = 0;
139 : virtual QRect accessibleRect() const = 0;
140 : virtual bool accessibleIgnored() const = 0;
141 :
142 : // Value Interface
143 : virtual QVariant accessibleValue() const = 0;
144 : virtual QVariant accessibleMaximumValue() const = 0;
145 : virtual QVariant accessibleMinimumValue() const = 0;
146 : virtual QVariant accessibleValueStepSize() const = 0;
147 :
148 : // Text Interface
149 : virtual void accessibleSelection(int selectionIndex, int* startOffset, int* endOffset) const = 0;
150 : virtual int accessibleSelectionCount() const = 0;
151 :
152 : virtual int accessibleCursorPosition() const = 0;
153 :
154 : virtual QString accessibleText(int startOffset, int endOffset) const = 0;
155 : virtual QString accessibleTextBeforeOffset(int offset, TextBoundaryType boundaryType, int* startOffset, int* endOffset) const = 0;
156 : virtual QString accessibleTextAfterOffset(int offset, TextBoundaryType boundaryType, int* startOffset, int* endOffset) const = 0;
157 : virtual QString accessibleTextAtOffset(int offset, TextBoundaryType boundaryType, int* startOffset, int* endOffset) const = 0;
158 : virtual int accessibleCharacterCount() const = 0;
159 :
160 : // ListView item Interface
161 : virtual int accessibleRowIndex() const = 0;
162 :
163 : virtual async::Channel<IAccessible::Property, Val> accessiblePropertyChanged() const = 0;
164 :
165 : virtual void setState(State state, bool arg) = 0;
166 : virtual async::Channel<IAccessible::State, bool> accessibleStateChanged() const = 0;
167 : };
168 : }
169 :
170 : #endif // MUSE_ACCESSIBILITY_IACCESSIBLE_H
|
