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-devel.h"
22 #include <dali/public-api/actors/actor.h>
23 #include <dali/public-api/animation/animation.h>
26 #include <dali-toolkit/devel-api/visual-factory/transition-data.h>
27 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
28 #include <dali-toolkit/public-api/controls/control-impl.h>
29 #include <dali-toolkit/public-api/controls/control.h>
35 namespace DevelControl
37 void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual)
39 Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(control);
40 controlDataImpl.RegisterVisual(index, visual);
43 void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, int depthIndex)
45 Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(control);
46 controlDataImpl.RegisterVisual(index, visual, depthIndex);
49 void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, bool enabled)
51 Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(control);
52 controlDataImpl.RegisterVisual(index, visual, enabled);
55 void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, bool enabled, int depthIndex)
57 Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(control);
58 controlDataImpl.RegisterVisual(index, visual, enabled, depthIndex);
61 void UnregisterVisual(Internal::Control& control, Dali::Property::Index index)
63 Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(control);
64 controlDataImpl.UnregisterVisual(index);
67 Toolkit::Visual::Base GetVisual(const Internal::Control& control, Dali::Property::Index index)
69 const Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(control);
70 return controlDataImpl.GetVisual(index);
73 void EnableVisual(Internal::Control& control, Dali::Property::Index index, bool enable)
75 Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(control);
76 controlDataImpl.EnableVisual(index, enable);
79 bool IsVisualEnabled(const Internal::Control& control, Dali::Property::Index index)
81 const Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(control);
82 return controlDataImpl.IsVisualEnabled(index);
85 Dali::Animation CreateTransition(Internal::Control& control, const Toolkit::TransitionData& handle)
87 Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(control);
88 return controlDataImpl.CreateTransition(handle);
91 void AddTransitions(Internal::Control& control,
92 Dali::Animation animation,
93 const Toolkit::TransitionData& transitionData)
95 Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(control);
96 controlDataImpl.AddTransitions(animation, transitionData);
99 void DoAction(Control& control, Dali::Property::Index visualIndex, Dali::Property::Index actionId, const Dali::Property::Value attributes)
101 Internal::Control& controlInternal = Toolkit::Internal::GetImplementation(control);
102 Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(controlInternal);
103 controlDataImpl.DoAction(visualIndex, actionId, attributes);
106 void SetInputMethodContext(Internal::Control& control, InputMethodContext& inputMethodContext)
108 Internal::Control::Impl::Get(control).SetInputMethodContext(inputMethodContext);
111 VisualEventSignalType& VisualEventSignal(Control control)
113 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
114 Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(internalControl);
115 return controlDataImpl.VisualEventSignal();
118 Dali::Property GetVisualProperty(Control control, Dali::Property::Index index, Dali::Property::Key visualPropertyKey)
120 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
121 Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(internalControl);
122 return controlDataImpl.GetVisualProperty(index, visualPropertyKey);
125 static Toolkit::Internal::Control::Impl* GetControlImplementation(Dali::Actor actor)
127 Dali::Toolkit::Control control = Toolkit::Control::DownCast(actor);
130 auto& internalControl = Toolkit::Internal::GetImplementation(control);
131 auto& controlDataImpl = Toolkit::Internal::Control::Impl::Get(internalControl);
132 return &controlDataImpl;
137 Toolkit::DevelControl::AccessibilityActivateSignalType& AccessibilityActivateSignal(Toolkit::Control control)
139 return GetControlImplementation(control)->mAccessibilityActivateSignal;
142 Toolkit::DevelControl::AccessibilityReadingSkippedSignalType& AccessibilityReadingSkippedSignal(Toolkit::Control control)
144 return GetControlImplementation(control)->mAccessibilityReadingSkippedSignal;
147 Toolkit::DevelControl::AccessibilityReadingPausedSignalType& AccessibilityReadingPausedSignal(Toolkit::Control control)
149 return GetControlImplementation(control)->mAccessibilityReadingPausedSignal;
152 Toolkit::DevelControl::AccessibilityReadingResumedSignalType& AccessibilityReadingResumedSignal(Toolkit::Control control)
154 return GetControlImplementation(control)->mAccessibilityReadingResumedSignal;
157 Toolkit::DevelControl::AccessibilityReadingCancelledSignalType& AccessibilityReadingCancelledSignal(Toolkit::Control control)
159 return GetControlImplementation(control)->mAccessibilityReadingCancelledSignal;
162 Toolkit::DevelControl::AccessibilityReadingStoppedSignalType& AccessibilityReadingStoppedSignal(Toolkit::Control control)
164 return GetControlImplementation(control)->mAccessibilityReadingStoppedSignal;
167 Toolkit::DevelControl::AccessibilityGetNameSignalType& AccessibilityGetNameSignal(Toolkit::Control control)
169 return GetControlImplementation(control)->mAccessibilityGetNameSignal;
172 Toolkit::DevelControl::AccessibilityGetDescriptionSignalType& AccessibilityGetDescriptionSignal(Toolkit::Control control)
174 return GetControlImplementation(control)->mAccessibilityGetDescriptionSignal;
177 Toolkit::DevelControl::AccessibilityDoGestureSignalType& AccessibilityDoGestureSignal(Toolkit::Control control)
179 return GetControlImplementation(control)->mAccessibilityDoGestureSignal;
182 void AppendAccessibilityRelation(Dali::Actor control, Actor destination, Dali::Accessibility::RelationType relation)
184 if(auto controlDataImpl = GetControlImplementation(control))
186 auto index = static_cast<Dali::Property::Array::SizeType>(relation);
187 if(index >= controlDataImpl->mAccessibilityRelations.size())
189 DALI_LOG_ERROR("Relation index exceeds vector size.");
193 auto object = controlDataImpl->GetAccessibilityObject(destination);
196 controlDataImpl->mAccessibilityRelations[index].push_back(object);
201 void RemoveAccessibilityRelation(Dali::Actor control, Actor destination, Dali::Accessibility::RelationType relation)
203 if(auto controlDataImpl = GetControlImplementation(control))
205 auto index = static_cast<Dali::Property::Array::SizeType>(relation);
206 if(index >= controlDataImpl->mAccessibilityRelations.size())
208 DALI_LOG_ERROR("Relation index exceeds vector size.");
212 auto object = controlDataImpl->GetAccessibilityObject(destination);
218 auto& targets = controlDataImpl->mAccessibilityRelations[index];
219 for(auto i = 0u; i < targets.size(); ++i)
221 if(targets[i] == object)
223 std::swap(targets[i], targets.back());
231 std::vector<std::vector<Accessibility::Address>> GetAccessibilityRelations(Dali::Actor control)
233 if(auto controlDataImpl = GetControlImplementation(control))
235 auto& relations = controlDataImpl->mAccessibilityRelations;
237 std::vector<std::vector<Accessibility::Address>> result(relations.size());
239 // Map every Accessible* to its Address
240 for(std::size_t i = 0; i < relations.size(); ++i)
242 auto& relation = relations[i];
244 std::transform(relation.begin(), relation.end(), std::back_inserter(result[i]), [](auto* x) {
245 return x->GetAddress();
255 void ClearAccessibilityRelations(Dali::Actor control)
257 if(auto controlDataImpl = GetControlImplementation(control))
259 for(auto& it : controlDataImpl->mAccessibilityRelations)
266 void SetAccessibilityConstructor(Dali::Actor control, std::function<std::unique_ptr<Dali::Accessibility::Accessible>(Dali::Actor)> constructor)
268 if(auto controlDataImpl = GetControlImplementation(control))
270 controlDataImpl->mAccessibilityConstructor = constructor;
274 void AppendAccessibilityAttribute(Dali::Actor control, const std::string& key, const std::string value)
276 if(auto controlDataImpl = GetControlImplementation(control))
278 controlDataImpl->AppendAccessibilityAttribute(key, value);
282 void RemoveAccessibilityAttribute(Dali::Actor control, const std::string& key)
284 if(auto controlDataImpl = GetControlImplementation(control))
286 controlDataImpl->RemoveAccessibilityAttribute(key);
290 void ClearAccessibilityAttributes(Dali::Actor control)
292 if(auto controlDataImpl = GetControlImplementation(control))
294 controlDataImpl->ClearAccessibilityAttributes();
298 void SetAccessibilityReadingInfoType(Dali::Actor control, const Dali::Accessibility::ReadingInfoTypes types)
300 if(auto controlDataImpl = GetControlImplementation(control))
302 controlDataImpl->SetAccessibilityReadingInfoType(types);
306 Dali::Accessibility::ReadingInfoTypes GetAccessibilityReadingInfoType(Dali::Actor control)
308 if(auto controlDataImpl = GetControlImplementation(control))
310 return controlDataImpl->GetAccessibilityReadingInfoType();
315 bool ClearAccessibilityHighlight(Dali::Actor control)
317 if(auto controlDataImpl = GetControlImplementation(control))
319 auto object = dynamic_cast<Dali::Accessibility::Component*>(controlDataImpl->GetAccessibilityObject());
322 return object->ClearHighlight();
328 bool GrabAccessibilityHighlight(Dali::Actor control)
330 if(auto controlDataImpl = GetControlImplementation(control))
332 auto object = dynamic_cast<Dali::Accessibility::Component*>(controlDataImpl->GetAccessibilityObject());
335 return object->GrabHighlight();
341 Dali::Accessibility::States GetAccessibilityStates(Dali::Actor control)
343 if(auto controlDataImpl = GetControlImplementation(control))
345 auto object = dynamic_cast<Dali::Accessibility::Component*>(controlDataImpl->GetAccessibilityObject());
348 return object->GetStates();
354 void NotifyAccessibilityStateChange(Dali::Actor control, Dali::Accessibility::States states, bool isRecursive)
356 if(auto controlDataImpl = GetControlImplementation(control))
358 controlDataImpl->GetAccessibilityObject()->NotifyAccessibilityStateChange(std::move(states), isRecursive);
362 Dali::Accessibility::Accessible* GetBoundAccessibilityObject(Dali::Actor control)
364 return Dali::Accessibility::Accessible::Get(control);
367 } // namespace DevelControl
369 } // namespace Toolkit