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* GetControlImplementation(Dali::Actor actor)
140 Dali::Toolkit::Control control = Toolkit::Control::DownCast(actor);
143 auto& internalControl = Toolkit::Internal::GetImplementation(control);
144 auto& controlDataImpl = Toolkit::Internal::Control::Impl::Get(internalControl);
145 return &controlDataImpl;
150 Toolkit::DevelControl::AccessibilityActivateSignalType& AccessibilityActivateSignal(Toolkit::Control control)
152 return GetControlImplementation(control)->mAccessibilityActivateSignal;
155 Toolkit::DevelControl::AccessibilityReadingSkippedSignalType& AccessibilityReadingSkippedSignal(Toolkit::Control control)
157 return GetControlImplementation(control)->mAccessibilityReadingSkippedSignal;
160 Toolkit::DevelControl::AccessibilityReadingPausedSignalType& AccessibilityReadingPausedSignal(Toolkit::Control control)
162 return GetControlImplementation(control)->mAccessibilityReadingPausedSignal;
165 Toolkit::DevelControl::AccessibilityReadingResumedSignalType& AccessibilityReadingResumedSignal(Toolkit::Control control)
167 return GetControlImplementation(control)->mAccessibilityReadingResumedSignal;
170 Toolkit::DevelControl::AccessibilityReadingCancelledSignalType& AccessibilityReadingCancelledSignal(Toolkit::Control control)
172 return GetControlImplementation(control)->mAccessibilityReadingCancelledSignal;
175 Toolkit::DevelControl::AccessibilityReadingStoppedSignalType& AccessibilityReadingStoppedSignal(Toolkit::Control control)
177 return GetControlImplementation(control)->mAccessibilityReadingStoppedSignal;
180 Toolkit::DevelControl::AccessibilityGetNameSignalType& AccessibilityGetNameSignal(Toolkit::Control control)
182 return GetControlImplementation(control)->mAccessibilityGetNameSignal;
185 Toolkit::DevelControl::AccessibilityGetDescriptionSignalType& AccessibilityGetDescriptionSignal(Toolkit::Control control)
187 return GetControlImplementation(control)->mAccessibilityGetDescriptionSignal;
190 Toolkit::DevelControl::AccessibilityDoGestureSignalType& AccessibilityDoGestureSignal(Toolkit::Control control)
192 return GetControlImplementation(control)->mAccessibilityDoGestureSignal;
195 void AppendAccessibilityRelation(Dali::Actor control, Actor destination, Dali::Accessibility::RelationType relation)
197 if(auto controlDataImpl = GetControlImplementation(control))
199 auto index = static_cast<Dali::Property::Array::SizeType>(relation);
200 if(index >= controlDataImpl->mAccessibilityRelations.size())
202 DALI_LOG_ERROR("Relation index exceeds vector size.");
206 auto object = controlDataImpl->GetAccessibilityObject(destination);
209 controlDataImpl->mAccessibilityRelations[index].push_back(object->GetAddress());
214 void RemoveAccessibilityRelation(Dali::Actor control, Actor destination, Dali::Accessibility::RelationType relation)
216 if(auto controlDataImpl = GetControlImplementation(control))
218 auto index = static_cast<Dali::Property::Array::SizeType>(relation);
219 if(index >= controlDataImpl->mAccessibilityRelations.size())
221 DALI_LOG_ERROR("Relation index exceeds vector size.");
225 auto object = controlDataImpl->GetAccessibilityObject(destination);
231 auto address = object->GetAddress();
233 auto& targets = controlDataImpl->mAccessibilityRelations[index];
234 for(auto i = 0u; i < targets.size(); ++i)
236 if(targets[i].ToString() == address.ToString())
238 targets[i] = targets.back();
239 targets.erase(targets.end() - 1);
245 std::vector<std::vector<Accessibility::Address>> GetAccessibilityRelations(Dali::Actor control)
247 if(auto controlDataImpl = GetControlImplementation(control))
249 return controlDataImpl->mAccessibilityRelations;
254 void ClearAccessibilityRelations(Dali::Actor control)
256 if(auto controlDataImpl = GetControlImplementation(control))
258 for(auto& it : controlDataImpl->mAccessibilityRelations)
265 void SetAccessibilityConstructor(Dali::Actor control, std::function<std::unique_ptr<Dali::Accessibility::Accessible>(Dali::Actor)> constructor)
267 if(auto controlDataImpl = GetControlImplementation(control))
269 controlDataImpl->mAccessibilityConstructor = constructor;
273 void AppendAccessibilityAttribute(Dali::Actor control, const std::string& key, const std::string value)
275 if(auto controlDataImpl = GetControlImplementation(control))
277 controlDataImpl->AppendAccessibilityAttribute(key, value);
281 void RemoveAccessibilityAttribute(Dali::Actor control, const std::string& key)
283 if(auto controlDataImpl = GetControlImplementation(control))
285 controlDataImpl->RemoveAccessibilityAttribute(key);
289 void ClearAccessibilityAttributes(Dali::Actor control)
291 if(auto controlDataImpl = GetControlImplementation(control))
293 controlDataImpl->ClearAccessibilityAttributes();
297 void SetAccessibilityReadingInfoType(Dali::Actor control, const Dali::Accessibility::ReadingInfoTypes types)
299 if(auto controlDataImpl = GetControlImplementation(control))
301 controlDataImpl->SetAccessibilityReadingInfoType(types);
305 Dali::Accessibility::ReadingInfoTypes GetAccessibilityReadingInfoType(Dali::Actor control)
307 if(auto controlDataImpl = GetControlImplementation(control))
309 return controlDataImpl->GetAccessibilityReadingInfoType();
314 bool ClearAccessibilityHighlight(Dali::Actor control)
316 if(auto controlDataImpl = GetControlImplementation(control))
318 auto object = dynamic_cast<Dali::Accessibility::Component*>(controlDataImpl->GetAccessibilityObject());
321 return object->ClearHighlight();
327 bool GrabAccessibilityHighlight(Dali::Actor control)
329 if(auto controlDataImpl = GetControlImplementation(control))
331 auto object = dynamic_cast<Dali::Accessibility::Component*>(controlDataImpl->GetAccessibilityObject());
334 return object->GrabHighlight();
340 Dali::Accessibility::States GetAccessibilityStates(Dali::Actor control)
342 if(auto controlDataImpl = GetControlImplementation(control))
344 auto object = dynamic_cast<Dali::Accessibility::Component*>(controlDataImpl->GetAccessibilityObject());
347 return object->GetStates();
353 void NotifyAccessibilityStateChange(Dali::Actor control, Dali::Accessibility::States states, bool isRecursive)
355 if(auto controlDataImpl = GetControlImplementation(control))
357 controlDataImpl->GetAccessibilityObject()->NotifyAccessibilityStateChange(std::move(states), isRecursive);
361 Dali::Accessibility::Accessible* GetBoundAccessibilityObject(Dali::Actor control)
363 return Dali::Accessibility::Accessible::Get(control);
366 } // namespace DevelControl
368 } // namespace Toolkit