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 #include <dali/devel-api/actors/actor-devel.h>
25 #include <dali-toolkit/devel-api/asset-manager/asset-manager.h>
26 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
27 #include <dali-toolkit/public-api/controls/control-impl.h>
28 #include <dali-toolkit/public-api/controls/control.h>
29 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
30 #include <dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h>
32 namespace Dali::Toolkit::DevelControl {
34 AccessibleImpl::AccessibleImpl(Dali::Actor self, Dali::Accessibility::Role role, bool modal)
38 auto control = Dali::Toolkit::Control::DownCast(Self());
40 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
41 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
42 if(controlImpl.mAccessibilityRole == Dali::Accessibility::Role::UNKNOWN)
43 controlImpl.mAccessibilityRole = role;
45 Self().PropertySetSignal().Connect(&controlImpl, [this, &controlImpl](Dali::Handle& handle, Dali::Property::Index index, Dali::Property::Value value) {
46 if(this->Self() != Dali::Accessibility::Accessible::GetCurrentlyHighlightedActor())
51 if(index == DevelControl::Property::ACCESSIBILITY_NAME || (index == GetNamePropertyIndex() && !controlImpl.mAccessibilityNameSet))
53 if(controlImpl.mAccessibilityGetNameSignal.Empty())
55 Emit(Dali::Accessibility::ObjectPropertyChangeEvent::NAME);
59 if(index == DevelControl::Property::ACCESSIBILITY_DESCRIPTION || (index == GetDescriptionPropertyIndex() && !controlImpl.mAccessibilityDescriptionSet))
61 if(controlImpl.mAccessibilityGetDescriptionSignal.Empty())
63 Emit(Dali::Accessibility::ObjectPropertyChangeEvent::DESCRIPTION);
69 std::string AccessibleImpl::GetName()
71 auto control = Dali::Toolkit::Control::DownCast(Self());
73 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
74 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
76 if(!controlImpl.mAccessibilityGetNameSignal.Empty())
79 controlImpl.mAccessibilityGetNameSignal.Emit(ret);
83 if(controlImpl.mAccessibilityNameSet)
84 return controlImpl.mAccessibilityName;
86 if(auto raw = GetNameRaw(); !raw.empty())
89 return Self().GetProperty<std::string>(Actor::Property::NAME);
92 std::string AccessibleImpl::GetNameRaw()
97 std::string AccessibleImpl::GetDescription()
99 auto control = Dali::Toolkit::Control::DownCast(Self());
101 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
102 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
104 if(!controlImpl.mAccessibilityGetDescriptionSignal.Empty())
107 controlImpl.mAccessibilityGetDescriptionSignal.Emit(ret);
111 if(controlImpl.mAccessibilityDescriptionSet)
112 return controlImpl.mAccessibilityDescription;
114 return GetDescriptionRaw();
117 std::string AccessibleImpl::GetDescriptionRaw()
122 Dali::Accessibility::Accessible* AccessibleImpl::GetParent()
124 return Dali::Accessibility::Accessible::Get(Self().GetParent());
127 size_t AccessibleImpl::GetChildCount()
129 return Self().GetChildCount();
132 Dali::Accessibility::Accessible* AccessibleImpl::GetChildAtIndex(size_t index)
134 return Dali::Accessibility::Accessible::Get(Self().GetChildAt(static_cast<unsigned int>(index)));
137 size_t AccessibleImpl::GetIndexInParent()
140 auto parent = s.GetParent();
141 DALI_ASSERT_ALWAYS(parent && "can't call GetIndexInParent on object without parent");
142 auto count = parent.GetChildCount();
143 for(auto i = 0u; i < count; ++i)
145 auto c = parent.GetChildAt(i);
149 DALI_ASSERT_ALWAYS(false && "object isn't child of it's parent");
150 return static_cast<size_t>(-1);
153 Dali::Accessibility::Role AccessibleImpl::GetRole()
155 return Self().GetProperty<Dali::Accessibility::Role>(Toolkit::DevelControl::Property::ACCESSIBILITY_ROLE);
158 Dali::Accessibility::States AccessibleImpl::CalculateStates()
160 Dali::Actor self = Self();
161 Dali::Accessibility::States s;
162 s[Dali::Accessibility::State::FOCUSABLE] = self.GetProperty<bool>(Actor::Property::KEYBOARD_FOCUSABLE);
163 s[Dali::Accessibility::State::FOCUSED] = Toolkit::KeyboardFocusManager::Get().GetCurrentFocusActor() == self;
164 if(self.GetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE).GetType() == Dali::Property::NONE)
165 s[Dali::Accessibility::State::HIGHLIGHTABLE] = false;
167 s[Dali::Accessibility::State::HIGHLIGHTABLE] = self.GetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE).Get<bool>();
168 s[Dali::Accessibility::State::HIGHLIGHTED] = GetCurrentlyHighlightedActor() == self;
169 s[Dali::Accessibility::State::ENABLED] = true;
170 s[Dali::Accessibility::State::SENSITIVE] = true;
171 s[Dali::Accessibility::State::ANIMATED] = self.GetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_ANIMATED).Get<bool>();
172 s[Dali::Accessibility::State::VISIBLE] = true;
175 s[Dali::Accessibility::State::MODAL] = true;
177 s[Dali::Accessibility::State::SHOWING] = !self.GetProperty(Dali::DevelActor::Property::CULLED).Get<bool>() && self.GetCurrentProperty<bool>(Actor::Property::VISIBLE);
179 s[Dali::Accessibility::State::DEFUNCT] = !self.GetProperty(Dali::DevelActor::Property::CONNECTED_TO_SCENE).Get<bool>();
183 Dali::Accessibility::States AccessibleImpl::GetStates()
185 return CalculateStates();
188 Dali::Accessibility::Attributes AccessibleImpl::GetAttributes()
190 std::unordered_map<std::string, std::string> attribute_map;
191 auto q = Dali::Toolkit::Control::DownCast(Self());
193 q.GetProperty(Dali::Toolkit::DevelControl::Property::ACCESSIBILITY_ATTRIBUTES);
198 auto map_size = z->Count();
200 for(unsigned int i = 0; i < map_size; i++)
202 auto map_key = z->GetKeyAt(i);
203 if(map_key.type == Dali::Property::Key::STRING)
205 std::string map_value;
206 if(z->GetValue(i).Get(map_value))
208 attribute_map.emplace(std::move(map_key.stringKey),
209 std::move(map_value));
215 return attribute_map;
218 Dali::Accessibility::ComponentLayer AccessibleImpl::GetLayer()
220 return Dali::Accessibility::ComponentLayer::WINDOW;
223 Dali::Rect<> AccessibleImpl::GetExtents(Dali::Accessibility::CoordType ctype)
225 Dali::Actor self = Self();
226 Vector2 screenPosition =
227 self.GetProperty(Dali::DevelActor::Property::SCREEN_POSITION)
229 auto size = self.GetCurrentProperty<Vector3>(Actor::Property::SIZE) * self.GetCurrentProperty<Vector3>(Actor::Property::WORLD_SCALE);
230 bool positionUsesAnchorPoint =
231 self.GetProperty(Dali::DevelActor::Property::POSITION_USES_ANCHOR_POINT)
233 Vector3 anchorPointOffSet =
234 size * (positionUsesAnchorPoint ? self.GetCurrentProperty<Vector3>(Actor::Property::ANCHOR_POINT)
235 : AnchorPoint::TOP_LEFT);
236 Vector2 position = Vector2(screenPosition.x - anchorPointOffSet.x,
237 screenPosition.y - anchorPointOffSet.y);
239 return {position.x, position.y, size.x, size.y};
242 int16_t AccessibleImpl::GetMdiZOrder()
246 double AccessibleImpl::GetAlpha()
251 bool AccessibleImpl::GrabFocus()
253 return Toolkit::KeyboardFocusManager::Get().SetCurrentFocusActor(Self());
256 static Dali::Actor CreateHighlightIndicatorActor()
258 std::string focusBorderImagePath(AssetManager::GetDaliImagePath());
259 focusBorderImagePath += "/keyboard_focus.9.png";
260 // Create the default if it hasn't been set and one that's shared by all the
261 // keyboard focusable actors
262 auto actor = Toolkit::ImageView::New(focusBorderImagePath);
263 actor.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS);
264 DevelControl::AppendAccessibilityAttribute(actor, "highlight", "");
265 actor.SetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_ANIMATED, true);
266 actor.SetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE, false);
271 bool AccessibleImpl::GrabHighlight()
273 Dali::Actor self = Self();
274 auto old = GetCurrentlyHighlightedActor();
276 if(!Dali::Accessibility::IsUp())
282 auto c = dynamic_cast<Dali::Accessibility::Component*>(Internal::Control::Impl::GetAccessibilityObject(old));
286 auto highlight = GetHighlightActor();
289 highlight = CreateHighlightIndicatorActor();
290 SetHighlightActor(highlight);
292 highlight.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER);
293 highlight.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::CENTER);
294 highlight.SetProperty(Actor::Property::POSITION_Z, 1.0f);
295 highlight.SetProperty(Actor::Property::POSITION, Vector2(0.0f, 0.0f));
297 // Remember the highlight actor, so that when the default is changed with
298 // SetHighlightActor(), the currently displayed highlight can still be cleared.
299 currentHighlightActor = highlight;
302 SetCurrentlyHighlightedActor(self);
303 EmitHighlighted(true);
308 bool AccessibleImpl::ClearHighlight()
310 Dali::Actor self = Self();
312 if(!Dali::Accessibility::IsUp())
314 if(GetCurrentlyHighlightedActor() == self)
316 self.Remove(currentHighlightActor.GetHandle());
317 currentHighlightActor = {};
318 SetCurrentlyHighlightedActor({});
319 EmitHighlighted(false);
325 std::string AccessibleImpl::GetActionName(size_t index)
327 if(index >= GetActionCount()) return "";
329 Self().GetTypeInfo(type);
330 DALI_ASSERT_ALWAYS(type && "no TypeInfo object");
331 return type.GetActionName(index);
334 std::string AccessibleImpl::GetLocalizedActionName(size_t index)
336 // TODO: add localization
337 return GetActionName(index);
340 std::string AccessibleImpl::GetActionDescription(size_t index)
345 size_t AccessibleImpl::GetActionCount()
348 Self().GetTypeInfo(type);
349 DALI_ASSERT_ALWAYS(type && "no TypeInfo object");
350 return type.GetActionCount();
353 std::string AccessibleImpl::GetActionKeyBinding(size_t index)
358 bool AccessibleImpl::DoAction(size_t index)
360 std::string actionName = GetActionName(index);
361 return Self().DoAction(actionName, {});
364 bool AccessibleImpl::DoAction(const std::string& name)
366 return Self().DoAction(name, {});
369 bool AccessibleImpl::DoGesture(const Dali::Accessibility::GestureInfo& gestureInfo)
371 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);
376 if(!controlImpl.mAccessibilityDoGestureSignal.Empty())
378 auto ret = std::make_pair(gestureInfo, false);
379 controlImpl.mAccessibilityDoGestureSignal.Emit(ret);
386 std::vector<Dali::Accessibility::Relation> AccessibleImpl::GetRelationSet()
388 auto control = Dali::Toolkit::Control::DownCast(Self());
390 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
391 Internal::Control::Impl& controlImpl = Internal::Control::Impl::Get(internalControl);
393 std::vector<Dali::Accessibility::Relation> ret;
395 auto& v = controlImpl.mAccessibilityRelations;
396 for(auto i = 0u; i < v.size(); ++i)
401 ret.emplace_back(Accessibility::Relation{static_cast<Accessibility::RelationType>(i), v[i]});
407 void AccessibleImpl::EnsureChildVisible(Actor child)
411 void AccessibleImpl::EnsureSelfVisible()
413 auto parent = dynamic_cast<AccessibleImpl*>(GetParent());
416 parent->EnsureChildVisible(Self());
420 Dali::Property::Index AccessibleImpl::GetNamePropertyIndex()
422 return Actor::Property::NAME;
425 Dali::Property::Index AccessibleImpl::GetDescriptionPropertyIndex()
427 return Dali::Property::INVALID_INDEX;
430 } // namespace Dali::Toolkit::DevelControl