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

   1 /*
   2  * Copyright (c) 2022 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-accessible.h"
  20
  21 // EXTERNAL INCLUDES
  22 #ifdef DGETTEXT_ENABLED
  23 #include <libintl.h>
  24 #endif
  25
  26 #include <dali/devel-api/actors/actor-devel.h>
  27 #include <dali/devel-api/adaptor-framework/window-devel.h>
  28
  29 // INTERNAL INCLUDES
  30 #include <dali-toolkit/devel-api/asset-manager/asset-manager.h>
  31 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
  32 #include <dali-toolkit/public-api/controls/control-impl.h>
  33 #include <dali-toolkit/public-api/controls/control.h>
  34 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
  35 #include <dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h>
  36
  37 namespace Dali::Toolkit::DevelControl
  38 {
  39 namespace
  40 {
  41 static std::string GetLocaleText(std::string string, const char* domain = "dali-toolkit")
  42 {
  43 #ifdef DGETTEXT_ENABLED
  44   /*TODO: currently non-localized string is used as a key for translation lookup. In case the lookup key formatting is forced
  45           consider calling utility function for converting non-localized string into well-formatted key before lookup. */
  46   return dgettext(domain, string.c_str());
  47 #else
  48   return string;
  49 #endif
  50 }
  51
  52 static Dali::Actor CreateHighlightIndicatorActor()
  53 {
  54   std::string focusBorderImagePath(AssetManager::GetDaliImagePath());
  55   focusBorderImagePath += "/keyboard_focus.9.png";
  56
  57   // Create the default if it hasn't been set and one that's shared by all the
  58   // keyboard focusable actors
  59   auto actor = Toolkit::ImageView::New(focusBorderImagePath);
  60   actor.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS);
  61
  62   DevelControl::AppendAccessibilityAttribute(actor, "highlight", std::string());
  63   actor.SetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE, false);
  64
  65   return actor;
  66 }
  67 } // unnamed namespace
  68
  69 ControlAccessible::ControlAccessible(Dali::Actor self)
  70 : ActorAccessible(self)
  71 {
  72   auto control = Toolkit::Control::DownCast(self);
  73
  74   Internal::Control&       internalControl = Toolkit::Internal::GetImplementation(control);
  75   Internal::Control::Impl& controlImpl     = Internal::Control::Impl::Get(internalControl);
  76
  77   self.PropertySetSignal().Connect(&controlImpl, [this, &controlImpl](Dali::Handle& handle, Dali::Property::Index index, Dali::Property::Value value) {
  78     if(this->Self() != Dali::Accessibility::Accessible::GetCurrentlyHighlightedActor())
  79     {
  80       return;
  81     }
  82
  83     if(index == DevelControl::Property::ACCESSIBILITY_NAME || (index == GetNamePropertyIndex() && controlImpl.mAccessibilityName.empty()))
  84     {
  85       if(controlImpl.mAccessibilityGetNameSignal.Empty())
  86       {
  87         Emit(Dali::Accessibility::ObjectPropertyChangeEvent::NAME);
  88       }
  89     }
  90
  91     if(index == DevelControl::Property::ACCESSIBILITY_DESCRIPTION || (index == GetDescriptionPropertyIndex() && controlImpl.mAccessibilityDescription.empty()))
  92     {
  93       if(controlImpl.mAccessibilityGetDescriptionSignal.Empty())
  94       {
  95         Emit(Dali::Accessibility::ObjectPropertyChangeEvent::DESCRIPTION);
  96       }
  97     }
  98   });
  99 }
 100
 101 std::string ControlAccessible::GetName() const
 102 {
 103   auto control = Dali::Toolkit::Control::DownCast(Self());
 104
 105   Internal::Control&       internalControl = Toolkit::Internal::GetImplementation(control);
 106   Internal::Control::Impl& controlImpl     = Internal::Control::Impl::Get(internalControl);
 107   std::string              name;
 108
 109   if(!controlImpl.mAccessibilityGetNameSignal.Empty())
 110   {
 111     controlImpl.mAccessibilityGetNameSignal.Emit(name);
 112   }
 113   else if(!controlImpl.mAccessibilityName.empty())
 114   {
 115     name = controlImpl.mAccessibilityName;
 116   }
 117   else if(auto raw = GetNameRaw(); !raw.empty())
 118   {
 119     name = raw;
 120   }
 121   else
 122   {
 123     name = Self().GetProperty<std::string>(Actor::Property::NAME);
 124   }
 125
 126   if(!controlImpl.mAccessibilityTranslationDomain.empty())
 127   {
 128     return GetLocaleText(name, controlImpl.mAccessibilityTranslationDomain.c_str());
 129   }
 130
 131   return GetLocaleText(name);
 132 }
 133
 134 std::string ControlAccessible::GetNameRaw() const
 135 {
 136   return {};
 137 }
 138
 139 std::string ControlAccessible::GetDescription() const
 140 {
 141   auto control = Dali::Toolkit::Control::DownCast(Self());
 142
 143   Internal::Control&       internalControl = Toolkit::Internal::GetImplementation(control);
 144   Internal::Control::Impl& controlImpl     = Internal::Control::Impl::Get(internalControl);
 145   std::string              description;
 146
 147   if(!controlImpl.mAccessibilityGetDescriptionSignal.Empty())
 148   {
 149     controlImpl.mAccessibilityGetDescriptionSignal.Emit(description);
 150   }
 151   else if(!controlImpl.mAccessibilityDescription.empty())
 152   {
 153     description = controlImpl.mAccessibilityDescription;
 154   }
 155   else
 156   {
 157     description = GetDescriptionRaw();
 158   }
 159
 160   if(!controlImpl.mAccessibilityTranslationDomain.empty())
 161   {
 162     return GetLocaleText(description, controlImpl.mAccessibilityTranslationDomain.c_str());
 163   }
 164
 165   return GetLocaleText(description);
 166 }
 167
 168 std::string ControlAccessible::GetDescriptionRaw() const
 169 {
 170   return {};
 171 }
 172
 173 Dali::Accessibility::Role ControlAccessible::GetRole() const
 174 {
 175   return Self().GetProperty<Dali::Accessibility::Role>(Toolkit::DevelControl::Property::ACCESSIBILITY_ROLE);
 176 }
 177
 178 std::string ControlAccessible::GetLocalizedRoleName() const
 179 {
 180   return GetLocaleText(GetRoleName());
 181 }
 182
 183 bool ControlAccessible::IsShowing()
 184 {
 185   Dali::Actor self = Self();
 186   if(!self.GetProperty<bool>(Actor::Property::VISIBLE) || Dali::EqualsZero(self.GetProperty<Vector4>(Actor::Property::WORLD_COLOR).a) || self.GetProperty<bool>(Dali::DevelActor::Property::CULLED))
 187   {
 188     return false;
 189   }
 190
 191   auto* child  = this;
 192   auto* parent = dynamic_cast<Toolkit::DevelControl::ControlAccessible*>(child->GetParent());
 193   if(!parent)
 194   {
 195     return true;
 196   }
 197
 198   while(parent)
 199   {
 200     auto control = Dali::Toolkit::Control::DownCast(parent->Self());
 201     if(!control.GetProperty<bool>(Actor::Property::VISIBLE))
 202     {
 203       return false;
 204     }
 205     parent = dynamic_cast<Toolkit::DevelControl::ControlAccessible*>(parent->GetParent());
 206   }
 207
 208   return true;
 209 }
 210
 211 Dali::Accessibility::States ControlAccessible::CalculateStates()
 212 {
 213   using Dali::Accessibility::State;
 214
 215   Dali::Actor                 self = Self();
 216   Dali::Accessibility::States states;
 217
 218   states[State::FOCUSABLE]     = self.GetProperty<bool>(Actor::Property::KEYBOARD_FOCUSABLE);
 219   states[State::FOCUSED]       = Toolkit::KeyboardFocusManager::Get().GetCurrentFocusActor() == self;
 220   states[State::HIGHLIGHTABLE] = self.GetProperty<bool>(Toolkit::DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE);
 221   states[State::HIGHLIGHTED]   = GetCurrentlyHighlightedActor() == self;
 222   states[State::ENABLED]       = true;
 223   states[State::SENSITIVE]     = self.GetProperty<bool>(Actor::Property::SENSITIVE);
 224   states[State::VISIBLE]       = self.GetProperty<bool>(Actor::Property::VISIBLE);
 225   states[State::SHOWING]       = IsShowing();
 226   states[State::DEFUNCT]       = !self.GetProperty(Dali::DevelActor::Property::CONNECTED_TO_SCENE).Get<bool>();
 227
 228   return states;
 229 }
 230
 231 Dali::Accessibility::States ControlAccessible::GetStates()
 232 {
 233   return CalculateStates();
 234 }
 235
 236 Dali::Accessibility::Attributes ControlAccessible::GetAttributes() const
 237 {
 238   std::unordered_map<std::string, std::string> attributeMap;
 239   auto                                         control   = Dali::Toolkit::Control::DownCast(Self());
 240   auto                                         attribute = control.GetProperty(Dali::Toolkit::DevelControl::Property::ACCESSIBILITY_ATTRIBUTES);
 241   auto                                         map       = attribute.GetMap();
 242
 243   if(map)
 244   {
 245     auto mapSize = map->Count();
 246
 247     for(unsigned int i = 0; i < mapSize; i++)
 248     {
 249       auto mapKey = map->GetKeyAt(i);
 250       if(mapKey.type == Dali::Property::Key::STRING)
 251       {
 252         std::string mapValue;
 253         if(map->GetValue(i).Get(mapValue))
 254         {
 255           attributeMap.emplace(std::move(mapKey.stringKey), std::move(mapValue));
 256         }
 257       }
 258     }
 259   }
 260
 261   auto automationId = control.GetProperty<std::string>(Dali::Toolkit::DevelControl::Property::AUTOMATION_ID);
 262   if(!automationId.empty())
 263   {
 264     attributeMap.emplace("automationId", std::move(automationId));
 265   }
 266
 267   return attributeMap;
 268 }
 269
 270 bool ControlAccessible::IsHidden() const
 271 {
 272   auto control = Dali::Toolkit::Control::DownCast(Self());
 273
 274   Internal::Control&       internalControl = Toolkit::Internal::GetImplementation(control);
 275   Internal::Control::Impl& controlImpl     = Internal::Control::Impl::Get(internalControl);
 276
 277   return controlImpl.mAccessibilityHidden;
 278 }
 279
 280 bool ControlAccessible::GrabFocus()
 281 {
 282   return Toolkit::KeyboardFocusManager::Get().SetCurrentFocusActor(Self());
 283 }
 284
 285 void ControlAccessible::ScrollToSelf()
 286 {
 287   auto* child  = this;
 288   auto* parent = dynamic_cast<Toolkit::DevelControl::ControlAccessible*>(child->GetParent());
 289
 290   while(parent)
 291   {
 292     if(parent->IsScrollable())
 293     {
 294       parent->ScrollToChild(child->Self());
 295     }
 296
 297     parent = dynamic_cast<Toolkit::DevelControl::ControlAccessible*>(parent->GetParent());
 298   }
 299 }
 300
 301 void ControlAccessible::RegisterPositionPropertyNotification()
 302 {
 303   auto                     control         = Dali::Toolkit::Control::DownCast(Self());
 304   Internal::Control&       internalControl = Toolkit::Internal::GetImplementation(control);
 305   Internal::Control::Impl& controlImpl     = Internal::Control::Impl::Get(internalControl);
 306   controlImpl.RegisterAccessibilityPositionPropertyNotification();
 307 }
 308
 309 void ControlAccessible::UnregisterPositionPropertyNotification()
 310 {
 311   auto                     control         = Dali::Toolkit::Control::DownCast(Self());
 312   Internal::Control&       internalControl = Toolkit::Internal::GetImplementation(control);
 313   Internal::Control::Impl& controlImpl     = Internal::Control::Impl::Get(internalControl);
 314   controlImpl.UnregisterAccessibilityPositionPropertyNotification();
 315 }
 316
 317 bool ControlAccessible::GrabHighlight()
 318 {
 319   Dali::Actor self                = Self();
 320   auto        oldHighlightedActor = GetCurrentlyHighlightedActor();
 321
 322   if(!Dali::Accessibility::IsUp())
 323   {
 324     return false;
 325   }
 326
 327   if(self == oldHighlightedActor)
 328   {
 329     return true;
 330   }
 331
 332   // Clear the old highlight.
 333   if(oldHighlightedActor)
 334   {
 335     auto oldHighlightedObject = Dali::Accessibility::Component::DownCast(Accessible::Get(oldHighlightedActor));
 336     if(oldHighlightedObject)
 337     {
 338       oldHighlightedObject->ClearHighlight();
 339     }
 340   }
 341
 342   auto highlight = GetHighlightActor();
 343   if(!highlight)
 344   {
 345     highlight = CreateHighlightIndicatorActor();
 346     SetHighlightActor(highlight);
 347   }
 348
 349   highlight.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_LEFT);
 350   highlight.SetProperty(Actor::Property::POSITION_Z, 1.0f);
 351   highlight.SetProperty(Actor::Property::POSITION, Vector2(0.0f, 0.0f));
 352
 353   // Need to set resize policy again, to update SIZE property which is set by
 354   // NUIViewAccessible. The highlight could move from NUIViewAccessible to
 355   // ControlAccessible. In this case, highlight has incorrect size.
 356   highlight.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS);
 357
 358   // Remember the highlight actor, so that when the default is changed with
 359   // SetHighlightActor(), the currently displayed highlight can still be cleared.
 360   mCurrentHighlightActor = highlight;
 361   ScrollToSelf();
 362   self.Add(highlight);
 363   SetCurrentlyHighlightedActor(self);
 364   EmitHighlighted(true);
 365   RegisterPositionPropertyNotification();
 366
 367   return true;
 368 }
 369
 370 bool ControlAccessible::ClearHighlight()
 371 {
 372   Dali::Actor self = Self();
 373
 374   if(!Dali::Accessibility::IsUp())
 375   {
 376     return false;
 377   }
 378
 379   if(GetCurrentlyHighlightedActor() == self)
 380   {
 381     UnregisterPositionPropertyNotification();
 382     self.Remove(mCurrentHighlightActor.GetHandle());
 383     mCurrentHighlightActor = {};
 384     SetCurrentlyHighlightedActor({});
 385     EmitHighlighted(false);
 386     return true;
 387   }
 388   return false;
 389 }
 390
 391 std::string ControlAccessible::GetActionName(size_t index) const
 392 {
 393   if(index >= GetActionCount())
 394   {
 395     return {};
 396   }
 397
 398   Dali::TypeInfo type;
 399   Self().GetTypeInfo(type);
 400   DALI_ASSERT_ALWAYS(type && "no TypeInfo object");
 401   return type.GetActionName(index);
 402 }
 403
 404 std::string ControlAccessible::GetLocalizedActionName(size_t index) const
 405 {
 406   return GetLocaleText(GetActionName(index));
 407 }
 408
 409 std::string ControlAccessible::GetActionDescription(size_t index) const
 410 {
 411   return {};
 412 }
 413
 414 size_t ControlAccessible::GetActionCount() const
 415 {
 416   Dali::TypeInfo type;
 417   Self().GetTypeInfo(type);
 418   DALI_ASSERT_ALWAYS(type && "no TypeInfo object");
 419   return type.GetActionCount();
 420 }
 421
 422 std::string ControlAccessible::GetActionKeyBinding(size_t index) const
 423 {
 424   return {};
 425 }
 426
 427 bool ControlAccessible::DoAction(size_t index)
 428 {
 429   std::string actionName = GetActionName(index);
 430   return Self().DoAction(actionName, {});
 431 }
 432
 433 bool ControlAccessible::DoAction(const std::string& name)
 434 {
 435   return Self().DoAction(name, {});
 436 }
 437
 438 bool ControlAccessible::DoGesture(const Dali::Accessibility::GestureInfo& gestureInfo)
 439 {
 440   auto control = Dali::Toolkit::Control::DownCast(Self());
 441
 442   Internal::Control&       internalControl = Toolkit::Internal::GetImplementation(control);
 443   Internal::Control::Impl& controlImpl     = Internal::Control::Impl::Get(internalControl);
 444
 445   if(!controlImpl.mAccessibilityDoGestureSignal.Empty())
 446   {
 447     auto ret = std::make_pair(gestureInfo, false);
 448     controlImpl.mAccessibilityDoGestureSignal.Emit(ret);
 449     return ret.second;
 450   }
 451
 452   return false;
 453 }
 454
 455 std::vector<Dali::Accessibility::Relation> ControlAccessible::GetRelationSet()
 456 {
 457   auto control = Dali::Toolkit::Control::DownCast(Self());
 458
 459   return DevelControl::GetAccessibilityRelations(control);
 460 }
 461
 462 bool ControlAccessible::ScrollToChild(Actor child)
 463 {
 464   return false;
 465 }
 466
 467 Dali::Property::Index ControlAccessible::GetNamePropertyIndex()
 468 {
 469   return Actor::Property::NAME;
 470 }
 471
 472 Dali::Property::Index ControlAccessible::GetDescriptionPropertyIndex()
 473 {
 474   return Dali::Property::INVALID_INDEX;
 475 }
 476
 477 void ControlAccessible::SetLastPosition(Vector2 position)
 478 {
 479   mLastPosition = position;
 480 }
 481
 482 Vector2 ControlAccessible::GetLastPosition() const
 483 {
 484   return mLastPosition;
 485 }
 486
 487 } // namespace Dali::Toolkit::DevelControl