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>
27 #include <dali/devel-api/adaptor-framework/window-devel.h>
30 #include <dali-toolkit/devel-api/asset-manager/asset-manager.h>
31 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
32 #include <dali-toolkit/public-api/controls/control-impl.h>
33 #include <dali-toolkit/public-api/controls/control.h>
34 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
35 #include <dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h>
37 namespace Dali::Toolkit::DevelControl
40 static std::string GetLocaleText(std::string string, const char *domain = "dali-toolkit")
42 #ifdef DGETTEXT_ENABLED
43 /*TODO: currently non-localized string is used as a key for translation lookup. In case the lookup key formatting is forced
44 consider calling utility function for converting non-localized string into well-formatted key before lookup. */
45 return dgettext(domain, string.c_str());
51 AccessibleImpl::AccessibleImpl(Dali::Actor self, Dali::Accessibility::Role role, bool modal)
55 auto control = Dali::Toolkit::Control::DownCast(Self());
57 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
58 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
59 if(controlImpl.mAccessibilityRole == Dali::Accessibility::Role::UNKNOWN)
61 controlImpl.mAccessibilityRole = role;
64 Self().PropertySetSignal().Connect(&controlImpl, [this, &controlImpl](Dali::Handle& handle, Dali::Property::Index index, Dali::Property::Value value) {
65 if(this->Self() != Dali::Accessibility::Accessible::GetCurrentlyHighlightedActor())
70 if(index == DevelControl::Property::ACCESSIBILITY_NAME || (index == GetNamePropertyIndex() && !controlImpl.mAccessibilityNameSet))
72 if(controlImpl.mAccessibilityGetNameSignal.Empty())
74 Emit(Dali::Accessibility::ObjectPropertyChangeEvent::NAME);
78 if(index == DevelControl::Property::ACCESSIBILITY_DESCRIPTION || (index == GetDescriptionPropertyIndex() && !controlImpl.mAccessibilityDescriptionSet))
80 if(controlImpl.mAccessibilityGetDescriptionSignal.Empty())
82 Emit(Dali::Accessibility::ObjectPropertyChangeEvent::DESCRIPTION);
88 std::string AccessibleImpl::GetName()
90 auto control = Dali::Toolkit::Control::DownCast(Self());
92 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
93 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
96 if(!controlImpl.mAccessibilityGetNameSignal.Empty())
98 controlImpl.mAccessibilityGetNameSignal.Emit(name);
100 else if(controlImpl.mAccessibilityNameSet)
102 name = controlImpl.mAccessibilityName;
104 else if(auto raw = GetNameRaw(); !raw.empty())
110 name = Self().GetProperty<std::string>(Actor::Property::NAME);
113 if(controlImpl.mAccessibilityTranslationDomainSet)
115 return GetLocaleText(name, controlImpl.mAccessibilityTranslationDomain.c_str());
118 return GetLocaleText(name);
121 std::string AccessibleImpl::GetNameRaw()
126 std::string AccessibleImpl::GetDescription()
128 auto control = Dali::Toolkit::Control::DownCast(Self());
130 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
131 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
132 std::string description;
134 if(!controlImpl.mAccessibilityGetDescriptionSignal.Empty())
136 controlImpl.mAccessibilityGetDescriptionSignal.Emit(description);
138 else if(controlImpl.mAccessibilityDescriptionSet)
140 description = controlImpl.mAccessibilityDescription;
144 description = GetDescriptionRaw();
146 if(controlImpl.mAccessibilityTranslationDomainSet)
148 return GetLocaleText(description, controlImpl.mAccessibilityTranslationDomain.c_str());
151 return GetLocaleText(description);
154 std::string AccessibleImpl::GetDescriptionRaw()
159 Dali::Accessibility::Accessible* AccessibleImpl::GetParent()
161 return Dali::Accessibility::Accessible::Get(Self().GetParent());
164 size_t AccessibleImpl::GetChildCount()
166 return Self().GetChildCount();
169 Dali::Accessibility::Accessible* AccessibleImpl::GetChildAtIndex(size_t index)
171 return Dali::Accessibility::Accessible::Get(Self().GetChildAt(static_cast<unsigned int>(index)));
174 size_t AccessibleImpl::GetIndexInParent()
177 auto parent = self.GetParent();
178 DALI_ASSERT_ALWAYS(parent && "can't call GetIndexInParent on object without parent");
180 auto count = parent.GetChildCount();
181 for(auto i = 0u; i < count; ++i)
183 auto child = parent.GetChildAt(i);
189 DALI_ASSERT_ALWAYS(false && "object isn't child of it's parent");
190 return static_cast<size_t>(-1);
193 Dali::Accessibility::Role AccessibleImpl::GetRole()
195 return Self().GetProperty<Dali::Accessibility::Role>(Toolkit::DevelControl::Property::ACCESSIBILITY_ROLE);
198 std::string AccessibleImpl::GetLocalizedRoleName()
200 return GetLocaleText(GetRoleName());
203 bool AccessibleImpl::IsShowing()
205 Dali::Actor self = Self();
206 if(self.GetProperty(Dali::DevelActor::Property::CULLED).Get<bool>() || !self.GetCurrentProperty<bool>(Actor::Property::VISIBLE))
212 auto* parent = dynamic_cast<Toolkit::DevelControl::AccessibleImpl*>(child->GetParent());
218 auto childExtent = child->GetExtents(Dali::Accessibility::CoordinateType::WINDOW);
221 auto control = Dali::Toolkit::Control::DownCast(parent->Self());
222 auto clipMode = control.GetProperty(Actor::Property::CLIPPING_MODE).Get<bool>();
223 auto parentExtent = parent->GetExtents(Dali::Accessibility::CoordinateType::WINDOW);
224 if ((clipMode != ClippingMode::DISABLED) && !parentExtent.Intersects(childExtent))
228 parent = dynamic_cast<Toolkit::DevelControl::AccessibleImpl*>(parent->GetParent());
234 Dali::Accessibility::States AccessibleImpl::CalculateStates()
236 Dali::Actor self = Self();
237 Dali::Accessibility::States state;
238 state[Dali::Accessibility::State::FOCUSABLE] = self.GetProperty<bool>(Actor::Property::KEYBOARD_FOCUSABLE);
239 state[Dali::Accessibility::State::FOCUSED] = Toolkit::KeyboardFocusManager::Get().GetCurrentFocusActor() == self;
241 if(self.GetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE).GetType() == Dali::Property::NONE)
243 state[Dali::Accessibility::State::HIGHLIGHTABLE] = false;
247 state[Dali::Accessibility::State::HIGHLIGHTABLE] = self.GetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE).Get<bool>();
250 state[Dali::Accessibility::State::HIGHLIGHTED] = GetCurrentlyHighlightedActor() == self;
251 state[Dali::Accessibility::State::ENABLED] = true;
252 state[Dali::Accessibility::State::SENSITIVE] = true;
253 state[Dali::Accessibility::State::VISIBLE] = true;
257 state[Dali::Accessibility::State::MODAL] = true;
259 state[Dali::Accessibility::State::SHOWING] = IsShowing();
260 state[Dali::Accessibility::State::DEFUNCT] = !self.GetProperty(Dali::DevelActor::Property::CONNECTED_TO_SCENE).Get<bool>();
264 Dali::Accessibility::States AccessibleImpl::GetStates()
266 return CalculateStates();
269 Dali::Accessibility::Attributes AccessibleImpl::GetAttributes()
271 std::unordered_map<std::string, std::string> attributeMap;
272 auto control = Dali::Toolkit::Control::DownCast(Self());
273 auto attribute = control.GetProperty(Dali::Toolkit::DevelControl::Property::ACCESSIBILITY_ATTRIBUTES);
274 auto map = attribute.GetMap();
278 auto mapSize = map->Count();
280 for(unsigned int i = 0; i < mapSize; i++)
282 auto mapKey = map->GetKeyAt(i);
283 if(mapKey.type == Dali::Property::Key::STRING)
285 std::string mapValue;
286 if(map->GetValue(i).Get(mapValue))
288 attributeMap.emplace(std::move(mapKey.stringKey), std::move(mapValue));
297 Dali::Accessibility::ComponentLayer AccessibleImpl::GetLayer()
299 return Dali::Accessibility::ComponentLayer::WINDOW;
302 Dali::Rect<> AccessibleImpl::GetExtents(Dali::Accessibility::CoordinateType type)
304 Dali::Actor self = Self();
306 Vector2 screenPosition = self.GetProperty(Dali::DevelActor::Property::SCREEN_POSITION).Get<Vector2>();
307 auto size = self.GetCurrentProperty<Vector3>(Actor::Property::SIZE) * self.GetCurrentProperty<Vector3>(Actor::Property::WORLD_SCALE);
308 bool positionUsesAnchorPoint = self.GetProperty(Dali::DevelActor::Property::POSITION_USES_ANCHOR_POINT).Get<bool>();
309 Vector3 anchorPointOffSet = size * (positionUsesAnchorPoint ? self.GetCurrentProperty<Vector3>(Actor::Property::ANCHOR_POINT) : AnchorPoint::TOP_LEFT);
310 Vector2 position = Vector2((screenPosition.x - anchorPointOffSet.x), (screenPosition.y - anchorPointOffSet.y));
312 if(type == Dali::Accessibility::CoordinateType::WINDOW)
314 return {position.x, position.y, size.x, size.y};
316 else // Dali::Accessibility::CoordinateType::SCREEN
318 auto window = Dali::DevelWindow::Get(self);
319 auto windowPosition = window.GetPosition();
320 return {position.x + windowPosition.GetX(), position.y + windowPosition.GetY(), size.x, size.y};
324 int16_t AccessibleImpl::GetMdiZOrder()
328 double AccessibleImpl::GetAlpha()
333 bool AccessibleImpl::GrabFocus()
335 return Toolkit::KeyboardFocusManager::Get().SetCurrentFocusActor(Self());
338 static Dali::Actor CreateHighlightIndicatorActor()
340 std::string focusBorderImagePath(AssetManager::GetDaliImagePath());
341 focusBorderImagePath += "/keyboard_focus.9.png";
343 // Create the default if it hasn't been set and one that's shared by all the
344 // keyboard focusable actors
345 auto actor = Toolkit::ImageView::New(focusBorderImagePath);
346 actor.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS);
348 DevelControl::AppendAccessibilityAttribute(actor, "highlight", std::string());
349 actor.SetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE, false);
354 void AccessibleImpl::ScrollToSelf()
357 auto* parent = dynamic_cast<Toolkit::DevelControl::AccessibleImpl*>(child->GetParent());
361 if (parent->IsScrollable())
363 parent->ScrollToChild(child->Self());
366 parent = dynamic_cast<Toolkit::DevelControl::AccessibleImpl*>(parent->GetParent());
370 void AccessibleImpl::RegisterPositionPropertyNotification()
372 auto control = Dali::Toolkit::Control::DownCast(Self());
373 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
374 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
375 controlImpl.RegisterAccessibilityPositionPropertyNotification();
378 void AccessibleImpl::UnregisterPositionPropertyNotification()
380 auto control = Dali::Toolkit::Control::DownCast(Self());
381 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
382 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
383 controlImpl.UnregisterAccessibilityPositionPropertyNotification();
386 bool AccessibleImpl::GrabHighlight()
388 Dali::Actor self = Self();
389 auto oldHighlightedActor = GetCurrentlyHighlightedActor();
391 if(!Dali::Accessibility::IsUp())
396 if(self == oldHighlightedActor)
401 // Clear the old highlight.
402 if(oldHighlightedActor)
404 auto oldHighlightObject = dynamic_cast<Dali::Accessibility::Component*>(Internal::Control::Impl::GetAccessibilityObject(oldHighlightedActor));
405 if(oldHighlightObject)
407 oldHighlightObject->ClearHighlight();
411 auto highlight = GetHighlightActor();
414 highlight = CreateHighlightIndicatorActor();
415 SetHighlightActor(highlight);
418 highlight.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_LEFT);
419 highlight.SetProperty(Actor::Property::POSITION_Z, 1.0f);
420 highlight.SetProperty(Actor::Property::POSITION, Vector2(0.0f, 0.0f));
422 // Need to set resize policy again, to update SIZE property which is set by
423 // AccessibleImpl_NUI. The highlight could move from AccessibleImpl_NUI to
424 // AccessibleImpl. In this case, highlight has incorrect size.
425 highlight.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS);
427 // Remember the highlight actor, so that when the default is changed with
428 // SetHighlightActor(), the currently displayed highlight can still be cleared.
429 mCurrentHighlightActor = highlight;
432 SetCurrentlyHighlightedActor(self);
433 EmitHighlighted(true);
434 RegisterPositionPropertyNotification();
439 bool AccessibleImpl::ClearHighlight()
441 Dali::Actor self = Self();
443 if(!Dali::Accessibility::IsUp())
448 if(GetCurrentlyHighlightedActor() == self)
450 UnregisterPositionPropertyNotification();
451 self.Remove(mCurrentHighlightActor.GetHandle());
452 mCurrentHighlightActor = {};
453 SetCurrentlyHighlightedActor({});
454 EmitHighlighted(false);
460 std::string AccessibleImpl::GetActionName(size_t index)
462 if(index >= GetActionCount())
468 Self().GetTypeInfo(type);
469 DALI_ASSERT_ALWAYS(type && "no TypeInfo object");
470 return type.GetActionName(index);
473 std::string AccessibleImpl::GetLocalizedActionName(size_t index)
475 return GetLocaleText(GetActionName(index));
478 std::string AccessibleImpl::GetActionDescription(size_t index)
483 size_t AccessibleImpl::GetActionCount()
486 Self().GetTypeInfo(type);
487 DALI_ASSERT_ALWAYS(type && "no TypeInfo object");
488 return type.GetActionCount();
491 std::string AccessibleImpl::GetActionKeyBinding(size_t index)
496 bool AccessibleImpl::DoAction(size_t index)
498 std::string actionName = GetActionName(index);
499 return Self().DoAction(actionName, {});
502 bool AccessibleImpl::DoAction(const std::string& name)
504 return Self().DoAction(name, {});
507 bool AccessibleImpl::DoGesture(const Dali::Accessibility::GestureInfo& gestureInfo)
509 auto control = Dali::Toolkit::Control::DownCast(Self());
511 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
512 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
514 if(!controlImpl.mAccessibilityDoGestureSignal.Empty())
516 auto ret = std::make_pair(gestureInfo, false);
517 controlImpl.mAccessibilityDoGestureSignal.Emit(ret);
524 std::vector<Dali::Accessibility::Relation> AccessibleImpl::GetRelationSet()
526 auto control = Dali::Toolkit::Control::DownCast(Self());
528 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
529 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
531 std::vector<Dali::Accessibility::Relation> ret;
533 auto& relation = controlImpl.mAccessibilityRelations;
534 for(auto i = 0u; i < relation.size(); ++i)
536 if(relation[i].empty()) continue;
538 ret.emplace_back(Accessibility::Relation{static_cast<Accessibility::RelationType>(i), relation[i]});
544 Dali::Actor AccessibleImpl::GetInternalActor()
546 return Dali::Actor{};
549 bool AccessibleImpl::ScrollToChild(Actor child)
554 Dali::Property::Index AccessibleImpl::GetNamePropertyIndex()
556 return Actor::Property::NAME;
559 Dali::Property::Index AccessibleImpl::GetDescriptionPropertyIndex()
561 return Dali::Property::INVALID_INDEX;
564 void AccessibleImpl::SetLastPosition(Vector2 position)
566 mLastPosition = position;
569 Vector2 AccessibleImpl::GetLastPosition() const
571 return mLastPosition;
574 } // namespace Dali::Toolkit::DevelControl