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 bool AccessibleImpl::IsShowing()
204 Dali::Actor self = Self();
205 if(self.GetProperty(Dali::DevelActor::Property::CULLED).Get<bool>() || !self.GetCurrentProperty<bool>(Actor::Property::VISIBLE))
211 auto* parent = dynamic_cast<Toolkit::DevelControl::AccessibleImpl*>(child->GetParent());
217 auto childExtent = child->GetExtents(Dali::Accessibility::CoordinateType::WINDOW);
220 auto control = Dali::Toolkit::Control::DownCast(parent->Self());
221 auto clipMode = control.GetProperty(Actor::Property::CLIPPING_MODE).Get<bool>();
222 auto parentExtent = parent->GetExtents(Dali::Accessibility::CoordinateType::WINDOW);
223 if ((clipMode != ClippingMode::DISABLED) && !parentExtent.Intersects(childExtent))
227 parent = dynamic_cast<Toolkit::DevelControl::AccessibleImpl*>(parent->GetParent());
233 Dali::Accessibility::States AccessibleImpl::CalculateStates()
235 Dali::Actor self = Self();
236 Dali::Accessibility::States state;
237 state[Dali::Accessibility::State::FOCUSABLE] = self.GetProperty<bool>(Actor::Property::KEYBOARD_FOCUSABLE);
238 state[Dali::Accessibility::State::FOCUSED] = Toolkit::KeyboardFocusManager::Get().GetCurrentFocusActor() == self;
240 if(self.GetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE).GetType() == Dali::Property::NONE)
242 state[Dali::Accessibility::State::HIGHLIGHTABLE] = false;
246 state[Dali::Accessibility::State::HIGHLIGHTABLE] = self.GetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE).Get<bool>();
249 state[Dali::Accessibility::State::HIGHLIGHTED] = GetCurrentlyHighlightedActor() == self;
250 state[Dali::Accessibility::State::ENABLED] = true;
251 state[Dali::Accessibility::State::SENSITIVE] = true;
252 state[Dali::Accessibility::State::VISIBLE] = true;
256 state[Dali::Accessibility::State::MODAL] = true;
258 state[Dali::Accessibility::State::SHOWING] = IsShowing();
259 state[Dali::Accessibility::State::DEFUNCT] = !self.GetProperty(Dali::DevelActor::Property::CONNECTED_TO_SCENE).Get<bool>();
263 Dali::Accessibility::States AccessibleImpl::GetStates()
265 return CalculateStates();
268 Dali::Accessibility::Attributes AccessibleImpl::GetAttributes()
270 std::unordered_map<std::string, std::string> attributeMap;
271 auto control = Dali::Toolkit::Control::DownCast(Self());
272 auto attribute = control.GetProperty(Dali::Toolkit::DevelControl::Property::ACCESSIBILITY_ATTRIBUTES);
273 auto map = attribute.GetMap();
277 auto mapSize = map->Count();
279 for(unsigned int i = 0; i < mapSize; i++)
281 auto mapKey = map->GetKeyAt(i);
282 if(mapKey.type == Dali::Property::Key::STRING)
284 std::string mapValue;
285 if(map->GetValue(i).Get(mapValue))
287 attributeMap.emplace(std::move(mapKey.stringKey), std::move(mapValue));
296 Dali::Accessibility::ComponentLayer AccessibleImpl::GetLayer()
298 return Dali::Accessibility::ComponentLayer::WINDOW;
301 Dali::Rect<> AccessibleImpl::GetExtents(Dali::Accessibility::CoordinateType type)
303 Dali::Actor self = Self();
305 Vector2 screenPosition = self.GetProperty(Dali::DevelActor::Property::SCREEN_POSITION).Get<Vector2>();
306 auto size = self.GetCurrentProperty<Vector3>(Actor::Property::SIZE) * self.GetCurrentProperty<Vector3>(Actor::Property::WORLD_SCALE);
307 bool positionUsesAnchorPoint = self.GetProperty(Dali::DevelActor::Property::POSITION_USES_ANCHOR_POINT).Get<bool>();
308 Vector3 anchorPointOffSet = size * (positionUsesAnchorPoint ? self.GetCurrentProperty<Vector3>(Actor::Property::ANCHOR_POINT) : AnchorPoint::TOP_LEFT);
309 Vector2 position = Vector2((screenPosition.x - anchorPointOffSet.x), (screenPosition.y - anchorPointOffSet.y));
311 return {position.x, position.y, size.x, size.y};
314 int16_t AccessibleImpl::GetMdiZOrder()
318 double AccessibleImpl::GetAlpha()
323 bool AccessibleImpl::GrabFocus()
325 return Toolkit::KeyboardFocusManager::Get().SetCurrentFocusActor(Self());
328 static Dali::Actor CreateHighlightIndicatorActor()
330 std::string focusBorderImagePath(AssetManager::GetDaliImagePath());
331 focusBorderImagePath += "/keyboard_focus.9.png";
333 // Create the default if it hasn't been set and one that's shared by all the
334 // keyboard focusable actors
335 auto actor = Toolkit::ImageView::New(focusBorderImagePath);
336 actor.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS);
338 DevelControl::AppendAccessibilityAttribute(actor, "highlight", std::string());
339 actor.SetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE, false);
344 void AccessibleImpl::ScrollToSelf()
347 auto* parent = dynamic_cast<Toolkit::DevelControl::AccessibleImpl*>(child->GetParent());
351 if (parent->IsScrollable())
353 parent->ScrollToChild(child->Self());
357 parent = dynamic_cast<Toolkit::DevelControl::AccessibleImpl*>(parent->GetParent());
361 void AccessibleImpl::RegisterPositionPropertyNotification()
363 auto control = Dali::Toolkit::Control::DownCast(Self());
364 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
365 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
366 controlImpl.RegisterAccessibilityPositionPropertyNotification();
369 void AccessibleImpl::UnregisterPositionPropertyNotification()
371 auto control = Dali::Toolkit::Control::DownCast(Self());
372 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
373 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
374 controlImpl.UnregisterAccessibilityPositionPropertyNotification();
377 bool AccessibleImpl::GrabHighlight()
379 Dali::Actor self = Self();
380 auto oldHighlightedActor = GetCurrentlyHighlightedActor();
382 if(!Dali::Accessibility::IsUp())
387 if(self == oldHighlightedActor)
392 // Clear the old highlight.
393 if(oldHighlightedActor)
395 auto oldHighlightObject = dynamic_cast<Dali::Accessibility::Component*>(Internal::Control::Impl::GetAccessibilityObject(oldHighlightedActor));
396 if(oldHighlightObject)
398 oldHighlightObject->ClearHighlight();
402 auto highlight = GetHighlightActor();
405 highlight = CreateHighlightIndicatorActor();
406 SetHighlightActor(highlight);
409 highlight.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_LEFT);
410 highlight.SetProperty(Actor::Property::POSITION_Z, 1.0f);
411 highlight.SetProperty(Actor::Property::POSITION, Vector2(0.0f, 0.0f));
413 // Need to set resize policy again, to update SIZE property which is set by
414 // AccessibleImpl_NUI. The highlight could move from AccessibleImpl_NUI to
415 // AccessibleImpl. In this case, highlight has incorrect size.
416 highlight.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS);
418 // Remember the highlight actor, so that when the default is changed with
419 // SetHighlightActor(), the currently displayed highlight can still be cleared.
420 mCurrentHighlightActor = highlight;
423 SetCurrentlyHighlightedActor(self);
424 EmitHighlighted(true);
425 RegisterPositionPropertyNotification();
430 bool AccessibleImpl::ClearHighlight()
432 Dali::Actor self = Self();
434 if(!Dali::Accessibility::IsUp())
439 if(GetCurrentlyHighlightedActor() == self)
441 UnregisterPositionPropertyNotification();
442 self.Remove(mCurrentHighlightActor.GetHandle());
443 mCurrentHighlightActor = {};
444 SetCurrentlyHighlightedActor({});
445 EmitHighlighted(false);
451 std::string AccessibleImpl::GetActionName(size_t index)
453 if(index >= GetActionCount())
459 Self().GetTypeInfo(type);
460 DALI_ASSERT_ALWAYS(type && "no TypeInfo object");
461 return type.GetActionName(index);
464 std::string AccessibleImpl::GetLocalizedActionName(size_t index)
466 return GetLocaleText(GetActionName(index));
469 std::string AccessibleImpl::GetActionDescription(size_t index)
474 size_t AccessibleImpl::GetActionCount()
477 Self().GetTypeInfo(type);
478 DALI_ASSERT_ALWAYS(type && "no TypeInfo object");
479 return type.GetActionCount();
482 std::string AccessibleImpl::GetActionKeyBinding(size_t index)
487 bool AccessibleImpl::DoAction(size_t index)
489 std::string actionName = GetActionName(index);
490 return Self().DoAction(actionName, {});
493 bool AccessibleImpl::DoAction(const std::string& name)
495 return Self().DoAction(name, {});
498 bool AccessibleImpl::DoGesture(const Dali::Accessibility::GestureInfo& gestureInfo)
500 auto control = Dali::Toolkit::Control::DownCast(Self());
502 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
503 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
505 if(!controlImpl.mAccessibilityDoGestureSignal.Empty())
507 auto ret = std::make_pair(gestureInfo, false);
508 controlImpl.mAccessibilityDoGestureSignal.Emit(ret);
515 std::vector<Dali::Accessibility::Relation> AccessibleImpl::GetRelationSet()
517 auto control = Dali::Toolkit::Control::DownCast(Self());
519 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
520 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
522 std::vector<Dali::Accessibility::Relation> ret;
524 auto& relation = controlImpl.mAccessibilityRelations;
525 for(auto i = 0u; i < relation.size(); ++i)
527 if(relation[i].empty()) continue;
529 ret.emplace_back(Accessibility::Relation{static_cast<Accessibility::RelationType>(i), relation[i]});
535 bool AccessibleImpl::ScrollToChild(Actor child)
540 Dali::Property::Index AccessibleImpl::GetNamePropertyIndex()
542 return Actor::Property::NAME;
545 Dali::Property::Index AccessibleImpl::GetDescriptionPropertyIndex()
547 return Dali::Property::INVALID_INDEX;
550 void AccessibleImpl::SetLastPosition(Vector2 position)
552 mLastPosition = position;
555 Vector2 AccessibleImpl::GetLastPosition() const
557 return mLastPosition;
560 } // namespace Dali::Toolkit::DevelControl