dali-toolkit/devel-api/controls/control-devel.cpp

   1 /*
   2  * Copyright (c) 2021 Samsung Electronics Co., Ltd.
   3  *
   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
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  *
  16  */
  17
  18 // CLASS HEADER
  19 #include "control-devel.h"
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/actors/actor.h>
  23 #include <dali/public-api/animation/animation.h>
  24
  25 // INTERNAL INCLUDES
  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>
  30
  31 namespace Dali
  32 {
  33 namespace Toolkit
  34 {
  35 namespace DevelControl
  36 {
  37 void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual)
  38 {
  39   Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(control);
  40   controlDataImpl.RegisterVisual(index, visual);
  41 }
  42
  43 void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, int depthIndex)
  44 {
  45   Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(control);
  46   controlDataImpl.RegisterVisual(index, visual, depthIndex);
  47 }
  48
  49 void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, bool enabled)
  50 {
  51   Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(control);
  52   controlDataImpl.RegisterVisual(index, visual, enabled);
  53 }
  54
  55 void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, bool enabled, int depthIndex)
  56 {
  57   Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(control);
  58   controlDataImpl.RegisterVisual(index, visual, enabled, depthIndex);
  59 }
  60
  61 void UnregisterVisual(Internal::Control& control, Dali::Property::Index index)
  62 {
  63   Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(control);
  64   controlDataImpl.UnregisterVisual(index);
  65 }
  66
  67 Toolkit::Visual::Base GetVisual(const Internal::Control& control, Dali::Property::Index index)
  68 {
  69   const Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(control);
  70   return controlDataImpl.GetVisual(index);
  71 }
  72
  73 void EnableVisual(Internal::Control& control, Dali::Property::Index index, bool enable)
  74 {
  75   Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(control);
  76   controlDataImpl.EnableVisual(index, enable);
  77 }
  78
  79 bool IsVisualEnabled(const Internal::Control& control, Dali::Property::Index index)
  80 {
  81   const Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(control);
  82   return controlDataImpl.IsVisualEnabled(index);
  83 }
  84
  85 Dali::Animation CreateTransition(Internal::Control& control, const Toolkit::TransitionData& handle)
  86 {
  87   Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(control);
  88   return controlDataImpl.CreateTransition(handle);
  89 }
  90
  91 void AddTransitions(Internal::Control&             control,
  92                     Dali::Animation                animation,
  93                     const Toolkit::TransitionData& transitionData)
  94 {
  95   Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(control);
  96   controlDataImpl.AddTransitions(animation, transitionData);
  97 }
  98
  99 void DoAction(Control& control, Dali::Property::Index visualIndex, Dali::Property::Index actionId, const Dali::Property::Value attributes)
 100 {
 101   Internal::Control&       controlInternal = Toolkit::Internal::GetImplementation(control);
 102   Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(controlInternal);
 103   controlDataImpl.DoAction(visualIndex, actionId, attributes);
 104 }
 105
 106 void SetInputMethodContext(Internal::Control& control, InputMethodContext& inputMethodContext)
 107 {
 108   Internal::Control::Impl::Get(control).SetInputMethodContext(inputMethodContext);
 109 }
 110
 111 VisualEventSignalType& VisualEventSignal(Control control)
 112 {
 113   Internal::Control&       internalControl = Toolkit::Internal::GetImplementation(control);
 114   Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(internalControl);
 115   return controlDataImpl.VisualEventSignal();
 116 }
 117
 118 Dali::Property GetVisualProperty(Control control, Dali::Property::Index index, Dali::Property::Key visualPropertyKey)
 119 {
 120   Internal::Control&       internalControl = Toolkit::Internal::GetImplementation(control);
 121   Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(internalControl);
 122   return controlDataImpl.GetVisualProperty(index, visualPropertyKey);
 123 }
 124
 125 void CreateTransitions(Control control, Dali::Animation& animation, Dali::Toolkit::Control source, AlphaFunction alphaFunction, TimePeriod timePeriod)
 126 {
 127   if(animation)
 128   {
 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);
 135   }
 136 }
 137
 138 static Toolkit::Internal::Control::Impl* GetControlImplementation(Dali::Actor actor)
 139 {
 140   Dali::Toolkit::Control control = Toolkit::Control::DownCast(actor);
 141   if(control)
 142   {
 143     auto& internalControl = Toolkit::Internal::GetImplementation(control);
 144     auto& controlDataImpl = Toolkit::Internal::Control::Impl::Get(internalControl);
 145     return &controlDataImpl;
 146   }
 147   return nullptr;
 148 }
 149
 150 Toolkit::DevelControl::AccessibilityActivateSignalType& AccessibilityActivateSignal(Toolkit::Control control)
 151 {
 152   return GetControlImplementation(control)->mAccessibilityActivateSignal;
 153 }
 154
 155 Toolkit::DevelControl::AccessibilityReadingSkippedSignalType& AccessibilityReadingSkippedSignal(Toolkit::Control control)
 156 {
 157   return GetControlImplementation(control)->mAccessibilityReadingSkippedSignal;
 158 }
 159
 160 Toolkit::DevelControl::AccessibilityReadingPausedSignalType& AccessibilityReadingPausedSignal(Toolkit::Control control)
 161 {
 162   return GetControlImplementation(control)->mAccessibilityReadingPausedSignal;
 163 }
 164
 165 Toolkit::DevelControl::AccessibilityReadingResumedSignalType& AccessibilityReadingResumedSignal(Toolkit::Control control)
 166 {
 167   return GetControlImplementation(control)->mAccessibilityReadingResumedSignal;
 168 }
 169
 170 Toolkit::DevelControl::AccessibilityReadingCancelledSignalType& AccessibilityReadingCancelledSignal(Toolkit::Control control)
 171 {
 172   return GetControlImplementation(control)->mAccessibilityReadingCancelledSignal;
 173 }
 174
 175 Toolkit::DevelControl::AccessibilityReadingStoppedSignalType& AccessibilityReadingStoppedSignal(Toolkit::Control control)
 176 {
 177   return GetControlImplementation(control)->mAccessibilityReadingStoppedSignal;
 178 }
 179
 180 Toolkit::DevelControl::AccessibilityGetNameSignalType& AccessibilityGetNameSignal(Toolkit::Control control)
 181 {
 182   return GetControlImplementation(control)->mAccessibilityGetNameSignal;
 183 }
 184
 185 Toolkit::DevelControl::AccessibilityGetDescriptionSignalType& AccessibilityGetDescriptionSignal(Toolkit::Control control)
 186 {
 187   return GetControlImplementation(control)->mAccessibilityGetDescriptionSignal;
 188 }
 189
 190 Toolkit::DevelControl::AccessibilityDoGestureSignalType& AccessibilityDoGestureSignal(Toolkit::Control control)
 191 {
 192   return GetControlImplementation(control)->mAccessibilityDoGestureSignal;
 193 }
 194
 195 void AppendAccessibilityRelation(Dali::Actor control, Actor destination, Dali::Accessibility::RelationType relation)
 196 {
 197   if(auto controlDataImpl = GetControlImplementation(control))
 198   {
 199     auto index = static_cast<Dali::Property::Array::SizeType>(relation);
 200     if(index >= controlDataImpl->mAccessibilityRelations.size())
 201     {
 202       DALI_LOG_ERROR("Relation index exceeds vector size.");
 203       return;
 204     }
 205
 206     auto object = controlDataImpl->GetAccessibilityObject(destination);
 207     if(object)
 208     {
 209       controlDataImpl->mAccessibilityRelations[index].push_back(object->GetAddress());
 210     }
 211   }
 212 }
 213
 214 void RemoveAccessibilityRelation(Dali::Actor control, Actor destination, Dali::Accessibility::RelationType relation)
 215 {
 216   if(auto controlDataImpl = GetControlImplementation(control))
 217   {
 218     auto index = static_cast<Dali::Property::Array::SizeType>(relation);
 219     if(index >= controlDataImpl->mAccessibilityRelations.size())
 220     {
 221       DALI_LOG_ERROR("Relation index exceeds vector size.");
 222       return;
 223     }
 224
 225     auto object = controlDataImpl->GetAccessibilityObject(destination);
 226     if(!object)
 227     {
 228       return;
 229     }
 230
 231     auto address = object->GetAddress();
 232
 233     auto& targets = controlDataImpl->mAccessibilityRelations[index];
 234     for(auto i = 0u; i < targets.size(); ++i)
 235     {
 236       if(targets[i].ToString() == address.ToString())
 237       {
 238         targets[i] = targets.back();
 239         targets.erase(targets.end() - 1);
 240       }
 241     }
 242   }
 243 }
 244
 245 std::vector<std::vector<Accessibility::Address>> GetAccessibilityRelations(Dali::Actor control)
 246 {
 247   if(auto controlDataImpl = GetControlImplementation(control))
 248   {
 249     return controlDataImpl->mAccessibilityRelations;
 250   }
 251   return {};
 252 }
 253
 254 void ClearAccessibilityRelations(Dali::Actor control)
 255 {
 256   if(auto controlDataImpl = GetControlImplementation(control))
 257   {
 258     for(auto& it : controlDataImpl->mAccessibilityRelations)
 259     {
 260       it.clear();
 261     }
 262   }
 263 }
 264
 265 void SetAccessibilityConstructor(Dali::Actor control, std::function<std::unique_ptr<Dali::Accessibility::Accessible>(Dali::Actor)> constructor)
 266 {
 267   if(auto controlDataImpl = GetControlImplementation(control))
 268   {
 269     controlDataImpl->mAccessibilityConstructor = constructor;
 270   }
 271 }
 272
 273 void AppendAccessibilityAttribute(Dali::Actor control, const std::string& key, const std::string value)
 274 {
 275   if(auto controlDataImpl = GetControlImplementation(control))
 276   {
 277     controlDataImpl->AppendAccessibilityAttribute(key, value);
 278   }
 279 }
 280
 281 void RemoveAccessibilityAttribute(Dali::Actor control, const std::string& key)
 282 {
 283   if(auto controlDataImpl = GetControlImplementation(control))
 284   {
 285     controlDataImpl->RemoveAccessibilityAttribute(key);
 286   }
 287 }
 288
 289 void ClearAccessibilityAttributes(Dali::Actor control)
 290 {
 291   if(auto controlDataImpl = GetControlImplementation(control))
 292   {
 293     controlDataImpl->ClearAccessibilityAttributes();
 294   }
 295 }
 296
 297 void SetAccessibilityReadingInfoType(Dali::Actor control, const Dali::Accessibility::ReadingInfoTypes types)
 298 {
 299   if(auto controlDataImpl = GetControlImplementation(control))
 300   {
 301     controlDataImpl->SetAccessibilityReadingInfoType(types);
 302   }
 303 }
 304
 305 Dali::Accessibility::ReadingInfoTypes GetAccessibilityReadingInfoType(Dali::Actor control)
 306 {
 307   if(auto controlDataImpl = GetControlImplementation(control))
 308   {
 309     return controlDataImpl->GetAccessibilityReadingInfoType();
 310   }
 311   return {};
 312 }
 313
 314 bool ClearAccessibilityHighlight(Dali::Actor control)
 315 {
 316   if(auto controlDataImpl = GetControlImplementation(control))
 317   {
 318     auto object = dynamic_cast<Dali::Accessibility::Component*>(controlDataImpl->GetAccessibilityObject());
 319     if(object)
 320     {
 321       return object->ClearHighlight();
 322     }
 323   }
 324   return false;
 325 }
 326
 327 bool GrabAccessibilityHighlight(Dali::Actor control)
 328 {
 329   if(auto controlDataImpl = GetControlImplementation(control))
 330   {
 331     auto object = dynamic_cast<Dali::Accessibility::Component*>(controlDataImpl->GetAccessibilityObject());
 332     if(object)
 333     {
 334       return object->GrabHighlight();
 335     }
 336   }
 337   return false;
 338 }
 339
 340 Dali::Accessibility::States GetAccessibilityStates(Dali::Actor control)
 341 {
 342   if(auto controlDataImpl = GetControlImplementation(control))
 343   {
 344     auto object = dynamic_cast<Dali::Accessibility::Component*>(controlDataImpl->GetAccessibilityObject());
 345     if(object)
 346     {
 347       return object->GetStates();
 348     }
 349   }
 350   return {};
 351 }
 352
 353 void NotifyAccessibilityStateChange(Dali::Actor control, Dali::Accessibility::States states, bool isRecursive)
 354 {
 355   if(auto controlDataImpl = GetControlImplementation(control))
 356   {
 357     controlDataImpl->GetAccessibilityObject()->NotifyAccessibilityStateChange(std::move(states), isRecursive);
 358   }
 359 }
 360
 361 Dali::Accessibility::Accessible* GetBoundAccessibilityObject(Dali::Actor control)
 362 {
 363   return Dali::Accessibility::Accessible::Get(control);
 364 }
 365
 366 } // namespace DevelControl
 367
 368 } // namespace Toolkit
 369
 370 } // namespace Dali