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 #ifdef DGETTEXT_ENABLED
26 #include <dali/devel-api/actors/actor-devel.h>
29 #include <dali-toolkit/devel-api/asset-manager/asset-manager.h>
30 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
31 #include <dali-toolkit/public-api/controls/control-impl.h>
32 #include <dali-toolkit/public-api/controls/control.h>
33 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
34 #include <dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h>
36 namespace Dali::Toolkit::DevelControl
39 static std::string GetLocaleText(std::string string, const char *domain = "dali-toolkit")
41 #ifdef DGETTEXT_ENABLED
42 /*TODO: currently non-localized string is used as a key for translation lookup. In case the lookup key formatting is forced
43 consider calling utility function for converting non-localized string into well-formatted key before lookup. */
44 return dgettext(domain, string.c_str());
50 AccessibleImpl::AccessibleImpl(Dali::Actor self, Dali::Accessibility::Role role, bool modal)
54 auto control = Dali::Toolkit::Control::DownCast(Self());
56 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
57 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
58 if(controlImpl.mAccessibilityRole == Dali::Accessibility::Role::UNKNOWN)
60 controlImpl.mAccessibilityRole = role;
63 Self().PropertySetSignal().Connect(&controlImpl, [this, &controlImpl](Dali::Handle& handle, Dali::Property::Index index, Dali::Property::Value value) {
64 if(this->Self() != Dali::Accessibility::Accessible::GetCurrentlyHighlightedActor())
69 if(index == DevelControl::Property::ACCESSIBILITY_NAME || (index == GetNamePropertyIndex() && !controlImpl.mAccessibilityNameSet))
71 if(controlImpl.mAccessibilityGetNameSignal.Empty())
73 Emit(Dali::Accessibility::ObjectPropertyChangeEvent::NAME);
77 if(index == DevelControl::Property::ACCESSIBILITY_DESCRIPTION || (index == GetDescriptionPropertyIndex() && !controlImpl.mAccessibilityDescriptionSet))
79 if(controlImpl.mAccessibilityGetDescriptionSignal.Empty())
81 Emit(Dali::Accessibility::ObjectPropertyChangeEvent::DESCRIPTION);
87 std::string AccessibleImpl::GetName()
89 auto control = Dali::Toolkit::Control::DownCast(Self());
91 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
92 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
95 if(!controlImpl.mAccessibilityGetNameSignal.Empty())
97 controlImpl.mAccessibilityGetNameSignal.Emit(name);
99 else if(controlImpl.mAccessibilityNameSet)
101 name = controlImpl.mAccessibilityName;
103 else if(auto raw = GetNameRaw(); !raw.empty())
109 name = Self().GetProperty<std::string>(Actor::Property::NAME);
112 if(controlImpl.mAccessibilityTranslationDomainSet)
114 return GetLocaleText(name, controlImpl.mAccessibilityTranslationDomain.c_str());
117 return GetLocaleText(name);
120 std::string AccessibleImpl::GetNameRaw()
125 std::string AccessibleImpl::GetDescription()
127 auto control = Dali::Toolkit::Control::DownCast(Self());
129 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
130 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
131 std::string description;
133 if(!controlImpl.mAccessibilityGetDescriptionSignal.Empty())
135 controlImpl.mAccessibilityGetDescriptionSignal.Emit(description);
137 else if(controlImpl.mAccessibilityDescriptionSet)
139 description = controlImpl.mAccessibilityDescription;
143 description = GetDescriptionRaw();
145 if(controlImpl.mAccessibilityTranslationDomainSet)
147 return GetLocaleText(description, controlImpl.mAccessibilityTranslationDomain.c_str());
150 return GetLocaleText(description);
153 std::string AccessibleImpl::GetDescriptionRaw()
158 Dali::Accessibility::Accessible* AccessibleImpl::GetParent()
160 return Dali::Accessibility::Accessible::Get(Self().GetParent());
163 size_t AccessibleImpl::GetChildCount()
165 return Self().GetChildCount();
168 Dali::Accessibility::Accessible* AccessibleImpl::GetChildAtIndex(size_t index)
170 return Dali::Accessibility::Accessible::Get(Self().GetChildAt(static_cast<unsigned int>(index)));
173 size_t AccessibleImpl::GetIndexInParent()
176 auto parent = self.GetParent();
177 DALI_ASSERT_ALWAYS(parent && "can't call GetIndexInParent on object without parent");
179 auto count = parent.GetChildCount();
180 for(auto i = 0u; i < count; ++i)
182 auto child = parent.GetChildAt(i);
188 DALI_ASSERT_ALWAYS(false && "object isn't child of it's parent");
189 return static_cast<size_t>(-1);
192 Dali::Accessibility::Role AccessibleImpl::GetRole()
194 return Self().GetProperty<Dali::Accessibility::Role>(Toolkit::DevelControl::Property::ACCESSIBILITY_ROLE);
197 std::string AccessibleImpl::GetLocalizedRoleName()
199 return GetLocaleText(GetRoleName());
202 Dali::Accessibility::States AccessibleImpl::CalculateStates()
204 Dali::Actor self = Self();
205 Dali::Accessibility::States state;
206 state[Dali::Accessibility::State::FOCUSABLE] = self.GetProperty<bool>(Actor::Property::KEYBOARD_FOCUSABLE);
207 state[Dali::Accessibility::State::FOCUSED] = Toolkit::KeyboardFocusManager::Get().GetCurrentFocusActor() == self;
209 if(self.GetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE).GetType() == Dali::Property::NONE)
211 state[Dali::Accessibility::State::HIGHLIGHTABLE] = false;
215 state[Dali::Accessibility::State::HIGHLIGHTABLE] = self.GetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE).Get<bool>();
218 state[Dali::Accessibility::State::HIGHLIGHTED] = GetCurrentlyHighlightedActor() == self;
219 state[Dali::Accessibility::State::ENABLED] = true;
220 state[Dali::Accessibility::State::SENSITIVE] = true;
221 state[Dali::Accessibility::State::VISIBLE] = true;
225 state[Dali::Accessibility::State::MODAL] = true;
227 state[Dali::Accessibility::State::SHOWING] = !self.GetProperty(Dali::DevelActor::Property::CULLED).Get<bool>() && self.GetCurrentProperty<bool>(Actor::Property::VISIBLE);
229 state[Dali::Accessibility::State::DEFUNCT] = !self.GetProperty(Dali::DevelActor::Property::CONNECTED_TO_SCENE).Get<bool>();
233 Dali::Accessibility::States AccessibleImpl::GetStates()
235 return CalculateStates();
238 Dali::Accessibility::Attributes AccessibleImpl::GetAttributes()
240 std::unordered_map<std::string, std::string> attributeMap;
241 auto control = Dali::Toolkit::Control::DownCast(Self());
242 auto attribute = control.GetProperty(Dali::Toolkit::DevelControl::Property::ACCESSIBILITY_ATTRIBUTES);
243 auto map = attribute.GetMap();
247 auto mapSize = map->Count();
249 for(unsigned int i = 0; i < mapSize; i++)
251 auto mapKey = map->GetKeyAt(i);
252 if(mapKey.type == Dali::Property::Key::STRING)
254 std::string mapValue;
255 if(map->GetValue(i).Get(mapValue))
257 attributeMap.emplace(std::move(mapKey.stringKey), std::move(mapValue));
266 Dali::Accessibility::ComponentLayer AccessibleImpl::GetLayer()
268 return Dali::Accessibility::ComponentLayer::WINDOW;
271 Dali::Rect<> AccessibleImpl::GetExtents(Dali::Accessibility::CoordinateType type)
273 Dali::Actor self = Self();
275 Vector2 screenPosition = self.GetProperty(Dali::DevelActor::Property::SCREEN_POSITION).Get<Vector2>();
276 auto size = self.GetCurrentProperty<Vector3>(Actor::Property::SIZE) * self.GetCurrentProperty<Vector3>(Actor::Property::WORLD_SCALE);
277 bool positionUsesAnchorPoint = self.GetProperty(Dali::DevelActor::Property::POSITION_USES_ANCHOR_POINT).Get<bool>();
278 Vector3 anchorPointOffSet = size * (positionUsesAnchorPoint ? self.GetCurrentProperty<Vector3>(Actor::Property::ANCHOR_POINT) : AnchorPoint::TOP_LEFT);
279 Vector2 position = Vector2((screenPosition.x - anchorPointOffSet.x), (screenPosition.y - anchorPointOffSet.y));
281 return {position.x, position.y, size.x, size.y};
284 int16_t AccessibleImpl::GetMdiZOrder()
288 double AccessibleImpl::GetAlpha()
293 bool AccessibleImpl::GrabFocus()
295 return Toolkit::KeyboardFocusManager::Get().SetCurrentFocusActor(Self());
298 static Dali::Actor CreateHighlightIndicatorActor()
300 std::string focusBorderImagePath(AssetManager::GetDaliImagePath());
301 focusBorderImagePath += "/keyboard_focus.9.png";
303 // Create the default if it hasn't been set and one that's shared by all the
304 // keyboard focusable actors
305 auto actor = Toolkit::ImageView::New(focusBorderImagePath);
306 actor.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS);
308 DevelControl::AppendAccessibilityAttribute(actor, "highlight", std::string());
309 actor.SetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE, false);
314 void AccessibleImpl::ScrollToSelf()
317 auto* parent = dynamic_cast<Toolkit::DevelControl::AccessibleImpl*>(child->GetParent());
321 if (parent->IsScrollable())
323 parent->ScrollToChild(child->Self());
327 parent = dynamic_cast<Toolkit::DevelControl::AccessibleImpl*>(parent->GetParent());
331 bool AccessibleImpl::GrabHighlight()
333 Dali::Actor self = Self();
334 auto oldHighlightedActor = GetCurrentlyHighlightedActor();
336 if(!Dali::Accessibility::IsUp())
341 if(self == oldHighlightedActor)
346 // Clear the old highlight.
347 if(oldHighlightedActor)
349 auto oldHighlightObject = dynamic_cast<Dali::Accessibility::Component*>(Internal::Control::Impl::GetAccessibilityObject(oldHighlightedActor));
350 if(oldHighlightObject)
352 oldHighlightObject->ClearHighlight();
356 auto highlight = GetHighlightActor();
359 highlight = CreateHighlightIndicatorActor();
360 SetHighlightActor(highlight);
363 highlight.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER);
364 highlight.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::CENTER);
365 highlight.SetProperty(Actor::Property::POSITION_Z, 1.0f);
366 highlight.SetProperty(Actor::Property::POSITION, Vector2(0.0f, 0.0f));
368 // Remember the highlight actor, so that when the default is changed with
369 // SetHighlightActor(), the currently displayed highlight can still be cleared.
370 mCurrentHighlightActor = highlight;
373 SetCurrentlyHighlightedActor(self);
374 EmitHighlighted(true);
379 bool AccessibleImpl::ClearHighlight()
381 Dali::Actor self = Self();
383 if(!Dali::Accessibility::IsUp())
388 if(GetCurrentlyHighlightedActor() == self)
390 self.Remove(mCurrentHighlightActor.GetHandle());
391 mCurrentHighlightActor = {};
392 SetCurrentlyHighlightedActor({});
393 EmitHighlighted(false);
399 std::string AccessibleImpl::GetActionName(size_t index)
401 if(index >= GetActionCount())
407 Self().GetTypeInfo(type);
408 DALI_ASSERT_ALWAYS(type && "no TypeInfo object");
409 return type.GetActionName(index);
412 std::string AccessibleImpl::GetLocalizedActionName(size_t index)
414 return GetLocaleText(GetActionName(index));
417 std::string AccessibleImpl::GetActionDescription(size_t index)
422 size_t AccessibleImpl::GetActionCount()
425 Self().GetTypeInfo(type);
426 DALI_ASSERT_ALWAYS(type && "no TypeInfo object");
427 return type.GetActionCount();
430 std::string AccessibleImpl::GetActionKeyBinding(size_t index)
435 bool AccessibleImpl::DoAction(size_t index)
437 std::string actionName = GetActionName(index);
438 return Self().DoAction(actionName, {});
441 bool AccessibleImpl::DoAction(const std::string& name)
443 return Self().DoAction(name, {});
446 bool AccessibleImpl::DoGesture(const Dali::Accessibility::GestureInfo& gestureInfo)
448 auto control = Dali::Toolkit::Control::DownCast(Self());
450 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
451 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
453 if(!controlImpl.mAccessibilityDoGestureSignal.Empty())
455 auto ret = std::make_pair(gestureInfo, false);
456 controlImpl.mAccessibilityDoGestureSignal.Emit(ret);
463 std::vector<Dali::Accessibility::Relation> AccessibleImpl::GetRelationSet()
465 auto control = Dali::Toolkit::Control::DownCast(Self());
467 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
468 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
470 std::vector<Dali::Accessibility::Relation> ret;
472 auto& relation = controlImpl.mAccessibilityRelations;
473 for(auto i = 0u; i < relation.size(); ++i)
475 if(relation[i].empty()) continue;
477 ret.emplace_back(Accessibility::Relation{static_cast<Accessibility::RelationType>(i), relation[i]});
483 bool AccessibleImpl::ScrollToChild(Actor child)
488 Dali::Property::Index AccessibleImpl::GetNamePropertyIndex()
490 return Actor::Property::NAME;
493 Dali::Property::Index AccessibleImpl::GetDescriptionPropertyIndex()
495 return Dali::Property::INVALID_INDEX;
498 } // namespace Dali::Toolkit::DevelControl