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 "accessible-impl.h"
22 #include <dali/devel-api/actors/actor-devel.h>
25 #include <dali-toolkit/devel-api/asset-manager/asset-manager.h>
26 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
27 #include <dali-toolkit/public-api/controls/control-impl.h>
28 #include <dali-toolkit/public-api/controls/control.h>
29 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
30 #include <dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h>
32 namespace Dali::Toolkit::DevelControl {
34 AccessibleImpl::AccessibleImpl(Dali::Actor self, Dali::Accessibility::Role role, bool modal)
38 auto control = Dali::Toolkit::Control::DownCast(self);
40 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
41 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
42 if(controlImpl.mAccessibilityRole == Dali::Accessibility::Role::UNKNOWN)
43 controlImpl.mAccessibilityRole = role;
45 self.PropertySetSignal().Connect(&controlImpl, [this, &controlImpl](Dali::Handle& handle, Dali::Property::Index index, Dali::Property::Value value) {
46 if(this->self != Dali::Accessibility::Accessible::GetCurrentlyHighlightedActor())
51 if(index == DevelControl::Property::ACCESSIBILITY_NAME || (index == GetNamePropertyIndex() && !controlImpl.mAccessibilityNameSet))
53 if(controlImpl.mAccessibilityGetNameSignal.Empty())
55 Emit(Dali::Accessibility::ObjectPropertyChangeEvent::NAME);
59 if(index == DevelControl::Property::ACCESSIBILITY_DESCRIPTION || (index == GetDescriptionPropertyIndex() && !controlImpl.mAccessibilityDescriptionSet))
61 if(controlImpl.mAccessibilityGetDescriptionSignal.Empty())
63 Emit(Dali::Accessibility::ObjectPropertyChangeEvent::DESCRIPTION);
69 std::string AccessibleImpl::GetName()
71 auto control = Dali::Toolkit::Control::DownCast(self);
73 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
74 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
76 if(!controlImpl.mAccessibilityGetNameSignal.Empty())
79 controlImpl.mAccessibilityGetNameSignal.Emit(ret);
83 if(controlImpl.mAccessibilityNameSet)
84 return controlImpl.mAccessibilityName;
86 if(auto raw = GetNameRaw(); !raw.empty())
89 return self.GetProperty<std::string>(Actor::Property::NAME);
92 std::string AccessibleImpl::GetNameRaw()
97 std::string AccessibleImpl::GetDescription()
99 auto control = Dali::Toolkit::Control::DownCast(self);
101 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
102 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
104 if(!controlImpl.mAccessibilityGetDescriptionSignal.Empty())
107 controlImpl.mAccessibilityGetDescriptionSignal.Emit(ret);
111 if(controlImpl.mAccessibilityDescriptionSet)
112 return controlImpl.mAccessibilityDescription;
114 return GetDescriptionRaw();
117 std::string AccessibleImpl::GetDescriptionRaw()
122 Dali::Accessibility::Accessible* AccessibleImpl::GetParent()
124 return Dali::Accessibility::Accessible::Get(self.GetParent());
127 size_t AccessibleImpl::GetChildCount()
129 return self.GetChildCount();
132 Dali::Accessibility::Accessible* AccessibleImpl::GetChildAtIndex(size_t index)
134 return Dali::Accessibility::Accessible::Get(self.GetChildAt(static_cast<unsigned int>(index)));
137 size_t AccessibleImpl::GetIndexInParent()
140 auto parent = s.GetParent();
141 DALI_ASSERT_ALWAYS(parent && "can't call GetIndexInParent on object without parent");
142 auto count = parent.GetChildCount();
143 for(auto i = 0u; i < count; ++i)
145 auto c = parent.GetChildAt(i);
149 DALI_ASSERT_ALWAYS(false && "object isn't child of it's parent");
150 return static_cast<size_t>(-1);
153 Dali::Accessibility::Role AccessibleImpl::GetRole()
155 return self.GetProperty<Dali::Accessibility::Role>(Toolkit::DevelControl::Property::ACCESSIBILITY_ROLE);
158 Dali::Accessibility::States AccessibleImpl::CalculateStates()
160 Dali::Accessibility::States s;
161 s[Dali::Accessibility::State::FOCUSABLE] = self.GetProperty<bool>(Actor::Property::KEYBOARD_FOCUSABLE);
162 s[Dali::Accessibility::State::FOCUSED] = Toolkit::KeyboardFocusManager::Get().GetCurrentFocusActor() == self;
163 if(self.GetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE).GetType() == Dali::Property::NONE)
164 s[Dali::Accessibility::State::HIGHLIGHTABLE] = false;
166 s[Dali::Accessibility::State::HIGHLIGHTABLE] = self.GetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE).Get<bool>();
167 s[Dali::Accessibility::State::HIGHLIGHTED] = GetCurrentlyHighlightedActor() == self;
168 s[Dali::Accessibility::State::ENABLED] = true;
169 s[Dali::Accessibility::State::SENSITIVE] = true;
170 s[Dali::Accessibility::State::ANIMATED] = self.GetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_ANIMATED).Get<bool>();
171 s[Dali::Accessibility::State::VISIBLE] = true;
174 s[Dali::Accessibility::State::MODAL] = true;
176 s[Dali::Accessibility::State::SHOWING] = !self.GetProperty(Dali::DevelActor::Property::CULLED).Get<bool>() && self.GetCurrentProperty<bool>(Actor::Property::VISIBLE);
178 s[Dali::Accessibility::State::DEFUNCT] = !self.GetProperty(Dali::DevelActor::Property::CONNECTED_TO_SCENE).Get<bool>();
182 Dali::Accessibility::States AccessibleImpl::GetStates()
184 return CalculateStates();
187 Dali::Accessibility::Attributes AccessibleImpl::GetAttributes()
189 std::unordered_map<std::string, std::string> attribute_map;
190 auto q = Dali::Toolkit::Control::DownCast(self);
192 q.GetProperty(Dali::Toolkit::DevelControl::Property::ACCESSIBILITY_ATTRIBUTES);
197 auto map_size = z->Count();
199 for(unsigned int i = 0; i < map_size; i++)
201 auto map_key = z->GetKeyAt(i);
202 if(map_key.type == Dali::Property::Key::STRING)
204 std::string map_value;
205 if(z->GetValue(i).Get(map_value))
207 attribute_map.emplace(std::move(map_key.stringKey),
208 std::move(map_value));
214 return attribute_map;
217 Dali::Accessibility::ComponentLayer AccessibleImpl::GetLayer()
219 return Dali::Accessibility::ComponentLayer::WINDOW;
222 Dali::Rect<> AccessibleImpl::GetExtents(Dali::Accessibility::CoordType ctype)
224 Vector2 screenPosition =
225 self.GetProperty(Dali::DevelActor::Property::SCREEN_POSITION)
227 auto size = self.GetCurrentProperty<Vector3>(Actor::Property::SIZE) * self.GetCurrentProperty<Vector3>(Actor::Property::WORLD_SCALE);
228 bool positionUsesAnchorPoint =
229 self.GetProperty(Dali::DevelActor::Property::POSITION_USES_ANCHOR_POINT)
231 Vector3 anchorPointOffSet =
232 size * (positionUsesAnchorPoint ? self.GetCurrentProperty<Vector3>(Actor::Property::ANCHOR_POINT)
233 : AnchorPoint::TOP_LEFT);
234 Vector2 position = Vector2(screenPosition.x - anchorPointOffSet.x,
235 screenPosition.y - anchorPointOffSet.y);
237 return {position.x, position.y, size.x, size.y};
240 int16_t AccessibleImpl::GetMdiZOrder()
244 double AccessibleImpl::GetAlpha()
249 bool AccessibleImpl::GrabFocus()
251 return Toolkit::KeyboardFocusManager::Get().SetCurrentFocusActor(self);
254 static Dali::Actor CreateHighlightIndicatorActor()
256 std::string focusBorderImagePath(AssetManager::GetDaliImagePath());
257 focusBorderImagePath += "/keyboard_focus.9.png";
258 // Create the default if it hasn't been set and one that's shared by all the
259 // keyboard focusable actors
260 auto actor = Toolkit::ImageView::New(focusBorderImagePath);
261 actor.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS);
262 DevelControl::AppendAccessibilityAttribute(actor, "highlight", "");
263 actor.SetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_ANIMATED, true);
264 actor.SetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE, false);
269 bool AccessibleImpl::GrabHighlight()
271 auto old = GetCurrentlyHighlightedActor();
273 if(!Dali::Accessibility::IsUp())
279 auto c = dynamic_cast<Dali::Accessibility::Component*>(Internal::Control::Impl::GetAccessibilityObject(old));
283 auto highlight = GetHighlightActor();
286 highlight = CreateHighlightIndicatorActor();
287 SetHighlightActor(highlight);
289 highlight.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER);
290 highlight.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::CENTER);
291 highlight.SetProperty(Actor::Property::POSITION_Z, 1.0f);
292 highlight.SetProperty(Actor::Property::POSITION, Vector2(0.0f, 0.0f));
294 // Remember the highlight actor, so that when the default is changed with
295 // SetHighlightActor(), the currently displayed highlight can still be cleared.
296 currentHighlightActor = highlight;
299 SetCurrentlyHighlightedActor(self);
300 EmitHighlighted(true);
305 bool AccessibleImpl::ClearHighlight()
307 if(!Dali::Accessibility::IsUp())
309 if(GetCurrentlyHighlightedActor() == self)
311 self.Remove(currentHighlightActor.GetHandle());
312 currentHighlightActor = {};
313 SetCurrentlyHighlightedActor({});
314 EmitHighlighted(false);
320 std::string AccessibleImpl::GetActionName(size_t index)
322 if(index >= GetActionCount()) return "";
324 self.GetTypeInfo(type);
325 DALI_ASSERT_ALWAYS(type && "no TypeInfo object");
326 return type.GetActionName(index);
329 std::string AccessibleImpl::GetLocalizedActionName(size_t index)
331 // TODO: add localization
332 return GetActionName(index);
335 std::string AccessibleImpl::GetActionDescription(size_t index)
340 size_t AccessibleImpl::GetActionCount()
343 self.GetTypeInfo(type);
344 DALI_ASSERT_ALWAYS(type && "no TypeInfo object");
345 return type.GetActionCount();
348 std::string AccessibleImpl::GetActionKeyBinding(size_t index)
353 bool AccessibleImpl::DoAction(size_t index)
355 std::string actionName = GetActionName(index);
356 return self.DoAction(actionName, {});
359 bool AccessibleImpl::DoAction(const std::string& name)
361 return self.DoAction(name, {});
364 bool AccessibleImpl::DoGesture(const Dali::Accessibility::GestureInfo& gestureInfo)
366 auto control = Dali::Toolkit::Control::DownCast(self);
368 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
369 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
371 if(!controlImpl.mAccessibilityDoGestureSignal.Empty())
373 auto ret = std::make_pair(gestureInfo, false);
374 controlImpl.mAccessibilityDoGestureSignal.Emit(ret);
381 std::vector<Dali::Accessibility::Relation> AccessibleImpl::GetRelationSet()
383 auto control = Dali::Toolkit::Control::DownCast(self);
385 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
386 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
388 std::vector<Dali::Accessibility::Relation> ret;
390 auto& v = controlImpl.mAccessibilityRelations;
391 for(auto i = 0u; i < v.size(); ++i)
396 ret.emplace_back(Accessibility::Relation{static_cast<Accessibility::RelationType>(i), v[i]});
402 void AccessibleImpl::EnsureChildVisible(Actor child)
406 void AccessibleImpl::EnsureSelfVisible()
408 auto parent = dynamic_cast<AccessibleImpl*>(GetParent());
411 parent->EnsureChildVisible(self);
415 Dali::Property::Index AccessibleImpl::GetNamePropertyIndex()
417 return Actor::Property::NAME;
420 Dali::Property::Index AccessibleImpl::GetDescriptionPropertyIndex()
422 return Dali::Property::INVALID_INDEX;
425 } // namespace Dali::Toolkit::DevelControl