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* GetControlImplementationIfAny(Dali::Actor actor)
127 Dali::Toolkit::Control c = Toolkit::Control::DownCast(actor);
130 auto& impl1 = Toolkit::Internal::GetImplementation(c);
131 auto& impl2 = Toolkit::Internal::Control::Impl::Get(impl1);
137 Toolkit::DevelControl::AccessibilityActivateSignalType& AccessibilityActivateSignal(Toolkit::Control control)
139 auto ac = GetControlImplementationIfAny(control);
140 return ac->mAccessibilityActivateSignal;
143 Toolkit::DevelControl::AccessibilityReadingSkippedSignalType& AccessibilityReadingSkippedSignal(Toolkit::Control control)
145 auto ac = GetControlImplementationIfAny(control);
146 return ac->mAccessibilityReadingSkippedSignal;
149 Toolkit::DevelControl::AccessibilityReadingPausedSignalType& AccessibilityReadingPausedSignal(Toolkit::Control control)
151 auto ac = GetControlImplementationIfAny(control);
152 return ac->mAccessibilityReadingPausedSignal;
155 Toolkit::DevelControl::AccessibilityReadingResumedSignalType& AccessibilityReadingResumedSignal(Toolkit::Control control)
157 auto ac = GetControlImplementationIfAny(control);
158 return ac->mAccessibilityReadingResumedSignal;
161 Toolkit::DevelControl::AccessibilityReadingCancelledSignalType& AccessibilityReadingCancelledSignal(Toolkit::Control control)
163 auto ac = GetControlImplementationIfAny(control);
164 return ac->mAccessibilityReadingCancelledSignal;
167 Toolkit::DevelControl::AccessibilityReadingStoppedSignalType& AccessibilityReadingStoppedSignal(Toolkit::Control control)
169 auto ac = GetControlImplementationIfAny(control);
170 return ac->mAccessibilityReadingStoppedSignal;
173 Toolkit::DevelControl::AccessibilityGetNameSignalType& AccessibilityGetNameSignal(Toolkit::Control control)
175 auto ac = GetControlImplementationIfAny(control);
176 return ac->mAccessibilityGetNameSignal;
179 Toolkit::DevelControl::AccessibilityGetDescriptionSignalType& AccessibilityGetDescriptionSignal(Toolkit::Control control)
181 auto ac = GetControlImplementationIfAny(control);
182 return ac->mAccessibilityGetDescriptionSignal;
185 Toolkit::DevelControl::AccessibilityDoGestureSignalType& AccessibilityDoGestureSignal(Toolkit::Control control)
187 auto ac = GetControlImplementationIfAny(control);
188 return ac->mAccessibilityDoGestureSignal;
191 void AppendAccessibilityRelation(Dali::Actor control, Actor destination, Dali::Accessibility::RelationType relation)
193 if(auto ac = GetControlImplementationIfAny(control))
195 auto index = static_cast<Dali::Property::Array::SizeType>(relation);
196 if(index >= ac->mAccessibilityRelations.size())
198 DALI_LOG_ERROR("Relation index exceeds vector size.");
202 auto obj = ac->GetAccessibilityObject(destination);
204 ac->mAccessibilityRelations[index].push_back(obj->GetAddress());
208 void RemoveAccessibilityRelation(Dali::Actor control, Actor destination, Dali::Accessibility::RelationType relation)
210 if(auto ac = GetControlImplementationIfAny(control))
212 auto index = static_cast<Dali::Property::Array::SizeType>(relation);
213 if(index >= ac->mAccessibilityRelations.size())
215 DALI_LOG_ERROR("Relation index exceeds vector size.");
219 auto obj = ac->GetAccessibilityObject(destination);
223 auto address = obj->GetAddress();
225 auto& targets = ac->mAccessibilityRelations[index];
226 for(auto i = 0u; i < targets.size(); ++i)
228 if(targets[i].ToString() == address.ToString())
230 targets[i] = targets.back();
231 targets.erase(targets.end() - 1);
237 std::vector<std::vector<Accessibility::Address>> GetAccessibilityRelations(Dali::Actor control)
239 if(auto ac = GetControlImplementationIfAny(control))
241 return ac->mAccessibilityRelations;
246 void ClearAccessibilityRelations(Dali::Actor control)
248 if(auto ac = GetControlImplementationIfAny(control))
250 for(auto& it : ac->mAccessibilityRelations)
255 void SetAccessibilityConstructor(Dali::Actor control,
256 std::function<std::unique_ptr<Dali::Accessibility::Accessible>(Dali::Actor)> constructor)
258 if(auto ac = GetControlImplementationIfAny(control))
260 ac->accessibilityConstructor = constructor;
264 void AppendAccessibilityAttribute(Dali::Actor control, const std::string& key, const std::string value)
266 if(auto ac = GetControlImplementationIfAny(control))
268 ac->AppendAccessibilityAttribute(key, value);
272 void RemoveAccessibilityAttribute(Dali::Actor control, const std::string& key)
274 if(auto ac = GetControlImplementationIfAny(control))
276 ac->RemoveAccessibilityAttribute(key);
280 void ClearAccessibilityAttributes(Dali::Actor control)
282 if(auto ac = GetControlImplementationIfAny(control))
284 ac->ClearAccessibilityAttributes();
288 void SetAccessibilityReadingInfoType(Dali::Actor control, const Dali::Accessibility::ReadingInfoTypes types)
290 if(auto ac = GetControlImplementationIfAny(control))
292 ac->SetAccessibilityReadingInfoType(types);
296 Dali::Accessibility::ReadingInfoTypes GetAccessibilityReadingInfoType(Dali::Actor control)
298 if(auto ac = GetControlImplementationIfAny(control))
300 return ac->GetAccessibilityReadingInfoType();
305 bool ClearAccessibilityHighlight(Dali::Actor control)
307 if(auto ac = GetControlImplementationIfAny(control))
309 auto ptr = dynamic_cast<Dali::Accessibility::Component*>(ac->GetAccessibilityObject());
311 return ptr->ClearHighlight();
316 bool GrabAccessibilityHighlight(Dali::Actor control)
318 if(auto ac = GetControlImplementationIfAny(control))
320 auto ptr = dynamic_cast<Dali::Accessibility::Component*>(ac->GetAccessibilityObject());
322 return ptr->GrabHighlight();
327 Dali::Accessibility::States GetAccessibilityStates(Dali::Actor control)
329 if(auto ac = GetControlImplementationIfAny(control))
331 auto ptr = dynamic_cast<Dali::Accessibility::Component*>(ac->GetAccessibilityObject());
333 return ptr->GetStates();
338 void NotifyAccessibilityStateChange(Dali::Actor control, Dali::Accessibility::States states, bool doRecursive)
340 if(auto ac = GetControlImplementationIfAny(control))
342 ac->GetAccessibilityObject()->NotifyAccessibilityStateChange(std::move(states), doRecursive);
346 Dali::Accessibility::Accessible* GetBoundAccessibilityObject(Dali::Actor control)
348 return Dali::Accessibility::Accessible::Get(control);
351 } // namespace DevelControl
353 } // namespace Toolkit