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 Dali::Accessibility::States AccessibleImpl::CalculateStates()
205 Dali::Actor self = Self();
206 Dali::Accessibility::States state;
207 state[Dali::Accessibility::State::FOCUSABLE] = self.GetProperty<bool>(Actor::Property::KEYBOARD_FOCUSABLE);
208 state[Dali::Accessibility::State::FOCUSED] = Toolkit::KeyboardFocusManager::Get().GetCurrentFocusActor() == self;
210 if(self.GetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE).GetType() == Dali::Property::NONE)
212 state[Dali::Accessibility::State::HIGHLIGHTABLE] = false;
216 state[Dali::Accessibility::State::HIGHLIGHTABLE] = self.GetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE).Get<bool>();
219 state[Dali::Accessibility::State::HIGHLIGHTED] = GetCurrentlyHighlightedActor() == self;
220 state[Dali::Accessibility::State::ENABLED] = true;
221 state[Dali::Accessibility::State::SENSITIVE] = true;
222 state[Dali::Accessibility::State::VISIBLE] = true;
226 state[Dali::Accessibility::State::MODAL] = true;
228 state[Dali::Accessibility::State::SHOWING] = !self.GetProperty(Dali::DevelActor::Property::CULLED).Get<bool>() && self.GetCurrentProperty<bool>(Actor::Property::VISIBLE);
230 state[Dali::Accessibility::State::DEFUNCT] = !self.GetProperty(Dali::DevelActor::Property::CONNECTED_TO_SCENE).Get<bool>();
234 Dali::Accessibility::States AccessibleImpl::GetStates()
236 return CalculateStates();
239 Dali::Accessibility::Attributes AccessibleImpl::GetAttributes()
241 std::unordered_map<std::string, std::string> attributeMap;
242 auto control = Dali::Toolkit::Control::DownCast(Self());
243 auto attribute = control.GetProperty(Dali::Toolkit::DevelControl::Property::ACCESSIBILITY_ATTRIBUTES);
244 auto map = attribute.GetMap();
248 auto mapSize = map->Count();
250 for(unsigned int i = 0; i < mapSize; i++)
252 auto mapKey = map->GetKeyAt(i);
253 if(mapKey.type == Dali::Property::Key::STRING)
255 std::string mapValue;
256 if(map->GetValue(i).Get(mapValue))
258 attributeMap.emplace(std::move(mapKey.stringKey), std::move(mapValue));
267 Dali::Accessibility::ComponentLayer AccessibleImpl::GetLayer()
269 return Dali::Accessibility::ComponentLayer::WINDOW;
272 Dali::Rect<> AccessibleImpl::GetExtents(Dali::Accessibility::CoordinateType type)
274 Dali::Actor self = Self();
276 Vector2 screenPosition = self.GetProperty(Dali::DevelActor::Property::SCREEN_POSITION).Get<Vector2>();
277 auto size = self.GetCurrentProperty<Vector3>(Actor::Property::SIZE) * self.GetCurrentProperty<Vector3>(Actor::Property::WORLD_SCALE);
278 bool positionUsesAnchorPoint = self.GetProperty(Dali::DevelActor::Property::POSITION_USES_ANCHOR_POINT).Get<bool>();
279 Vector3 anchorPointOffSet = size * (positionUsesAnchorPoint ? self.GetCurrentProperty<Vector3>(Actor::Property::ANCHOR_POINT) : AnchorPoint::TOP_LEFT);
280 Vector2 position = Vector2((screenPosition.x - anchorPointOffSet.x), (screenPosition.y - anchorPointOffSet.y));
282 if(type == Dali::Accessibility::CoordinateType::WINDOW)
284 return {position.x, position.y, size.x, size.y};
286 else // Dali::Accessibility::CoordinateType::SCREEN
288 auto window = Dali::DevelWindow::Get(self);
289 auto windowPosition = window.GetPosition();
290 return {position.x + windowPosition.GetX(), position.y + windowPosition.GetY(), size.x, size.y};
294 int16_t AccessibleImpl::GetMdiZOrder()
298 double AccessibleImpl::GetAlpha()
303 bool AccessibleImpl::GrabFocus()
305 return Toolkit::KeyboardFocusManager::Get().SetCurrentFocusActor(Self());
308 static Dali::Actor CreateHighlightIndicatorActor()
310 std::string focusBorderImagePath(AssetManager::GetDaliImagePath());
311 focusBorderImagePath += "/keyboard_focus.9.png";
313 // Create the default if it hasn't been set and one that's shared by all the
314 // keyboard focusable actors
315 auto actor = Toolkit::ImageView::New(focusBorderImagePath);
316 actor.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS);
318 DevelControl::AppendAccessibilityAttribute(actor, "highlight", std::string());
319 actor.SetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE, false);
324 void AccessibleImpl::ScrollToSelf()
327 auto* parent = dynamic_cast<Toolkit::DevelControl::AccessibleImpl*>(child->GetParent());
331 if (parent->IsScrollable())
333 parent->ScrollToChild(child->Self());
337 parent = dynamic_cast<Toolkit::DevelControl::AccessibleImpl*>(parent->GetParent());
341 void AccessibleImpl::RegisterPositionPropertyNotification()
343 auto control = Dali::Toolkit::Control::DownCast(Self());
344 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
345 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
346 controlImpl.RegisterAccessibilityPositionPropertyNotification();
349 void AccessibleImpl::UnregisterPositionPropertyNotification()
351 auto control = Dali::Toolkit::Control::DownCast(Self());
352 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
353 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
354 controlImpl.UnregisterAccessibilityPositionPropertyNotification();
357 bool AccessibleImpl::GrabHighlight()
359 Dali::Actor self = Self();
360 auto oldHighlightedActor = GetCurrentlyHighlightedActor();
362 if(!Dali::Accessibility::IsUp())
367 if(self == oldHighlightedActor)
372 // Clear the old highlight.
373 if(oldHighlightedActor)
375 auto oldHighlightObject = dynamic_cast<Dali::Accessibility::Component*>(Internal::Control::Impl::GetAccessibilityObject(oldHighlightedActor));
376 if(oldHighlightObject)
378 oldHighlightObject->ClearHighlight();
382 auto highlight = GetHighlightActor();
385 highlight = CreateHighlightIndicatorActor();
386 SetHighlightActor(highlight);
389 highlight.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_LEFT);
390 highlight.SetProperty(Actor::Property::POSITION_Z, 1.0f);
391 highlight.SetProperty(Actor::Property::POSITION, Vector2(0.0f, 0.0f));
393 // Need to set resize policy again, to update SIZE property which is set by
394 // AccessibleImpl_NUI. The highlight could move from AccessibleImpl_NUI to
395 // AccessibleImpl. In this case, highlight has incorrect size.
396 highlight.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS);
398 // Remember the highlight actor, so that when the default is changed with
399 // SetHighlightActor(), the currently displayed highlight can still be cleared.
400 mCurrentHighlightActor = highlight;
403 SetCurrentlyHighlightedActor(self);
404 EmitHighlighted(true);
405 RegisterPositionPropertyNotification();
410 bool AccessibleImpl::ClearHighlight()
412 Dali::Actor self = Self();
414 if(!Dali::Accessibility::IsUp())
419 if(GetCurrentlyHighlightedActor() == self)
421 UnregisterPositionPropertyNotification();
422 self.Remove(mCurrentHighlightActor.GetHandle());
423 mCurrentHighlightActor = {};
424 SetCurrentlyHighlightedActor({});
425 EmitHighlighted(false);
431 std::string AccessibleImpl::GetActionName(size_t index)
433 if(index >= GetActionCount())
439 Self().GetTypeInfo(type);
440 DALI_ASSERT_ALWAYS(type && "no TypeInfo object");
441 return type.GetActionName(index);
444 std::string AccessibleImpl::GetLocalizedActionName(size_t index)
446 return GetLocaleText(GetActionName(index));
449 std::string AccessibleImpl::GetActionDescription(size_t index)
454 size_t AccessibleImpl::GetActionCount()
457 Self().GetTypeInfo(type);
458 DALI_ASSERT_ALWAYS(type && "no TypeInfo object");
459 return type.GetActionCount();
462 std::string AccessibleImpl::GetActionKeyBinding(size_t index)
467 bool AccessibleImpl::DoAction(size_t index)
469 std::string actionName = GetActionName(index);
470 return Self().DoAction(actionName, {});
473 bool AccessibleImpl::DoAction(const std::string& name)
475 return Self().DoAction(name, {});
478 bool AccessibleImpl::DoGesture(const Dali::Accessibility::GestureInfo& gestureInfo)
480 auto control = Dali::Toolkit::Control::DownCast(Self());
482 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
483 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
485 if(!controlImpl.mAccessibilityDoGestureSignal.Empty())
487 auto ret = std::make_pair(gestureInfo, false);
488 controlImpl.mAccessibilityDoGestureSignal.Emit(ret);
495 std::vector<Dali::Accessibility::Relation> AccessibleImpl::GetRelationSet()
497 auto control = Dali::Toolkit::Control::DownCast(Self());
499 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
500 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
502 std::vector<Dali::Accessibility::Relation> ret;
504 auto& relation = controlImpl.mAccessibilityRelations;
505 for(auto i = 0u; i < relation.size(); ++i)
507 if(relation[i].empty()) continue;
509 ret.emplace_back(Accessibility::Relation{static_cast<Accessibility::RelationType>(i), relation[i]});
515 bool AccessibleImpl::ScrollToChild(Actor child)
520 Dali::Property::Index AccessibleImpl::GetNamePropertyIndex()
522 return Actor::Property::NAME;
525 Dali::Property::Index AccessibleImpl::GetDescriptionPropertyIndex()
527 return Dali::Property::INVALID_INDEX;
530 void AccessibleImpl::SetLastPosition(Vector2 position)
532 mLastPosition = position;
535 Vector2 AccessibleImpl::GetLastPosition() const
537 return mLastPosition;
540 } // namespace Dali::Toolkit::DevelControl