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 void CreateTransitions(Control control, Dali::Animation& animation, Dali::Toolkit::Control source, AlphaFunction alphaFunction, TimePeriod timePeriod)
129 // make visual transition of control visual.
130 Internal::Control& internalControl = Toolkit::Internal::GetImplementation(control);
131 Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(internalControl);
132 controlDataImpl.MakeVisualTransition(animation, source, Toolkit::Control::Property::BACKGROUND, alphaFunction, timePeriod);
133 controlDataImpl.MakeVisualTransition(animation, source, Toolkit::DevelControl::Property::SHADOW, alphaFunction, timePeriod);
134 internalControl.OnCreateTransitions(animation, source, alphaFunction, timePeriod);
138 static Toolkit::Internal::Control::Impl* GetControlImplementationIfAny(Dali::Actor actor)
140 Dali::Toolkit::Control c = Toolkit::Control::DownCast(actor);
143 auto& impl1 = Toolkit::Internal::GetImplementation(c);
144 auto& impl2 = Toolkit::Internal::Control::Impl::Get(impl1);
150 Toolkit::DevelControl::AccessibilityActivateSignalType& AccessibilityActivateSignal(Toolkit::Control control)
152 auto ac = GetControlImplementationIfAny(control);
153 return ac->mAccessibilityActivateSignal;
156 Toolkit::DevelControl::AccessibilityReadingSkippedSignalType& AccessibilityReadingSkippedSignal(Toolkit::Control control)
158 auto ac = GetControlImplementationIfAny(control);
159 return ac->mAccessibilityReadingSkippedSignal;
162 Toolkit::DevelControl::AccessibilityReadingPausedSignalType& AccessibilityReadingPausedSignal(Toolkit::Control control)
164 auto ac = GetControlImplementationIfAny(control);
165 return ac->mAccessibilityReadingPausedSignal;
168 Toolkit::DevelControl::AccessibilityReadingResumedSignalType& AccessibilityReadingResumedSignal(Toolkit::Control control)
170 auto ac = GetControlImplementationIfAny(control);
171 return ac->mAccessibilityReadingResumedSignal;
174 Toolkit::DevelControl::AccessibilityReadingCancelledSignalType& AccessibilityReadingCancelledSignal(Toolkit::Control control)
176 auto ac = GetControlImplementationIfAny(control);
177 return ac->mAccessibilityReadingCancelledSignal;
180 Toolkit::DevelControl::AccessibilityReadingStoppedSignalType& AccessibilityReadingStoppedSignal(Toolkit::Control control)
182 auto ac = GetControlImplementationIfAny(control);
183 return ac->mAccessibilityReadingStoppedSignal;
186 Toolkit::DevelControl::AccessibilityGetNameSignalType& AccessibilityGetNameSignal(Toolkit::Control control)
188 auto ac = GetControlImplementationIfAny(control);
189 return ac->mAccessibilityGetNameSignal;
192 Toolkit::DevelControl::AccessibilityGetDescriptionSignalType& AccessibilityGetDescriptionSignal(Toolkit::Control control)
194 auto ac = GetControlImplementationIfAny(control);
195 return ac->mAccessibilityGetDescriptionSignal;
198 Toolkit::DevelControl::AccessibilityDoGestureSignalType& AccessibilityDoGestureSignal(Toolkit::Control control)
200 auto ac = GetControlImplementationIfAny(control);
201 return ac->mAccessibilityDoGestureSignal;
204 void AppendAccessibilityRelation(Dali::Actor control, Actor destination, Dali::Accessibility::RelationType relation)
206 if(auto ac = GetControlImplementationIfAny(control))
208 auto index = static_cast<Dali::Property::Array::SizeType>(relation);
209 if(index >= ac->mAccessibilityRelations.size())
211 DALI_LOG_ERROR("Relation index exceeds vector size.");
215 auto obj = ac->GetAccessibilityObject(destination);
217 ac->mAccessibilityRelations[index].push_back(obj->GetAddress());
221 void RemoveAccessibilityRelation(Dali::Actor control, Actor destination, Dali::Accessibility::RelationType relation)
223 if(auto ac = GetControlImplementationIfAny(control))
225 auto index = static_cast<Dali::Property::Array::SizeType>(relation);
226 if(index >= ac->mAccessibilityRelations.size())
228 DALI_LOG_ERROR("Relation index exceeds vector size.");
232 auto obj = ac->GetAccessibilityObject(destination);
236 auto address = obj->GetAddress();
238 auto& targets = ac->mAccessibilityRelations[index];
239 for(auto i = 0u; i < targets.size(); ++i)
241 if(targets[i].ToString() == address.ToString())
243 targets[i] = targets.back();
244 targets.erase(targets.end() - 1);
250 std::vector<std::vector<Accessibility::Address>> GetAccessibilityRelations(Dali::Actor control)
252 if(auto ac = GetControlImplementationIfAny(control))
254 return ac->mAccessibilityRelations;
259 void ClearAccessibilityRelations(Dali::Actor control)
261 if(auto ac = GetControlImplementationIfAny(control))
263 for(auto& it : ac->mAccessibilityRelations)
268 void SetAccessibilityConstructor(Dali::Actor control,
269 std::function<std::unique_ptr<Dali::Accessibility::Accessible>(Dali::Actor)> constructor)
271 if(auto ac = GetControlImplementationIfAny(control))
273 ac->accessibilityConstructor = constructor;
277 void AppendAccessibilityAttribute(Dali::Actor control, const std::string& key, const std::string value)
279 if(auto ac = GetControlImplementationIfAny(control))
281 ac->AppendAccessibilityAttribute(key, value);
285 void RemoveAccessibilityAttribute(Dali::Actor control, const std::string& key)
287 if(auto ac = GetControlImplementationIfAny(control))
289 ac->RemoveAccessibilityAttribute(key);
293 void ClearAccessibilityAttributes(Dali::Actor control)
295 if(auto ac = GetControlImplementationIfAny(control))
297 ac->ClearAccessibilityAttributes();
301 void SetAccessibilityReadingInfoType(Dali::Actor control, const Dali::Accessibility::ReadingInfoTypes types)
303 if(auto ac = GetControlImplementationIfAny(control))
305 ac->SetAccessibilityReadingInfoType(types);
309 Dali::Accessibility::ReadingInfoTypes GetAccessibilityReadingInfoType(Dali::Actor control)
311 if(auto ac = GetControlImplementationIfAny(control))
313 return ac->GetAccessibilityReadingInfoType();
318 bool ClearAccessibilityHighlight(Dali::Actor control)
320 if(auto ac = GetControlImplementationIfAny(control))
322 auto ptr = dynamic_cast<Dali::Accessibility::Component*>(ac->GetAccessibilityObject());
324 return ptr->ClearHighlight();
329 bool GrabAccessibilityHighlight(Dali::Actor control)
331 if(auto ac = GetControlImplementationIfAny(control))
333 auto ptr = dynamic_cast<Dali::Accessibility::Component*>(ac->GetAccessibilityObject());
335 return ptr->GrabHighlight();
340 Dali::Accessibility::States GetAccessibilityStates(Dali::Actor control)
342 if(auto ac = GetControlImplementationIfAny(control))
344 auto ptr = dynamic_cast<Dali::Accessibility::Component*>(ac->GetAccessibilityObject());
346 return ptr->GetStates();
351 void NotifyAccessibilityStateChange(Dali::Actor control, Dali::Accessibility::States states, bool doRecursive)
353 if(auto ac = GetControlImplementationIfAny(control))
355 ac->GetAccessibilityObject()->NotifyAccessibilityStateChange(std::move(states), doRecursive);
359 Dali::Accessibility::Accessible* GetBoundAccessibilityObject(Dali::Actor control)
361 return Dali::Accessibility::Accessible::Get(control);
364 } // namespace DevelControl
366 } // namespace Toolkit