dali-toolkit/internal/accessibility-manager/accessibility-manager-impl.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 "accessibility-manager-impl.h"
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/devel-api/adaptor-framework/accessibility.h>
  23 #include <dali/devel-api/adaptor-framework/accessibility-bridge.h>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali-toolkit/devel-api/controls/control-devel.h>
  27 #include <dali-toolkit/public-api/controls/control-impl.h>
  28 #include <dali-toolkit/public-api/controls/control.h>
  29
  30 namespace Dali
  31 {
  32 namespace Toolkit
  33 {
  34 namespace Internal
  35 {
  36 AccessibilityManager::AccessibilityManager()
  37 {
  38   mFocusOrder.push_back({}); // zero has a special meaning
  39 }
  40
  41 AccessibilityManager::~AccessibilityManager()
  42 {
  43 }
  44
  45 void AccessibilityManager::SetAccessibilityAttribute(Actor actor, Toolkit::AccessibilityManager::AccessibilityAttribute type, const std::string& text)
  46 {
  47   switch(type)
  48   {
  49     case Toolkit::AccessibilityManager::ACCESSIBILITY_LABEL:
  50       actor.SetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_NAME, text);
  51       break;
  52
  53     case Toolkit::AccessibilityManager::ACCESSIBILITY_HINT:
  54       actor.SetProperty(Toolkit::DevelControl::Property::ACCESSIBILITY_DESCRIPTION, text);
  55       break;
  56
  57     case Toolkit::AccessibilityManager::ACCESSIBILITY_TRAIT:
  58     case Toolkit::AccessibilityManager::ACCESSIBILITY_VALUE:
  59     default:
  60       break;
  61   }
  62 }
  63
  64 std::string AccessibilityManager::GetAccessibilityAttribute(Actor actor, Toolkit::AccessibilityManager::AccessibilityAttribute type) const
  65 {
  66   switch(type)
  67   {
  68     case Toolkit::AccessibilityManager::ACCESSIBILITY_LABEL:
  69       return actor.GetProperty<std::string>(Toolkit::DevelControl::Property::ACCESSIBILITY_NAME);
  70
  71     case Toolkit::AccessibilityManager::ACCESSIBILITY_HINT:
  72       return actor.GetProperty<std::string>(Toolkit::DevelControl::Property::ACCESSIBILITY_DESCRIPTION);
  73
  74     case Toolkit::AccessibilityManager::ACCESSIBILITY_TRAIT:
  75     case Toolkit::AccessibilityManager::ACCESSIBILITY_VALUE:
  76     default:
  77       return "";
  78   }
  79 }
  80
  81 void AccessibilityManager::SetFocusOrder(Actor actor, const unsigned int order)
  82 {
  83   auto control = Toolkit::Control::DownCast(actor);
  84
  85   if(!control || order == 0)
  86   {
  87     return;
  88   }
  89
  90   if(order >= mFocusOrder.size())
  91   {
  92     mFocusOrder.resize(order + 1);
  93   }
  94
  95   auto it = mFocusOrder.begin() + order;
  96   mFocusOrder.insert(it, control);
  97
  98   if(order > 0)
  99   {
 100     if(auto prev = mFocusOrder[order - 1])
 101     {
 102       DevelControl::AppendAccessibilityRelation(prev, control, Accessibility::RelationType::FLOWS_TO);
 103       DevelControl::AppendAccessibilityRelation(control, prev, Accessibility::RelationType::FLOWS_FROM);
 104     }
 105   }
 106
 107   if(order + 1 < mFocusOrder.size())
 108   {
 109     if(auto next = mFocusOrder[order + 1])
 110     {
 111       DevelControl::AppendAccessibilityRelation(control, next, Accessibility::RelationType::FLOWS_TO);
 112       DevelControl::AppendAccessibilityRelation(next, control, Accessibility::RelationType::FLOWS_FROM);
 113     }
 114   }
 115 }
 116
 117 unsigned int AccessibilityManager::GetFocusOrder(Actor actor) const
 118 {
 119   for(auto it = mFocusOrder.begin(); it != mFocusOrder.end(); ++it)
 120   {
 121     if(actor == *it)
 122       return it - mFocusOrder.begin();
 123   }
 124
 125   return 0;
 126 }
 127
 128 unsigned int AccessibilityManager::GenerateNewFocusOrder() const
 129 {
 130   return static_cast<unsigned>(mFocusOrder.size());
 131 }
 132
 133 Actor AccessibilityManager::GetActorByFocusOrder(const unsigned int order)
 134 {
 135   Actor actor;
 136
 137   if(order > 0 && order < mFocusOrder.size())
 138     actor = mFocusOrder[order];
 139
 140   return actor;
 141 }
 142
 143 bool AccessibilityManager::SetCurrentFocusActor(Actor actor)
 144 {
 145   auto control = Toolkit::Control::DownCast(actor);
 146   if(!control)
 147   {
 148     return false;
 149   }
 150
 151   return Toolkit::DevelControl::GrabAccessibilityHighlight(control);
 152 }
 153
 154 Actor AccessibilityManager::GetCurrentFocusActor()
 155 {
 156   return Dali::Accessibility::Accessible::GetCurrentlyHighlightedActor();
 157 }
 158
 159 Actor AccessibilityManager::GetCurrentFocusGroup()
 160 {
 161   return GetFocusGroup(GetCurrentFocusActor());
 162 }
 163
 164 unsigned int AccessibilityManager::GetCurrentFocusOrder()
 165 {
 166   auto     actor = GetCurrentFocusActor();
 167   unsigned order = 0;
 168
 169   if(actor)
 170     order = GetFocusOrder(actor);
 171
 172   return order;
 173 }
 174
 175 bool AccessibilityManager::MoveFocusForward()
 176 {
 177   unsigned current = GetCurrentFocusOrder();
 178
 179   if(current + 1 < mFocusOrder.size())
 180     return SetCurrentFocusActor(mFocusOrder[current + 1]);
 181
 182   return false;
 183 }
 184
 185 bool AccessibilityManager::MoveFocusBackward()
 186 {
 187   unsigned current = GetCurrentFocusOrder();
 188
 189   if(current > 1) // zero has a special meaning
 190     return SetCurrentFocusActor(mFocusOrder[current - 1]);
 191
 192   return false;
 193 }
 194
 195 void AccessibilityManager::ClearFocus()
 196 {
 197   auto control = Toolkit::Control::DownCast(GetCurrentFocusActor());
 198   if(!control)
 199   {
 200     return;
 201   }
 202
 203   Toolkit::DevelControl::ClearAccessibilityHighlight(control);
 204 }
 205
 206 void AccessibilityManager::Reset()
 207 {
 208   ClearFocus();
 209
 210   for(std::size_t i = 2; i < mFocusOrder.size(); ++i)
 211   {
 212     auto prev = mFocusOrder[i - 1];
 213     auto next = mFocusOrder[i];
 214
 215     if(prev && next)
 216     {
 217       DevelControl::RemoveAccessibilityRelation(prev, next, Accessibility::RelationType::FLOWS_TO);
 218       DevelControl::RemoveAccessibilityRelation(next, prev, Accessibility::RelationType::FLOWS_FROM);
 219     }
 220   }
 221
 222   mFocusOrder.clear();
 223   mFocusOrder.push_back({});
 224 }
 225
 226 void AccessibilityManager::SetFocusGroup(Actor actor, bool isFocusGroup)
 227 {
 228 }
 229
 230 bool AccessibilityManager::IsFocusGroup(Actor actor) const
 231 {
 232   return false;
 233 }
 234
 235 Actor AccessibilityManager::GetFocusGroup(Actor actor)
 236 {
 237   return {};
 238 }
 239
 240 Vector2 AccessibilityManager::GetReadPosition() const
 241 {
 242   return {};
 243 }
 244
 245 void AccessibilityManager::SetGroupMode(bool enabled)
 246 {
 247 }
 248
 249 bool AccessibilityManager::GetGroupMode() const
 250 {
 251   return false;
 252 }
 253
 254 void AccessibilityManager::SetWrapMode(bool wrapped)
 255 {
 256 }
 257
 258 bool AccessibilityManager::GetWrapMode() const
 259 {
 260   return true;
 261 }
 262
 263 void AccessibilityManager::SetFocusIndicatorActor(Actor indicator)
 264 {
 265   Dali::Accessibility::Accessible::SetHighlightActor(indicator);
 266 }
 267
 268 Actor AccessibilityManager::GetFocusIndicatorActor()
 269 {
 270   return Dali::Accessibility::Accessible::GetHighlightActor();
 271 }
 272
 273 Toolkit::AccessibilityManager::FocusChangedSignalType& AccessibilityManager::FocusChangedSignal()
 274 {
 275   return mFocusChangedSignal;
 276 }
 277
 278 Toolkit::AccessibilityManager::FocusOvershotSignalType& AccessibilityManager::FocusOvershotSignal()
 279 {
 280   return mFocusOvershotSignal;
 281 }
 282
 283 Toolkit::AccessibilityManager::FocusedActorActivatedSignalType& AccessibilityManager::FocusedActorActivatedSignal()
 284 {
 285   return mFocusedActorActivatedSignal;
 286 }
 287
 288 } // namespace Internal
 289
 290 } // namespace Toolkit
 291
 292 } // namespace Dali