2 * Copyright (c) 2020 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-impl.h>
26 #include <dali-toolkit/public-api/controls/control.h>
27 #include <dali-toolkit/public-api/controls/control-impl.h>
28 #include <dali-toolkit/devel-api/controls/control-devel.h>
39 AccessibilityManager::AccessibilityManager()
41 mFocusOrder.push_back( {} ); // zero has a special meaning
44 AccessibilityManager::~AccessibilityManager()
48 void AccessibilityManager::SetAccessibilityAttribute(Actor actor, Toolkit::AccessibilityManager::AccessibilityAttribute type, const std::string& text)
52 case Toolkit::AccessibilityManager::ACCESSIBILITY_LABEL:
53 actor.SetProperty( Toolkit::DevelControl::Property::ACCESSIBILITY_NAME, text );
56 case Toolkit::AccessibilityManager::ACCESSIBILITY_HINT:
57 actor.SetProperty( Toolkit::DevelControl::Property::ACCESSIBILITY_DESCRIPTION, text );
60 case Toolkit::AccessibilityManager::ACCESSIBILITY_TRAIT:
61 case Toolkit::AccessibilityManager::ACCESSIBILITY_VALUE:
67 std::string AccessibilityManager::GetAccessibilityAttribute(Actor actor, Toolkit::AccessibilityManager::AccessibilityAttribute type) const
71 case Toolkit::AccessibilityManager::ACCESSIBILITY_LABEL:
72 return actor.GetProperty< std::string >( Toolkit::DevelControl::Property::ACCESSIBILITY_NAME );
74 case Toolkit::AccessibilityManager::ACCESSIBILITY_HINT:
75 return actor.GetProperty< std::string >( Toolkit::DevelControl::Property::ACCESSIBILITY_DESCRIPTION );
77 case Toolkit::AccessibilityManager::ACCESSIBILITY_TRAIT:
78 case Toolkit::AccessibilityManager::ACCESSIBILITY_VALUE:
84 void AccessibilityManager::SetFocusOrder(Actor actor, const unsigned int order)
89 if (order >= mFocusOrder.size())
90 mFocusOrder.resize(order + 1);
92 auto it = mFocusOrder.begin() + order;
93 mFocusOrder.insert(it, actor);
97 Actor prev = mFocusOrder[order - 1];
98 DevelControl::AppendAccessibilityRelation( prev, actor, Accessibility::RelationType::FLOWS_TO );
99 DevelControl::AppendAccessibilityRelation( actor, prev, Accessibility::RelationType::FLOWS_FROM );
102 if (order + 1 < mFocusOrder.size())
104 Actor next = mFocusOrder[order + 1];
105 DevelControl::AppendAccessibilityRelation( actor, next, Accessibility::RelationType::FLOWS_TO );
106 DevelControl::AppendAccessibilityRelation( next, actor, Accessibility::RelationType::FLOWS_FROM );
110 unsigned int AccessibilityManager::GetFocusOrder(Actor actor) const
112 for (auto it = mFocusOrder.begin(); it != mFocusOrder.end(); ++it)
115 return it - mFocusOrder.begin();
121 unsigned int AccessibilityManager::GenerateNewFocusOrder() const
123 return static_cast<unsigned>(mFocusOrder.size());
126 Actor AccessibilityManager::GetActorByFocusOrder(const unsigned int order)
130 if (order > 0 && order < mFocusOrder.size())
131 actor = mFocusOrder[order];
136 bool AccessibilityManager::SetCurrentFocusActor(Actor actor)
138 Dali::Accessibility::Accessible::SetCurrentlyHighlightedActor(actor);
143 Actor AccessibilityManager::GetCurrentFocusActor()
145 return Dali::Accessibility::Accessible::GetCurrentlyHighlightedActor();
148 Actor AccessibilityManager::GetCurrentFocusGroup()
150 return GetFocusGroup(GetCurrentFocusActor());
153 unsigned int AccessibilityManager::GetCurrentFocusOrder()
155 auto actor = GetCurrentFocusActor();
159 order = GetFocusOrder( actor );
164 bool AccessibilityManager::MoveFocusForward()
166 unsigned current = GetCurrentFocusOrder();
168 if (current + 1 < mFocusOrder.size())
169 return SetCurrentFocusActor(mFocusOrder[current + 1]);
174 bool AccessibilityManager::MoveFocusBackward()
176 unsigned current = GetCurrentFocusOrder();
178 if (current > 1) // zero has a special meaning
179 return SetCurrentFocusActor(mFocusOrder[current - 1]);
184 void AccessibilityManager::ClearFocus()
186 auto actor = GetCurrentFocusActor();
187 Toolkit::DevelControl::ClearAccessibilityHighlight( actor );
190 void AccessibilityManager::Reset()
194 for (std::size_t i = 2; i < mFocusOrder.size(); ++i)
196 Actor prev = mFocusOrder[i - 1];
197 Actor next = mFocusOrder[i];
199 DevelControl::RemoveAccessibilityRelation( prev, next, Accessibility::RelationType::FLOWS_TO );
200 DevelControl::RemoveAccessibilityRelation( next, prev, Accessibility::RelationType::FLOWS_FROM );
204 mFocusOrder.push_back( {} );
207 void AccessibilityManager::SetFocusGroup(Actor actor, bool isFocusGroup)
211 bool AccessibilityManager::IsFocusGroup(Actor actor) const
216 Actor AccessibilityManager::GetFocusGroup(Actor actor)
221 Vector2 AccessibilityManager::GetReadPosition() const
226 void AccessibilityManager::SetGroupMode(bool enabled)
230 bool AccessibilityManager::GetGroupMode() const
235 void AccessibilityManager::SetWrapMode(bool wrapped)
239 bool AccessibilityManager::GetWrapMode() const
244 void AccessibilityManager::SetFocusIndicatorActor(Actor indicator)
246 Dali::Accessibility::Accessible::SetHighlightActor( indicator );
249 Actor AccessibilityManager::GetFocusIndicatorActor()
251 return Dali::Accessibility::Accessible::GetHighlightActor();
254 Toolkit::AccessibilityManager::FocusChangedSignalType& AccessibilityManager::FocusChangedSignal()
256 return mFocusChangedSignal;
259 Toolkit::AccessibilityManager::FocusOvershotSignalType& AccessibilityManager::FocusOvershotSignal()
261 return mFocusOvershotSignal;
264 Toolkit::AccessibilityManager::FocusedActorActivatedSignalType& AccessibilityManager::FocusedActorActivatedSignal()
266 return mFocusedActorActivatedSignal;
269 } // namespace Internal
271 } // namespace Toolkit