2 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include "accessibility-manager-impl.h"
22 #include <dali/devel-api/adaptor-framework/accessibility.h>
23 #include <dali/devel-api/adaptor-framework/accessibility-bridge.h>
26 #include <dali-toolkit/devel-api/controls/control-devel.h>
27 #include <dali-toolkit/public-api/controls/control-impl.h>
28 #include <dali-toolkit/public-api/controls/control.h>
36 AccessibilityManager::AccessibilityManager()
38 mFocusOrder.push_back({}); // zero has a special meaning
41 AccessibilityManager::~AccessibilityManager()
45 void AccessibilityManager::SetAccessibilityAttribute(Actor actor, Toolkit::AccessibilityManager::AccessibilityAttribute type, const std::string& text)
49 case Toolkit::AccessibilityManager::ACCESSIBILITY_LABEL:
50 actor.SetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_NAME, text);
53 case Toolkit::AccessibilityManager::ACCESSIBILITY_HINT:
54 actor.SetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_DESCRIPTION, text);
57 case Toolkit::AccessibilityManager::ACCESSIBILITY_TRAIT:
58 case Toolkit::AccessibilityManager::ACCESSIBILITY_VALUE:
64 std::string AccessibilityManager::GetAccessibilityAttribute(Actor actor, Toolkit::AccessibilityManager::AccessibilityAttribute type) const
68 case Toolkit::AccessibilityManager::ACCESSIBILITY_LABEL:
69 return actor.GetProperty<std::string>(Toolkit::DevelControl::Property::ACCESSIBILITY_NAME);
71 case Toolkit::AccessibilityManager::ACCESSIBILITY_HINT:
72 return actor.GetProperty<std::string>(Toolkit::DevelControl::Property::ACCESSIBILITY_DESCRIPTION);
74 case Toolkit::AccessibilityManager::ACCESSIBILITY_TRAIT:
75 case Toolkit::AccessibilityManager::ACCESSIBILITY_VALUE:
81 void AccessibilityManager::SetFocusOrder(Actor actor, const unsigned int order)
83 auto control = Toolkit::Control::DownCast(actor);
85 if(!control || order == 0)
90 if(order >= mFocusOrder.size())
92 mFocusOrder.resize(order + 1);
95 auto it = mFocusOrder.begin() + order;
96 mFocusOrder.insert(it, control);
100 if(auto prev = mFocusOrder[order - 1])
102 DevelControl::AppendAccessibilityRelation(prev, control, Accessibility::RelationType::FLOWS_TO);
103 DevelControl::AppendAccessibilityRelation(control, prev, Accessibility::RelationType::FLOWS_FROM);
107 if(order + 1 < mFocusOrder.size())
109 if(auto next = mFocusOrder[order + 1])
111 DevelControl::AppendAccessibilityRelation(control, next, Accessibility::RelationType::FLOWS_TO);
112 DevelControl::AppendAccessibilityRelation(next, control, Accessibility::RelationType::FLOWS_FROM);
117 unsigned int AccessibilityManager::GetFocusOrder(Actor actor) const
119 for(auto it = mFocusOrder.begin(); it != mFocusOrder.end(); ++it)
122 return it - mFocusOrder.begin();
128 unsigned int AccessibilityManager::GenerateNewFocusOrder() const
130 return static_cast<unsigned>(mFocusOrder.size());
133 Actor AccessibilityManager::GetActorByFocusOrder(const unsigned int order)
137 if(order > 0 && order < mFocusOrder.size())
138 actor = mFocusOrder[order];
143 bool AccessibilityManager::SetCurrentFocusActor(Actor actor)
145 auto control = Toolkit::Control::DownCast(actor);
151 return Toolkit::DevelControl::GrabAccessibilityHighlight(control);
154 Actor AccessibilityManager::GetCurrentFocusActor()
156 return Dali::Accessibility::Accessible::GetCurrentlyHighlightedActor();
159 Actor AccessibilityManager::GetCurrentFocusGroup()
161 return GetFocusGroup(GetCurrentFocusActor());
164 unsigned int AccessibilityManager::GetCurrentFocusOrder()
166 auto actor = GetCurrentFocusActor();
170 order = GetFocusOrder(actor);
175 bool AccessibilityManager::MoveFocusForward()
177 unsigned current = GetCurrentFocusOrder();
179 if(current + 1 < mFocusOrder.size())
180 return SetCurrentFocusActor(mFocusOrder[current + 1]);
185 bool AccessibilityManager::MoveFocusBackward()
187 unsigned current = GetCurrentFocusOrder();
189 if(current > 1) // zero has a special meaning
190 return SetCurrentFocusActor(mFocusOrder[current - 1]);
195 void AccessibilityManager::ClearFocus()
197 auto control = Toolkit::Control::DownCast(GetCurrentFocusActor());
203 Toolkit::DevelControl::ClearAccessibilityHighlight(control);
206 void AccessibilityManager::Reset()
210 for(std::size_t i = 2; i < mFocusOrder.size(); ++i)
212 auto prev = mFocusOrder[i - 1];
213 auto next = mFocusOrder[i];
217 DevelControl::RemoveAccessibilityRelation(prev, next, Accessibility::RelationType::FLOWS_TO);
218 DevelControl::RemoveAccessibilityRelation(next, prev, Accessibility::RelationType::FLOWS_FROM);
223 mFocusOrder.push_back({});
226 void AccessibilityManager::SetFocusGroup(Actor actor, bool isFocusGroup)
230 bool AccessibilityManager::IsFocusGroup(Actor actor) const
235 Actor AccessibilityManager::GetFocusGroup(Actor actor)
240 Vector2 AccessibilityManager::GetReadPosition() const
245 void AccessibilityManager::SetGroupMode(bool enabled)
249 bool AccessibilityManager::GetGroupMode() const
254 void AccessibilityManager::SetWrapMode(bool wrapped)
258 bool AccessibilityManager::GetWrapMode() const
263 void AccessibilityManager::SetFocusIndicatorActor(Actor indicator)
265 Dali::Accessibility::Accessible::SetHighlightActor(indicator);
268 Actor AccessibilityManager::GetFocusIndicatorActor()
270 return Dali::Accessibility::Accessible::GetHighlightActor();
273 Toolkit::AccessibilityManager::FocusChangedSignalType& AccessibilityManager::FocusChangedSignal()
275 return mFocusChangedSignal;
278 Toolkit::AccessibilityManager::FocusOvershotSignalType& AccessibilityManager::FocusOvershotSignal()
280 return mFocusOvershotSignal;
283 Toolkit::AccessibilityManager::FocusedActorActivatedSignalType& AccessibilityManager::FocusedActorActivatedSignal()
285 return mFocusedActorActivatedSignal;
288 } // namespace Internal
290 } // namespace Toolkit