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 {
38 static std::string GetLocaleText(std::string string, const char *domain = "dali-toolkit")
40 #ifdef DGETTEXT_ENABLED
41 /*TODO: currently non-localized string is used as a key for translation lookup. In case the lookup key formatting is forced
42 consider calling utility function for converting non-localized string into well-formatted key before lookup. */
43 return dgettext(domain, string.c_str());
49 AccessibleImpl::AccessibleImpl(Dali::Actor self, Dali::Accessibility::Role role, bool modal)
53 auto control = Dali::Toolkit::Control::DownCast(Self());
55 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
56 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
57 if(controlImpl.mAccessibilityRole == Dali::Accessibility::Role::UNKNOWN)
58 controlImpl.mAccessibilityRole = role;
60 Self().PropertySetSignal().Connect(&controlImpl, [this, &controlImpl](Dali::Handle& handle, Dali::Property::Index index, Dali::Property::Value value) {
61 if(this->Self() != Dali::Accessibility::Accessible::GetCurrentlyHighlightedActor())
66 if(index == DevelControl::Property::ACCESSIBILITY_NAME || (index == GetNamePropertyIndex() && !controlImpl.mAccessibilityNameSet))
68 if(controlImpl.mAccessibilityGetNameSignal.Empty())
70 Emit(Dali::Accessibility::ObjectPropertyChangeEvent::NAME);
74 if(index == DevelControl::Property::ACCESSIBILITY_DESCRIPTION || (index == GetDescriptionPropertyIndex() && !controlImpl.mAccessibilityDescriptionSet))
76 if(controlImpl.mAccessibilityGetDescriptionSignal.Empty())
78 Emit(Dali::Accessibility::ObjectPropertyChangeEvent::DESCRIPTION);
84 std::string AccessibleImpl::GetName()
86 auto control = Dali::Toolkit::Control::DownCast(Self());
88 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
89 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
92 if(!controlImpl.mAccessibilityGetNameSignal.Empty())
94 controlImpl.mAccessibilityGetNameSignal.Emit(name);
96 else if(controlImpl.mAccessibilityNameSet)
98 name = controlImpl.mAccessibilityName;
100 else if(auto raw = GetNameRaw(); !raw.empty())
106 name = Self().GetProperty<std::string>(Actor::Property::NAME);
109 if(controlImpl.mAccessibilityTranslationDomainSet)
111 return GetLocaleText(name, controlImpl.mAccessibilityTranslationDomain.c_str());
114 return GetLocaleText(name);
117 std::string AccessibleImpl::GetNameRaw()
122 std::string AccessibleImpl::GetDescription()
124 auto control = Dali::Toolkit::Control::DownCast(Self());
126 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
127 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
128 std::string description;
130 if(!controlImpl.mAccessibilityGetDescriptionSignal.Empty())
132 controlImpl.mAccessibilityGetDescriptionSignal.Emit(description);
134 else if(controlImpl.mAccessibilityDescriptionSet)
136 description = controlImpl.mAccessibilityDescription;
140 description = GetDescriptionRaw();
142 if(controlImpl.mAccessibilityTranslationDomainSet)
144 return GetLocaleText(description, controlImpl.mAccessibilityTranslationDomain.c_str());
147 return GetLocaleText(description);
150 std::string AccessibleImpl::GetDescriptionRaw()
155 Dali::Accessibility::Accessible* AccessibleImpl::GetParent()
157 return Dali::Accessibility::Accessible::Get(Self().GetParent());
160 size_t AccessibleImpl::GetChildCount()
162 return Self().GetChildCount();
165 Dali::Accessibility::Accessible* AccessibleImpl::GetChildAtIndex(size_t index)
167 return Dali::Accessibility::Accessible::Get(Self().GetChildAt(static_cast<unsigned int>(index)));
170 size_t AccessibleImpl::GetIndexInParent()
173 auto parent = s.GetParent();
174 DALI_ASSERT_ALWAYS(parent && "can't call GetIndexInParent on object without parent");
175 auto count = parent.GetChildCount();
176 for(auto i = 0u; i < count; ++i)
178 auto c = parent.GetChildAt(i);
182 DALI_ASSERT_ALWAYS(false && "object isn't child of it's parent");
183 return static_cast<size_t>(-1);
186 Dali::Accessibility::Role AccessibleImpl::GetRole()
188 return Self().GetProperty<Dali::Accessibility::Role>(Toolkit::DevelControl::Property::ACCESSIBILITY_ROLE);
191 std::string AccessibleImpl::GetLocalizedRoleName()
193 return GetLocaleText(GetRoleName());
196 Dali::Accessibility::States AccessibleImpl::CalculateStates()
198 Dali::Actor self = Self();
199 Dali::Accessibility::States s;
200 s[Dali::Accessibility::State::FOCUSABLE] = self.GetProperty<bool>(Actor::Property::KEYBOARD_FOCUSABLE);
201 s[Dali::Accessibility::State::FOCUSED] = Toolkit::KeyboardFocusManager::Get().GetCurrentFocusActor() == self;
202 if(self.GetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE).GetType() == Dali::Property::NONE)
203 s[Dali::Accessibility::State::HIGHLIGHTABLE] = false;
205 s[Dali::Accessibility::State::HIGHLIGHTABLE] = self.GetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE).Get<bool>();
206 s[Dali::Accessibility::State::HIGHLIGHTED] = GetCurrentlyHighlightedActor() == self;
207 s[Dali::Accessibility::State::ENABLED] = true;
208 s[Dali::Accessibility::State::SENSITIVE] = true;
209 s[Dali::Accessibility::State::VISIBLE] = true;
212 s[Dali::Accessibility::State::MODAL] = true;
214 s[Dali::Accessibility::State::SHOWING] = !self.GetProperty(Dali::DevelActor::Property::CULLED).Get<bool>() && self.GetCurrentProperty<bool>(Actor::Property::VISIBLE);
216 s[Dali::Accessibility::State::DEFUNCT] = !self.GetProperty(Dali::DevelActor::Property::CONNECTED_TO_SCENE).Get<bool>();
220 Dali::Accessibility::States AccessibleImpl::GetStates()
222 return CalculateStates();
225 Dali::Accessibility::Attributes AccessibleImpl::GetAttributes()
227 std::unordered_map<std::string, std::string> attribute_map;
228 auto q = Dali::Toolkit::Control::DownCast(Self());
230 q.GetProperty(Dali::Toolkit::DevelControl::Property::ACCESSIBILITY_ATTRIBUTES);
235 auto map_size = z->Count();
237 for(unsigned int i = 0; i < map_size; i++)
239 auto map_key = z->GetKeyAt(i);
240 if(map_key.type == Dali::Property::Key::STRING)
242 std::string map_value;
243 if(z->GetValue(i).Get(map_value))
245 attribute_map.emplace(std::move(map_key.stringKey),
246 std::move(map_value));
252 return attribute_map;
255 Dali::Accessibility::ComponentLayer AccessibleImpl::GetLayer()
257 return Dali::Accessibility::ComponentLayer::WINDOW;
260 Dali::Rect<> AccessibleImpl::GetExtents(Dali::Accessibility::CoordType ctype)
262 Dali::Actor self = Self();
263 Vector2 screenPosition =
264 self.GetProperty(Dali::DevelActor::Property::SCREEN_POSITION)
266 auto size = self.GetCurrentProperty<Vector3>(Actor::Property::SIZE) * self.GetCurrentProperty<Vector3>(Actor::Property::WORLD_SCALE);
267 bool positionUsesAnchorPoint =
268 self.GetProperty(Dali::DevelActor::Property::POSITION_USES_ANCHOR_POINT)
270 Vector3 anchorPointOffSet =
271 size * (positionUsesAnchorPoint ? self.GetCurrentProperty<Vector3>(Actor::Property::ANCHOR_POINT)
272 : AnchorPoint::TOP_LEFT);
273 Vector2 position = Vector2(screenPosition.x - anchorPointOffSet.x,
274 screenPosition.y - anchorPointOffSet.y);
276 return {position.x, position.y, size.x, size.y};
279 int16_t AccessibleImpl::GetMdiZOrder()
283 double AccessibleImpl::GetAlpha()
288 bool AccessibleImpl::GrabFocus()
290 return Toolkit::KeyboardFocusManager::Get().SetCurrentFocusActor(Self());
293 static Dali::Actor CreateHighlightIndicatorActor()
295 std::string focusBorderImagePath(AssetManager::GetDaliImagePath());
296 focusBorderImagePath += "/keyboard_focus.9.png";
297 // Create the default if it hasn't been set and one that's shared by all the
298 // keyboard focusable actors
299 auto actor = Toolkit::ImageView::New(focusBorderImagePath);
300 actor.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS);
301 DevelControl::AppendAccessibilityAttribute(actor, "highlight", std::string());
302 actor.SetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE, false);
307 void AccessibleImpl::ScrollToSelf()
310 auto* parent = dynamic_cast<Toolkit::DevelControl::AccessibleImpl*>(child->GetParent());
314 if (parent->IsScrollable())
316 parent->ScrollToChild(child->Self());
320 parent = dynamic_cast<Toolkit::DevelControl::AccessibleImpl*>(parent->GetParent());
324 bool AccessibleImpl::GrabHighlight()
326 Dali::Actor self = Self();
327 auto old = GetCurrentlyHighlightedActor();
329 if(!Dali::Accessibility::IsUp())
335 auto c = dynamic_cast<Dali::Accessibility::Component*>(Internal::Control::Impl::GetAccessibilityObject(old));
339 auto highlight = GetHighlightActor();
342 highlight = CreateHighlightIndicatorActor();
343 SetHighlightActor(highlight);
345 highlight.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER);
346 highlight.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::CENTER);
347 highlight.SetProperty(Actor::Property::POSITION_Z, 1.0f);
348 highlight.SetProperty(Actor::Property::POSITION, Vector2(0.0f, 0.0f));
350 // Remember the highlight actor, so that when the default is changed with
351 // SetHighlightActor(), the currently displayed highlight can still be cleared.
352 currentHighlightActor = highlight;
355 SetCurrentlyHighlightedActor(self);
356 EmitHighlighted(true);
361 bool AccessibleImpl::ClearHighlight()
363 Dali::Actor self = Self();
365 if(!Dali::Accessibility::IsUp())
367 if(GetCurrentlyHighlightedActor() == self)
369 self.Remove(currentHighlightActor.GetHandle());
370 currentHighlightActor = {};
371 SetCurrentlyHighlightedActor({});
372 EmitHighlighted(false);
378 std::string AccessibleImpl::GetActionName(size_t index)
380 if(index >= GetActionCount()) return {};
382 Self().GetTypeInfo(type);
383 DALI_ASSERT_ALWAYS(type && "no TypeInfo object");
384 return type.GetActionName(index);
387 std::string AccessibleImpl::GetLocalizedActionName(size_t index)
389 return GetLocaleText(GetActionName(index));
392 std::string AccessibleImpl::GetActionDescription(size_t index)
397 size_t AccessibleImpl::GetActionCount()
400 Self().GetTypeInfo(type);
401 DALI_ASSERT_ALWAYS(type && "no TypeInfo object");
402 return type.GetActionCount();
405 std::string AccessibleImpl::GetActionKeyBinding(size_t index)
410 bool AccessibleImpl::DoAction(size_t index)
412 std::string actionName = GetActionName(index);
413 return Self().DoAction(actionName, {});
416 bool AccessibleImpl::DoAction(const std::string& name)
418 return Self().DoAction(name, {});
421 bool AccessibleImpl::DoGesture(const Dali::Accessibility::GestureInfo& gestureInfo)
423 auto control = Dali::Toolkit::Control::DownCast(Self());
425 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
426 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
428 if(!controlImpl.mAccessibilityDoGestureSignal.Empty())
430 auto ret = std::make_pair(gestureInfo, false);
431 controlImpl.mAccessibilityDoGestureSignal.Emit(ret);
438 std::vector<Dali::Accessibility::Relation> AccessibleImpl::GetRelationSet()
440 auto control = Dali::Toolkit::Control::DownCast(Self());
442 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
443 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
445 std::vector<Dali::Accessibility::Relation> ret;
447 auto& v = controlImpl.mAccessibilityRelations;
448 for(auto i = 0u; i < v.size(); ++i)
453 ret.emplace_back(Accessibility::Relation{static_cast<Accessibility::RelationType>(i), v[i]});
459 bool AccessibleImpl::ScrollToChild(Actor child)
464 Dali::Property::Index AccessibleImpl::GetNamePropertyIndex()
466 return Actor::Property::NAME;
469 Dali::Property::Index AccessibleImpl::GetDescriptionPropertyIndex()
471 return Dali::Property::INVALID_INDEX;
474 } // namespace Dali::Toolkit::DevelControl