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

   1 /*
   2  * Copyright (c) 2020 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.h>
  29 #include <dali-toolkit/public-api/controls/control-impl.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 static Toolkit::Internal::Control::Impl *GetControlImplementationIfAny( Dali::Actor actor)
 126 {
 127   Dali::Toolkit::Control c = Toolkit::Control::DownCast( actor );
 128   if ( c )
 129   {
 130     auto &impl1 = Toolkit::Internal::GetImplementation( c );
 131     auto &impl2 = Toolkit::Internal::Control::Impl::Get( impl1 );
 132     return &impl2;
 133   }
 134   return nullptr;
 135 }
 136
 137 Toolkit::DevelControl::AccessibilityActivateSignalType &AccessibilityActivateSignal( Toolkit::Control control )
 138 {
 139   auto ac = GetControlImplementationIfAny ( control );
 140   return ac->mAccessibilityActivateSignal;
 141 }
 142
 143 Toolkit::DevelControl::AccessibilityReadingSkippedSignalType &AccessibilityReadingSkippedSignal( Toolkit::Control control )
 144 {
 145   auto ac = GetControlImplementationIfAny ( control );
 146   return ac->mAccessibilityReadingSkippedSignal;
 147 }
 148
 149 Toolkit::DevelControl::AccessibilityReadingPausedSignalType &AccessibilityReadingPausedSignal( Toolkit::Control control )
 150 {
 151   auto ac = GetControlImplementationIfAny ( control );
 152   return ac->mAccessibilityReadingPausedSignal;
 153 }
 154
 155 Toolkit::DevelControl::AccessibilityReadingResumedSignalType &AccessibilityReadingResumedSignal( Toolkit::Control control )
 156 {
 157   auto ac = GetControlImplementationIfAny ( control );
 158   return ac->mAccessibilityReadingResumedSignal;
 159 }
 160
 161 Toolkit::DevelControl::AccessibilityReadingCancelledSignalType &AccessibilityReadingCancelledSignal( Toolkit::Control control )
 162 {
 163   auto ac = GetControlImplementationIfAny ( control );
 164   return ac->mAccessibilityReadingCancelledSignal;
 165 }
 166
 167 Toolkit::DevelControl::AccessibilityReadingStoppedSignalType &AccessibilityReadingStoppedSignal( Toolkit::Control control )
 168 {
 169   auto ac = GetControlImplementationIfAny ( control );
 170   return ac->mAccessibilityReadingStoppedSignal;
 171 }
 172
 173 Toolkit::DevelControl::AccessibilityGetNameSignalType &AccessibilityGetNameSignal( Toolkit::Control control )
 174 {
 175   auto ac = GetControlImplementationIfAny ( control );
 176   return ac->mAccessibilityGetNameSignal;
 177 }
 178
 179 Toolkit::DevelControl::AccessibilityGetDescriptionSignalType &AccessibilityGetDescriptionSignal( Toolkit::Control control )
 180 {
 181   auto ac = GetControlImplementationIfAny ( control );
 182   return ac->mAccessibilityGetDescriptionSignal;
 183 }
 184
 185 Toolkit::DevelControl::AccessibilityDoGestureSignalType &AccessibilityDoGestureSignal( Toolkit::Control control )
 186 {
 187   auto ac = GetControlImplementationIfAny ( control );
 188   return ac->mAccessibilityDoGestureSignal;
 189 }
 190
 191 void AppendAccessibilityRelation( Dali::Actor control, Actor destination, Dali::Accessibility::RelationType relation)
 192 {
 193   if ( auto ac = GetControlImplementationIfAny ( control ) )
 194   {
 195     auto index = static_cast<Dali::Property::Array::SizeType>(relation);
 196     if (index >= ac->mAccessibilityRelations.size())
 197     {
 198         DALI_LOG_ERROR( "Relation index exceeds vector size." );
 199         return;
 200     }
 201
 202     auto obj = ac->GetAccessibilityObject(destination);
 203     if (obj)
 204       ac->mAccessibilityRelations[index].push_back(obj->GetAddress());
 205   }
 206 }
 207
 208 void RemoveAccessibilityRelation( Dali::Actor control, Actor destination, Dali::Accessibility::RelationType relation)
 209 {
 210   if ( auto ac = GetControlImplementationIfAny ( control ) )
 211   {
 212     auto index = static_cast<Dali::Property::Array::SizeType>(relation);
 213     if (index >= ac->mAccessibilityRelations.size())
 214     {
 215         DALI_LOG_ERROR( "Relation index exceeds vector size." );
 216         return;
 217     }
 218
 219     auto obj = ac->GetAccessibilityObject(destination);
 220     if (!obj)
 221       return;
 222
 223     auto address = obj->GetAddress();
 224
 225     auto &targets = ac->mAccessibilityRelations[index];
 226     for (auto i = 0u; i < targets.size(); ++i) {
 227         if (targets[i].ToString() == address.ToString())
 228         {
 229             targets[i] = targets.back();
 230             targets.erase(targets.end() - 1);
 231         }
 232     }
 233   }
 234 }
 235
 236 std::vector<std::vector<Accessibility::Address>> GetAccessibilityRelations( Dali::Actor control )
 237 {
 238   if ( auto ac = GetControlImplementationIfAny ( control ) )
 239   {
 240     return ac->mAccessibilityRelations;
 241   }
 242   return {};
 243 }
 244
 245 void ClearAccessibilityRelations( Dali::Actor control )
 246 {
 247   if ( auto ac = GetControlImplementationIfAny ( control ) )
 248   {
 249     for (auto &it : ac->mAccessibilityRelations)
 250       it.clear();
 251   }
 252 }
 253
 254 void SetAccessibilityConstructor( Dali::Actor control,
 255         std::function< std::unique_ptr< Dali::Accessibility::Accessible >( Dali::Actor ) > constructor )
 256 {
 257   if ( auto ac = GetControlImplementationIfAny ( control ) )
 258   {
 259     ac->accessibilityConstructor = constructor;
 260   }
 261 }
 262
 263 void AppendAccessibilityAttribute( Dali::Actor control, const std::string& key,
 264                                          const std::string value )
 265 {
 266   if ( auto ac = GetControlImplementationIfAny ( control ) )
 267   {
 268     ac->AppendAccessibilityAttribute( key, value );
 269   }
 270 }
 271
 272 void RemoveAccessibilityAttribute( Dali::Actor control, const std::string& key )
 273 {
 274   if ( auto ac = GetControlImplementationIfAny ( control ) )
 275   {
 276     ac->RemoveAccessibilityAttribute( key );
 277   }
 278 }
 279
 280 void ClearAccessibilityAttributes( Dali::Actor control )
 281 {
 282   if ( auto ac = GetControlImplementationIfAny ( control ) )
 283   {
 284     ac->ClearAccessibilityAttributes();
 285   }
 286 }
 287
 288 void SetAccessibilityReadingInfoType( Dali::Actor control, const Dali::Accessibility::ReadingInfoTypes types )
 289 {
 290   if ( auto ac = GetControlImplementationIfAny ( control ) )
 291   {
 292     ac->SetAccessibilityReadingInfoType( types );
 293   }
 294 }
 295
 296 Dali::Accessibility::ReadingInfoTypes GetAccessibilityReadingInfoType(Dali::Actor control )
 297 {
 298   if ( auto ac = GetControlImplementationIfAny ( control ) )
 299   {
 300     return ac->GetAccessibilityReadingInfoType();
 301   }
 302   return {};
 303 }
 304
 305 bool ClearAccessibilityHighlight( Dali::Actor control )
 306 {
 307   if ( auto ac = GetControlImplementationIfAny ( control ) )
 308   {
 309     auto ptr = dynamic_cast<Dali::Accessibility::Component*>( ac->GetAccessibilityObject() );
 310     if( ptr )
 311       return ptr->ClearHighlight();
 312   }
 313   return false;
 314 }
 315
 316 bool GrabAccessibilityHighlight( Dali::Actor control )
 317 {
 318   if ( auto ac = GetControlImplementationIfAny ( control ) )
 319   {
 320     auto ptr = dynamic_cast<Dali::Accessibility::Component*>( ac->GetAccessibilityObject() );
 321     if( ptr )
 322       return ptr->GrabHighlight();
 323   }
 324   return false;
 325 }
 326
 327 Dali::Accessibility::States GetAccessibilityStates( Dali::Actor control )
 328 {
 329   if ( auto ac = GetControlImplementationIfAny ( control ) )
 330   {
 331     auto ptr = dynamic_cast<Dali::Accessibility::Component*>( ac->GetAccessibilityObject() );
 332     if(ptr)
 333       return ptr->GetStates();
 334   }
 335   return {};
 336 }
 337
 338 void NotifyAccessibilityStateChange( Dali::Actor control, Dali::Accessibility::States states, bool doRecursive )
 339 {
 340   if ( auto ac = GetControlImplementationIfAny ( control ) )
 341   {
 342     ac->GetAccessibilityObject()->NotifyAccessibilityStateChange( std::move(states), doRecursive );
 343   }
 344 }
 345
 346 Dali::Accessibility::Accessible *GetBoundAccessibilityObject( Dali::Actor control )
 347 {
 348   return Dali::Accessibility::Accessible::Get( control );
 349 }
 350
 351 } // namespace DevelControl
 352
 353 } // namespace Toolkit
 354
 355 } // namespace Dali