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 "control-accessible.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
41 static std::string GetLocaleText(std::string string, const char *domain = "dali-toolkit")
43 #ifdef DGETTEXT_ENABLED
44 /*TODO: currently non-localized string is used as a key for translation lookup. In case the lookup key formatting is forced
45 consider calling utility function for converting non-localized string into well-formatted key before lookup. */
46 return dgettext(domain, string.c_str());
52 static Dali::Actor CreateHighlightIndicatorActor()
54 std::string focusBorderImagePath(AssetManager::GetDaliImagePath());
55 focusBorderImagePath += "/keyboard_focus.9.png";
57 // Create the default if it hasn't been set and one that's shared by all the
58 // keyboard focusable actors
59 auto actor = Toolkit::ImageView::New(focusBorderImagePath);
60 actor.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS);
62 DevelControl::AppendAccessibilityAttribute(actor, "highlight", std::string());
63 actor.SetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE, false);
67 } // unnamed namespace
69 ControlAccessible::ControlAccessible(Dali::Actor self, Dali::Accessibility::Role role, bool modal)
70 : ActorAccessible(self),
73 auto control = Dali::Toolkit::Control::DownCast(Self());
75 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
76 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
77 if(controlImpl.mAccessibilityRole == Dali::Accessibility::Role::UNKNOWN)
79 controlImpl.mAccessibilityRole = role;
82 Self().PropertySetSignal().Connect(&controlImpl, [this, &controlImpl](Dali::Handle& handle, Dali::Property::Index index, Dali::Property::Value value) {
83 if(this->Self() != Dali::Accessibility::Accessible::GetCurrentlyHighlightedActor())
88 if(index == DevelControl::Property::ACCESSIBILITY_NAME || (index == GetNamePropertyIndex() && controlImpl.mAccessibilityName.empty()))
90 if(controlImpl.mAccessibilityGetNameSignal.Empty())
92 Emit(Dali::Accessibility::ObjectPropertyChangeEvent::NAME);
96 if(index == DevelControl::Property::ACCESSIBILITY_DESCRIPTION || (index == GetDescriptionPropertyIndex() && controlImpl.mAccessibilityDescription.empty()))
98 if(controlImpl.mAccessibilityGetDescriptionSignal.Empty())
100 Emit(Dali::Accessibility::ObjectPropertyChangeEvent::DESCRIPTION);
106 std::string ControlAccessible::GetName() const
108 auto control = Dali::Toolkit::Control::DownCast(Self());
110 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
111 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
114 if(!controlImpl.mAccessibilityGetNameSignal.Empty())
116 controlImpl.mAccessibilityGetNameSignal.Emit(name);
118 else if(!controlImpl.mAccessibilityName.empty())
120 name = controlImpl.mAccessibilityName;
122 else if(auto raw = GetNameRaw(); !raw.empty())
128 name = Self().GetProperty<std::string>(Actor::Property::NAME);
131 if(!controlImpl.mAccessibilityTranslationDomain.empty())
133 return GetLocaleText(name, controlImpl.mAccessibilityTranslationDomain.c_str());
136 return GetLocaleText(name);
139 std::string ControlAccessible::GetNameRaw() const
144 std::string ControlAccessible::GetDescription() const
146 auto control = Dali::Toolkit::Control::DownCast(Self());
148 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
149 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
150 std::string description;
152 if(!controlImpl.mAccessibilityGetDescriptionSignal.Empty())
154 controlImpl.mAccessibilityGetDescriptionSignal.Emit(description);
156 else if(!controlImpl.mAccessibilityDescription.empty())
158 description = controlImpl.mAccessibilityDescription;
162 description = GetDescriptionRaw();
165 if(!controlImpl.mAccessibilityTranslationDomain.empty())
167 return GetLocaleText(description, controlImpl.mAccessibilityTranslationDomain.c_str());
170 return GetLocaleText(description);
173 std::string ControlAccessible::GetDescriptionRaw() const
178 Dali::Accessibility::Role ControlAccessible::GetRole() const
180 return Self().GetProperty<Dali::Accessibility::Role>(Toolkit::DevelControl::Property::ACCESSIBILITY_ROLE);
183 std::string ControlAccessible::GetLocalizedRoleName() const
185 return GetLocaleText(GetRoleName());
188 bool ControlAccessible::IsShowing()
190 Dali::Actor self = Self();
191 if(!self.GetProperty<bool>(Actor::Property::VISIBLE) || self.GetProperty<Vector4>(Actor::Property::WORLD_COLOR).a == 0 || self.GetProperty<bool>(Dali::DevelActor::Property::CULLED))
197 auto* parent = dynamic_cast<Toolkit::DevelControl::ControlAccessible*>(child->GetParent());
203 auto childExtent = child->GetExtents(Dali::Accessibility::CoordinateType::WINDOW);
206 auto control = Dali::Toolkit::Control::DownCast(parent->Self());
207 if(!control.GetProperty<bool>(Actor::Property::VISIBLE))
211 auto clipMode = control.GetProperty(Actor::Property::CLIPPING_MODE).Get<bool>();
212 auto parentExtent = parent->GetExtents(Dali::Accessibility::CoordinateType::WINDOW);
213 if ((clipMode != ClippingMode::DISABLED) && !parentExtent.Intersects(childExtent))
217 parent = dynamic_cast<Toolkit::DevelControl::ControlAccessible*>(parent->GetParent());
223 Dali::Accessibility::States ControlAccessible::CalculateStates()
225 Dali::Actor self = Self();
226 Dali::Accessibility::States state;
227 state[Dali::Accessibility::State::FOCUSABLE] = self.GetProperty<bool>(Actor::Property::KEYBOARD_FOCUSABLE);
228 state[Dali::Accessibility::State::FOCUSED] = Toolkit::KeyboardFocusManager::Get().GetCurrentFocusActor() == self;
230 if(self.GetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE).GetType() == Dali::Property::NONE)
232 state[Dali::Accessibility::State::HIGHLIGHTABLE] = false;
236 state[Dali::Accessibility::State::HIGHLIGHTABLE] = self.GetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE).Get<bool>();
239 state[Dali::Accessibility::State::HIGHLIGHTED] = GetCurrentlyHighlightedActor() == self;
240 state[Dali::Accessibility::State::ENABLED] = true;
241 state[Dali::Accessibility::State::SENSITIVE] = true;
242 state[Dali::Accessibility::State::VISIBLE] = self.GetProperty<bool>(Actor::Property::VISIBLE);
246 state[Dali::Accessibility::State::MODAL] = true;
248 state[Dali::Accessibility::State::SHOWING] = IsShowing();
249 state[Dali::Accessibility::State::DEFUNCT] = !self.GetProperty(Dali::DevelActor::Property::CONNECTED_TO_SCENE).Get<bool>();
253 Dali::Accessibility::States ControlAccessible::GetStates()
255 return CalculateStates();
258 Dali::Accessibility::Attributes ControlAccessible::GetAttributes() const
260 std::unordered_map<std::string, std::string> attributeMap;
261 auto control = Dali::Toolkit::Control::DownCast(Self());
262 auto attribute = control.GetProperty(Dali::Toolkit::DevelControl::Property::ACCESSIBILITY_ATTRIBUTES);
263 auto map = attribute.GetMap();
267 auto mapSize = map->Count();
269 for(unsigned int i = 0; i < mapSize; i++)
271 auto mapKey = map->GetKeyAt(i);
272 if(mapKey.type == Dali::Property::Key::STRING)
274 std::string mapValue;
275 if(map->GetValue(i).Get(mapValue))
277 attributeMap.emplace(std::move(mapKey.stringKey), std::move(mapValue));
286 bool ControlAccessible::IsHidden() const
288 auto control = Dali::Toolkit::Control::DownCast(Self());
290 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
291 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
293 return controlImpl.mAccessibilityHidden;
296 bool ControlAccessible::GrabFocus()
298 return Toolkit::KeyboardFocusManager::Get().SetCurrentFocusActor(Self());
301 void ControlAccessible::ScrollToSelf()
304 auto* parent = dynamic_cast<Toolkit::DevelControl::ControlAccessible*>(child->GetParent());
308 if (parent->IsScrollable())
310 parent->ScrollToChild(child->Self());
313 parent = dynamic_cast<Toolkit::DevelControl::ControlAccessible*>(parent->GetParent());
317 void ControlAccessible::RegisterPositionPropertyNotification()
319 auto control = Dali::Toolkit::Control::DownCast(Self());
320 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
321 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
322 controlImpl.RegisterAccessibilityPositionPropertyNotification();
325 void ControlAccessible::UnregisterPositionPropertyNotification()
327 auto control = Dali::Toolkit::Control::DownCast(Self());
328 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
329 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
330 controlImpl.UnregisterAccessibilityPositionPropertyNotification();
333 bool ControlAccessible::GrabHighlight()
335 Dali::Actor self = Self();
336 auto oldHighlightedActor = GetCurrentlyHighlightedActor();
338 if(!Dali::Accessibility::IsUp())
343 if(self == oldHighlightedActor)
348 // Clear the old highlight.
349 if(oldHighlightedActor)
351 auto oldHighlightedObject = Dali::Accessibility::Component::DownCast(Accessible::Get(oldHighlightedActor));
352 if(oldHighlightedObject)
354 oldHighlightedObject->ClearHighlight();
358 auto highlight = GetHighlightActor();
361 highlight = CreateHighlightIndicatorActor();
362 SetHighlightActor(highlight);
365 highlight.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_LEFT);
366 highlight.SetProperty(Actor::Property::POSITION_Z, 1.0f);
367 highlight.SetProperty(Actor::Property::POSITION, Vector2(0.0f, 0.0f));
369 // Need to set resize policy again, to update SIZE property which is set by
370 // NUIViewAccessible. The highlight could move from NUIViewAccessible to
371 // ControlAccessible. In this case, highlight has incorrect size.
372 highlight.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS);
374 // Remember the highlight actor, so that when the default is changed with
375 // SetHighlightActor(), the currently displayed highlight can still be cleared.
376 mCurrentHighlightActor = highlight;
379 SetCurrentlyHighlightedActor(self);
380 EmitHighlighted(true);
381 RegisterPositionPropertyNotification();
386 bool ControlAccessible::ClearHighlight()
388 Dali::Actor self = Self();
390 if(!Dali::Accessibility::IsUp())
395 if(GetCurrentlyHighlightedActor() == self)
397 UnregisterPositionPropertyNotification();
398 self.Remove(mCurrentHighlightActor.GetHandle());
399 mCurrentHighlightActor = {};
400 SetCurrentlyHighlightedActor({});
401 EmitHighlighted(false);
407 std::string ControlAccessible::GetActionName(size_t index) const
409 if(index >= GetActionCount())
415 Self().GetTypeInfo(type);
416 DALI_ASSERT_ALWAYS(type && "no TypeInfo object");
417 return type.GetActionName(index);
420 std::string ControlAccessible::GetLocalizedActionName(size_t index) const
422 return GetLocaleText(GetActionName(index));
425 std::string ControlAccessible::GetActionDescription(size_t index) const
430 size_t ControlAccessible::GetActionCount() const
433 Self().GetTypeInfo(type);
434 DALI_ASSERT_ALWAYS(type && "no TypeInfo object");
435 return type.GetActionCount();
438 std::string ControlAccessible::GetActionKeyBinding(size_t index) const
443 bool ControlAccessible::DoAction(size_t index)
445 std::string actionName = GetActionName(index);
446 return Self().DoAction(actionName, {});
449 bool ControlAccessible::DoAction(const std::string& name)
451 return Self().DoAction(name, {});
454 bool ControlAccessible::DoGesture(const Dali::Accessibility::GestureInfo& gestureInfo)
456 auto control = Dali::Toolkit::Control::DownCast(Self());
458 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
459 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
461 if(!controlImpl.mAccessibilityDoGestureSignal.Empty())
463 auto ret = std::make_pair(gestureInfo, false);
464 controlImpl.mAccessibilityDoGestureSignal.Emit(ret);
471 std::vector<Dali::Accessibility::Relation> ControlAccessible::GetRelationSet()
473 auto control = Dali::Toolkit::Control::DownCast(Self());
475 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
476 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
478 std::vector<Dali::Accessibility::Relation> ret;
480 for(auto& relation : controlImpl.mAccessibilityRelations)
482 auto& targets = relation.second;
484 ret.emplace_back(Accessibility::Relation{relation.first, {}});
486 // Map every Accessible* to its Address
487 std::transform(targets.begin(), targets.end(), std::back_inserter(ret.back().targets), [](auto* x) {
488 return x->GetAddress();
495 bool ControlAccessible::ScrollToChild(Actor child)
500 Dali::Property::Index ControlAccessible::GetNamePropertyIndex()
502 return Actor::Property::NAME;
505 Dali::Property::Index ControlAccessible::GetDescriptionPropertyIndex()
507 return Dali::Property::INVALID_INDEX;
510 void ControlAccessible::SetLastPosition(Vector2 position)
512 mLastPosition = position;
515 Vector2 ControlAccessible::GetLastPosition() const
517 return mLastPosition;
520 } // namespace Dali::Toolkit::DevelControl