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-impl.h>
  23 #include <dali/devel-api/adaptor-framework/accessibility.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   if(order == 0)
  84     return;
  85
  86   if(order >= mFocusOrder.size())
  87     mFocusOrder.resize(order + 1);
  88
  89   auto it = mFocusOrder.begin() + order;
  90   mFocusOrder.insert(it, actor);
  91
  92   if(order > 0)
  93   {
  94     Actor prev = mFocusOrder[order - 1];
  95     DevelControl::AppendAccessibilityRelation(prev, actor, Accessibility::RelationType::FLOWS_TO);
  96     DevelControl::AppendAccessibilityRelation(actor, prev, Accessibility::RelationType::FLOWS_FROM);
  97   }
  98
  99   if(order + 1 < mFocusOrder.size())
 100   {
 101     Actor next = mFocusOrder[order + 1];
 102     DevelControl::AppendAccessibilityRelation(actor, next, Accessibility::RelationType::FLOWS_TO);
 103     DevelControl::AppendAccessibilityRelation(next, actor, Accessibility::RelationType::FLOWS_FROM);
 104   }
 105 }
 106
 107 unsigned int AccessibilityManager::GetFocusOrder(Actor actor) const
 108 {
 109   for(auto it = mFocusOrder.begin(); it != mFocusOrder.end(); ++it)
 110   {
 111     if(actor == *it)
 112       return it - mFocusOrder.begin();
 113   }
 114
 115   return 0;
 116 }
 117
 118 unsigned int AccessibilityManager::GenerateNewFocusOrder() const
 119 {
 120   return static_cast<unsigned>(mFocusOrder.size());
 121 }
 122
 123 Actor AccessibilityManager::GetActorByFocusOrder(const unsigned int order)
 124 {
 125   Actor actor;
 126
 127   if(order > 0 && order < mFocusOrder.size())
 128     actor = mFocusOrder[order];
 129
 130   return actor;
 131 }
 132
 133 bool AccessibilityManager::SetCurrentFocusActor(Actor actor)
 134 {
 135   return Toolkit::DevelControl::GrabAccessibilityHighlight(actor);
 136 }
 137
 138 Actor AccessibilityManager::GetCurrentFocusActor()
 139 {
 140   return Dali::Accessibility::Accessible::GetCurrentlyHighlightedActor();
 141 }
 142
 143 Actor AccessibilityManager::GetCurrentFocusGroup()
 144 {
 145   return GetFocusGroup(GetCurrentFocusActor());
 146 }
 147
 148 unsigned int AccessibilityManager::GetCurrentFocusOrder()
 149 {
 150   auto     actor = GetCurrentFocusActor();
 151   unsigned order = 0;
 152
 153   if(actor)
 154     order = GetFocusOrder(actor);
 155
 156   return order;
 157 }
 158
 159 bool AccessibilityManager::MoveFocusForward()
 160 {
 161   unsigned current = GetCurrentFocusOrder();
 162
 163   if(current + 1 < mFocusOrder.size())
 164     return SetCurrentFocusActor(mFocusOrder[current + 1]);
 165
 166   return false;
 167 }
 168
 169 bool AccessibilityManager::MoveFocusBackward()
 170 {
 171   unsigned current = GetCurrentFocusOrder();
 172
 173   if(current > 1) // zero has a special meaning
 174     return SetCurrentFocusActor(mFocusOrder[current - 1]);
 175
 176   return false;
 177 }
 178
 179 void AccessibilityManager::ClearFocus()
 180 {
 181   auto actor = GetCurrentFocusActor();
 182   Toolkit::DevelControl::ClearAccessibilityHighlight(actor);
 183 }
 184
 185 void AccessibilityManager::Reset()
 186 {
 187   ClearFocus();
 188
 189   for(std::size_t i = 2; i < mFocusOrder.size(); ++i)
 190   {
 191     Actor prev = mFocusOrder[i - 1];
 192     Actor next = mFocusOrder[i];
 193
 194     DevelControl::RemoveAccessibilityRelation(prev, next, Accessibility::RelationType::FLOWS_TO);
 195     DevelControl::RemoveAccessibilityRelation(next, prev, Accessibility::RelationType::FLOWS_FROM);
 196   }
 197
 198   mFocusOrder.clear();
 199   mFocusOrder.push_back({});
 200 }
 201
 202 void AccessibilityManager::SetFocusGroup(Actor actor, bool isFocusGroup)
 203 {
 204 }
 205
 206 bool AccessibilityManager::IsFocusGroup(Actor actor) const
 207 {
 208   return false;
 209 }
 210
 211 Actor AccessibilityManager::GetFocusGroup(Actor actor)
 212 {
 213   return {};
 214 }
 215
 216 Vector2 AccessibilityManager::GetReadPosition() const
 217 {
 218   return {};
 219 }
 220
 221 void AccessibilityManager::SetGroupMode(bool enabled)
 222 {
 223 }
 224
 225 bool AccessibilityManager::GetGroupMode() const
 226 {
 227   return false;
 228 }
 229
 230 void AccessibilityManager::SetWrapMode(bool wrapped)
 231 {
 232 }
 233
 234 bool AccessibilityManager::GetWrapMode() const
 235 {
 236   return true;
 237 }
 238
 239 void AccessibilityManager::SetFocusIndicatorActor(Actor indicator)
 240 {
 241   Dali::Accessibility::Accessible::SetHighlightActor(indicator);
 242 }
 243
 244 Actor AccessibilityManager::GetFocusIndicatorActor()
 245 {
 246   return Dali::Accessibility::Accessible::GetHighlightActor();
 247 }
 248
 249 Toolkit::AccessibilityManager::FocusChangedSignalType& AccessibilityManager::FocusChangedSignal()
 250 {
 251   return mFocusChangedSignal;
 252 }
 253
 254 Toolkit::AccessibilityManager::FocusOvershotSignalType& AccessibilityManager::FocusOvershotSignal()
 255 {
 256   return mFocusOvershotSignal;
 257 }
 258
 259 Toolkit::AccessibilityManager::FocusedActorActivatedSignalType& AccessibilityManager::FocusedActorActivatedSignal()
 260 {
 261   return mFocusedActorActivatedSignal;
 262 }
 263
 264 } // namespace Internal
 265
 266 } // namespace Toolkit
 267
 268 } // namespace Dali