dali-toolkit/devel-api/controls/control-accessible.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-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) || self.GetProperty<Vector4>(Actor::Property::WORLD_COLOR).a == 0 || 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]     = (Dali::DevelActor::IsHittable(self) && Dali::DevelActor::GetTouchRequired(self));
 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 void ControlAccessible::UpdateAttributes(Accessibility::Attributes& attributes) const
 237 {
 238   static const std::string automationIdKey = "automationId";
 239
 240   ActorAccessible::UpdateAttributes(attributes);
 241
 242   Toolkit::Control control      = Toolkit::Control::DownCast(Self());
 243   auto             automationId = control.GetProperty<std::string>(DevelControl::Property::AUTOMATION_ID);
 244
 245   if(automationId.empty())
 246   {
 247     attributes.erase(automationIdKey);
 248   }
 249   else
 250   {
 251     attributes.insert_or_assign(automationIdKey, std::move(automationId));
 252   }
 253 }
 254
 255 bool ControlAccessible::IsHidden() const
 256 {
 257   auto control = Dali::Toolkit::Control::DownCast(Self());
 258
 259   Internal::Control&       internalControl = Toolkit::Internal::GetImplementation(control);
 260   Internal::Control::Impl& controlImpl     = Internal::Control::Impl::Get(internalControl);
 261
 262   return controlImpl.mAccessibilityHidden;
 263 }
 264
 265 bool ControlAccessible::GrabFocus()
 266 {
 267   return Toolkit::KeyboardFocusManager::Get().SetCurrentFocusActor(Self());
 268 }
 269
 270 void ControlAccessible::ScrollToSelf()
 271 {
 272   auto* child = this;
 273   auto* parent = dynamic_cast<Toolkit::DevelControl::ControlAccessible*>(child->GetParent());
 274
 275   while (parent)
 276   {
 277     if (parent->IsScrollable())
 278     {
 279       parent->ScrollToChild(child->Self());
 280     }
 281
 282     parent = dynamic_cast<Toolkit::DevelControl::ControlAccessible*>(parent->GetParent());
 283   }
 284 }
 285
 286 void ControlAccessible::RegisterPositionPropertyNotification()
 287 {
 288   auto                     control         = Dali::Toolkit::Control::DownCast(Self());
 289   Internal::Control&       internalControl = Toolkit::Internal::GetImplementation(control);
 290   Internal::Control::Impl& controlImpl     = Internal::Control::Impl::Get(internalControl);
 291   controlImpl.RegisterAccessibilityPositionPropertyNotification();
 292 }
 293
 294 void ControlAccessible::UnregisterPositionPropertyNotification()
 295 {
 296   auto                     control         = Dali::Toolkit::Control::DownCast(Self());
 297   Internal::Control&       internalControl = Toolkit::Internal::GetImplementation(control);
 298   Internal::Control::Impl& controlImpl     = Internal::Control::Impl::Get(internalControl);
 299   controlImpl.UnregisterAccessibilityPositionPropertyNotification();
 300 }
 301
 302 bool ControlAccessible::GrabHighlight()
 303 {
 304   Dali::Actor self = Self();
 305   auto oldHighlightedActor = GetCurrentlyHighlightedActor();
 306
 307   if(!Dali::Accessibility::IsUp())
 308   {
 309     return false;
 310   }
 311
 312   if(self == oldHighlightedActor)
 313   {
 314     return true;
 315   }
 316
 317   // Clear the old highlight.
 318   if(oldHighlightedActor)
 319   {
 320     auto oldHighlightedObject = Dali::Accessibility::Component::DownCast(Accessible::Get(oldHighlightedActor));
 321     if(oldHighlightedObject)
 322     {
 323       oldHighlightedObject->ClearHighlight();
 324     }
 325   }
 326
 327   auto highlight = GetHighlightActor();
 328   if(!highlight)
 329   {
 330     highlight = CreateHighlightIndicatorActor();
 331     SetHighlightActor(highlight);
 332   }
 333
 334   highlight.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_LEFT);
 335   highlight.SetProperty(Actor::Property::POSITION_Z, 1.0f);
 336   highlight.SetProperty(Actor::Property::POSITION, Vector2(0.0f, 0.0f));
 337
 338   // Need to set resize policy again, to update SIZE property which is set by
 339   // NUIViewAccessible. The highlight could move from NUIViewAccessible to
 340   // ControlAccessible. In this case, highlight has incorrect size.
 341   highlight.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS);
 342
 343   // Remember the highlight actor, so that when the default is changed with
 344   // SetHighlightActor(), the currently displayed highlight can still be cleared.
 345   mCurrentHighlightActor = highlight;
 346   ScrollToSelf();
 347   self.Add(highlight);
 348   SetCurrentlyHighlightedActor(self);
 349   EmitHighlighted(true);
 350   RegisterPositionPropertyNotification();
 351
 352   return true;
 353 }
 354
 355 bool ControlAccessible::ClearHighlight()
 356 {
 357   Dali::Actor self = Self();
 358
 359   if(!Dali::Accessibility::IsUp())
 360   {
 361     return false;
 362   }
 363
 364   if(GetCurrentlyHighlightedActor() == self)
 365   {
 366     UnregisterPositionPropertyNotification();
 367     self.Remove(mCurrentHighlightActor.GetHandle());
 368     mCurrentHighlightActor = {};
 369     SetCurrentlyHighlightedActor({});
 370     EmitHighlighted(false);
 371     return true;
 372   }
 373   return false;
 374 }
 375
 376 std::string ControlAccessible::GetActionName(size_t index) const
 377 {
 378   if(index >= GetActionCount())
 379   {
 380     return {};
 381   }
 382
 383   Dali::TypeInfo type;
 384   Self().GetTypeInfo(type);
 385   DALI_ASSERT_ALWAYS(type && "no TypeInfo object");
 386   return type.GetActionName(index);
 387 }
 388
 389 std::string ControlAccessible::GetLocalizedActionName(size_t index) const
 390 {
 391   return GetLocaleText(GetActionName(index));
 392 }
 393
 394 std::string ControlAccessible::GetActionDescription(size_t index) const
 395 {
 396   return {};
 397 }
 398
 399 size_t ControlAccessible::GetActionCount() const
 400 {
 401   Dali::TypeInfo type;
 402   Self().GetTypeInfo(type);
 403   DALI_ASSERT_ALWAYS(type && "no TypeInfo object");
 404   return type.GetActionCount();
 405 }
 406
 407 std::string ControlAccessible::GetActionKeyBinding(size_t index) const
 408 {
 409   return {};
 410 }
 411
 412 bool ControlAccessible::DoAction(size_t index)
 413 {
 414   std::string actionName = GetActionName(index);
 415   return Self().DoAction(actionName, {});
 416 }
 417
 418 bool ControlAccessible::DoAction(const std::string& name)
 419 {
 420   return Self().DoAction(name, {});
 421 }
 422
 423 bool ControlAccessible::DoGesture(const Dali::Accessibility::GestureInfo& gestureInfo)
 424 {
 425   auto control = Dali::Toolkit::Control::DownCast(Self());
 426
 427   Internal::Control&       internalControl = Toolkit::Internal::GetImplementation(control);
 428   Internal::Control::Impl& controlImpl     = Internal::Control::Impl::Get(internalControl);
 429
 430   if(!controlImpl.mAccessibilityDoGestureSignal.Empty())
 431   {
 432     auto ret = std::make_pair(gestureInfo, false);
 433     controlImpl.mAccessibilityDoGestureSignal.Emit(ret);
 434     return ret.second;
 435   }
 436
 437   return false;
 438 }
 439
 440 std::vector<Dali::Accessibility::Relation> ControlAccessible::GetRelationSet()
 441 {
 442   auto control = Dali::Toolkit::Control::DownCast(Self());
 443
 444   return DevelControl::GetAccessibilityRelations(control);
 445 }
 446
 447 bool ControlAccessible::ScrollToChild(Actor child)
 448 {
 449   return false;
 450 }
 451
 452 Dali::Property::Index ControlAccessible::GetNamePropertyIndex()
 453 {
 454   return Actor::Property::NAME;
 455 }
 456
 457 Dali::Property::Index ControlAccessible::GetDescriptionPropertyIndex()
 458 {
 459   return Dali::Property::INVALID_INDEX;
 460 }
 461
 462 void ControlAccessible::SetLastPosition(Vector2 position)
 463 {
 464   mLastPosition = position;
 465 }
 466
 467 Vector2 ControlAccessible::GetLastPosition() const
 468 {
 469   return mLastPosition;
 470 }
 471
 472 } // namespace Dali::Toolkit::DevelControl