1 #ifndef DALI_TOOLKIT_INTERNAL_ACCESSIBILITY_MANAGER_H
2 #define DALI_TOOLKIT_INTERNAL_ACCESSIBILITY_MANAGER_H
5 * Copyright (c) 2019 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
23 #include <dali/devel-api/common/map-wrapper.h>
24 #include <dali/public-api/object/base-object.h>
27 #include <dali-toolkit/public-api/accessibility-manager/accessibility-manager.h>
28 #include <dali/public-api/adaptor-framework/tts-player.h>
39 class AccessibilityManager;
42 * @copydoc Toolkit::AccessibilityManager
44 class AccessibilityManager : public Dali::BaseObject, public Dali::ConnectionTracker
48 typedef Dali::Toolkit::AccessibilityManager::AccessibilityActionSignalType AccessibilityActionSignalType;
49 typedef Dali::Toolkit::AccessibilityManager::AccessibilityActionScrollSignalType AccessibilityActionScrollSignalType;
51 struct ActorAdditionalInfo
58 unsigned int mFocusOrder; ///< The focus order of the actor. It is undefined by default.
60 std::string mAccessibilityAttributes[Toolkit::AccessibilityManager::ACCESSIBILITY_ATTRIBUTE_NUM]; ///< The array of attribute texts
63 typedef std::pair<unsigned int, unsigned int> FocusIDPair;
64 typedef std::map<unsigned int, unsigned int> FocusIDContainer;
65 typedef FocusIDContainer::iterator FocusIDIter;
66 typedef FocusIDContainer::const_iterator FocusIDConstIter;
68 typedef std::pair<unsigned int, ActorAdditionalInfo> IDAdditionalInfoPair;
69 typedef std::map<unsigned int, ActorAdditionalInfo> IDAdditionalInfoContainer;
70 typedef IDAdditionalInfoContainer::iterator IDAdditionalInfoIter;
71 typedef IDAdditionalInfoContainer::const_iterator IDAdditionalInfoConstIter;
74 * Construct a new AccessibilityManager.
76 AccessibilityManager();
79 * Initialise the AccessibilityManager
84 * @copydoc Toolkit::AccessibilityManager::SetAccessibilityAttribute
86 void SetAccessibilityAttribute(Actor actor, Toolkit::AccessibilityManager::AccessibilityAttribute type, const std::string& text);
89 * @copydoc Toolkit::AccessibilityManager::GetAccessibilityAttribute
91 std::string GetAccessibilityAttribute(Actor actor, Toolkit::AccessibilityManager::AccessibilityAttribute type) const;
94 * @copydoc Toolkit::AccessibilityManager::SetFocusOrder
96 void SetFocusOrder(Actor actor, const unsigned int order);
99 * @copydoc Toolkit::AccessibilityManager::GetFocusOrder
101 unsigned int GetFocusOrder(Actor actor) const;
104 * @copydoc Toolkit::AccessibilityManager::GenerateNewFocusOrder
106 unsigned int GenerateNewFocusOrder() const;
109 * @copydoc Toolkit::AccessibilityManager::GetActorByFocusOrder
111 Actor GetActorByFocusOrder(const unsigned int order);
114 * @copydoc Toolkit::AccessibilityManager::SetCurrentFocusActor
116 bool SetCurrentFocusActor(Actor actor);
119 * @copydoc Toolkit::AccessibilityManager::GetCurrentFocusActor
121 Actor GetCurrentFocusActor();
124 * @copydoc Toolkit::AccessibilityManager::GetCurrentFocusGroup
126 Actor GetCurrentFocusGroup();
129 * @copydoc Toolkit::AccessibilityManager::GetCurrentFocusOrder
131 unsigned int GetCurrentFocusOrder();
134 * @copydoc Toolkit::AccessibilityManager::MoveFocusForward
136 bool MoveFocusForward();
139 * @copydoc Toolkit::AccessibilityManager::MoveFocusBackward
141 bool MoveFocusBackward();
144 * @copydoc Toolkit::AccessibilityManager::ClearFocus
149 * @copydoc Toolkit::AccessibilityManager::Reset
154 * @copydoc Toolkit::AccessibilityManager::SetFocusGroup
156 void SetFocusGroup(Actor actor, bool isFocusGroup);
159 * @copydoc Toolkit::AccessibilityManager::IsFocusGroup
161 bool IsFocusGroup(Actor actor) const;
164 * @copydoc Toolkit::AccessibilityManager::SetGroupMode
166 void SetGroupMode(bool enabled);
169 * @copydoc Toolkit::AccessibilityManager::GetGroupMode
171 bool GetGroupMode() const;
174 * @copydoc Toolkit::AccessibilityManager::SetWrapMode
176 void SetWrapMode(bool wrapped);
179 * @copydoc Toolkit::AccessibilityManager::GetWrapMode
181 bool GetWrapMode() const;
184 * @copydoc Toolkit::AccessibilityManager::SetFocusIndicatorActor
186 void SetFocusIndicatorActor(Actor indicator);
189 * @copydoc Toolkit::AccessibilityManager::GetFocusIndicatorActor
191 Actor GetFocusIndicatorActor();
194 * @copydoc Toolkit::AccessibilityManager::GetFocusGroup
196 Actor GetFocusGroup(Actor actor);
199 * @copydoc Toolkit::AccessibilityManager::GetReadPosition
201 Vector2 GetReadPosition() const;
206 * @copydoc Toolkit::AccessibilityManager::FocusChangedSignal()
208 Toolkit::AccessibilityManager::FocusChangedSignalType& FocusChangedSignal();
211 * @copydoc Toolkit::AccessibilityManager::FocusOvershotSignal()
213 Toolkit::AccessibilityManager::FocusOvershotSignalType& FocusOvershotSignal();
216 * @copydoc Toolkit::AccessibilityManager::FocusedActorActivatedSignal()
218 Toolkit::AccessibilityManager::FocusedActorActivatedSignalType& FocusedActorActivatedSignal();
223 * @copydoc Dali::Toolkit::AccessibilityManager::StatusChangedSignal
225 AccessibilityActionSignalType& StatusChangedSignal()
227 return mStatusChangedSignal;
231 * @copydoc Dali::Toolkit::AccessibilityManager::AccessibilityAdaptor::ActionNextSignal
233 AccessibilityActionSignalType& ActionNextSignal()
235 return mActionNextSignal;
239 * @copydoc Dali::Toolkit::AccessibilityManager::ActionPreviousSignal
241 AccessibilityActionSignalType& ActionPreviousSignal()
243 return mActionPreviousSignal;
247 * @copydoc Dali::Toolkit::AccessibilityManager::ActionActivateSignal
249 AccessibilityActionSignalType& ActionActivateSignal()
251 return mActionActivateSignal;
255 * @copydoc Dali::Toolkit::AccessibilityManager::ActionOverSignal
257 AccessibilityActionSignalType& ActionOverSignal()
259 return mActionOverSignal;
263 * @copydoc Dali::Toolkit::AccessibilityManager::ActionReadSignal
265 AccessibilityActionSignalType& ActionReadSignal()
267 return mActionReadSignal;
271 * @copydoc Dali::Toolkit::AccessibilityManager::ActionReadNextSignal
273 AccessibilityActionSignalType& ActionReadNextSignal()
275 return mActionReadNextSignal;
279 * @copydoc Dali::Toolkit::AccessibilityManager::ActionReadPreviousSignal
281 AccessibilityActionSignalType& ActionReadPreviousSignal()
283 return mActionReadPreviousSignal;
287 * @copydoc Dali::Toolkit::AccessibilityManager::ActionUpSignal
289 AccessibilityActionSignalType& ActionUpSignal()
291 return mActionUpSignal;
295 * @copydoc Dali::Toolkit::AccessibilityManager::ActionDownSignal
297 AccessibilityActionSignalType& ActionDownSignal()
299 return mActionDownSignal;
303 * @copydoc Dali::Toolkit::AccessibilityManager::ActionClearFocusSignal
305 AccessibilityActionSignalType& ActionClearFocusSignal()
307 return mActionClearFocusSignal;
311 * @copydoc Dali::Toolkit::AccessibilityManager::ActionBackSignal
313 AccessibilityActionSignalType& ActionBackSignal()
315 return mActionBackSignal;
319 * @copydoc Dali::Toolkit::AccessibilityManager::ActionScrollUpSignal
321 AccessibilityActionSignalType& ActionScrollUpSignal()
323 return mActionScrollUpSignal;
327 * @copydoc Dali::Toolkit::AccessibilityManager::ActionScrollDownSignal
329 AccessibilityActionSignalType& ActionScrollDownSignal()
331 return mActionScrollDownSignal;
335 * @copydoc Dali::Toolkit::AccessibilityManager::ActionPageLeftSignal
337 AccessibilityActionSignalType& ActionPageLeftSignal()
339 return mActionPageLeftSignal;
343 * @copydoc Dali::Toolkit::AccessibilityManager::ActionPageRightSignal
345 AccessibilityActionSignalType& ActionPageRightSignal()
347 return mActionPageRightSignal;
351 * @copydoc Dali::Toolkit::AccessibilityManager::ActionPageUpSignal
353 AccessibilityActionSignalType& ActionPageUpSignal()
355 return mActionPageUpSignal;
359 * @copydoc Dali::Toolkit::AccessibilityManager::ActionPageDownSignal
361 AccessibilityActionSignalType& ActionPageDownSignal()
363 return mActionPageDownSignal;
367 * @copydoc Dali::Toolkit::AccessibilityManager::ActionMoveToFirstSignal
369 AccessibilityActionSignalType& ActionMoveToFirstSignal()
371 return mActionMoveToFirstSignal;
375 * @copydoc Dali::Toolkit::AccessibilityManager::ActionMoveToLastSignal
377 AccessibilityActionSignalType& ActionMoveToLastSignal()
379 return mActionMoveToLastSignal;
383 * @copydoc Dali::Toolkit::AccessibilityManager::ActionReadFromTopSignal
385 AccessibilityActionSignalType& ActionReadFromTopSignal()
387 return mActionReadFromTopSignal;
391 * @copydoc Dali::Toolkit::AccessibilityManager::ActionReadFromNextSignal
393 AccessibilityActionSignalType& ActionReadFromNextSignal()
395 return mActionReadFromNextSignal;
399 * @copydoc Dali::Toolkit::AccessibilityManager::ActionZoomSignal
401 AccessibilityActionSignalType& ActionZoomSignal()
403 return mActionZoomSignal;
407 * @copydoc Dali::Toolkit::AccessibilityManager::ActionReadIndicatorInformationSignal
409 AccessibilityActionSignalType& ActionReadIndicatorInformationSignal()
411 return mActionReadIndicatorInformationSignal;
415 * @copydoc Dali::Toolkit::AccessibilityManager::ActionReadPauseResumeSignal
417 AccessibilityActionSignalType& ActionReadPauseResumeSignal()
419 return mActionReadPauseResumeSignal;
423 * @copydoc Dali::Toolkit::AccessibilityManager::ActionStartStopSignal
425 AccessibilityActionSignalType& ActionStartStopSignal()
427 return mActionStartStopSignal;
431 * @copydoc Dali::Toolkit::AccessibilityManager::ActionScrollSignal
433 AccessibilityActionScrollSignalType& ActionScrollSignal()
435 return mActionScrollSignal;
443 virtual ~AccessibilityManager();
446 AccessibilityActionSignalType mStatusChangedSignal;
447 AccessibilityActionSignalType mActionNextSignal;
448 AccessibilityActionSignalType mActionPreviousSignal;
449 AccessibilityActionSignalType mActionActivateSignal;
450 AccessibilityActionSignalType mActionOverSignal;
451 AccessibilityActionSignalType mActionReadSignal;
452 AccessibilityActionSignalType mActionReadNextSignal;
453 AccessibilityActionSignalType mActionReadPreviousSignal;
454 AccessibilityActionSignalType mActionUpSignal;
455 AccessibilityActionSignalType mActionDownSignal;
456 AccessibilityActionSignalType mActionClearFocusSignal;
457 AccessibilityActionSignalType mActionBackSignal;
458 AccessibilityActionSignalType mActionScrollUpSignal;
459 AccessibilityActionSignalType mActionScrollDownSignal;
460 AccessibilityActionSignalType mActionPageLeftSignal;
461 AccessibilityActionSignalType mActionPageRightSignal;
462 AccessibilityActionSignalType mActionPageUpSignal;
463 AccessibilityActionSignalType mActionPageDownSignal;
464 AccessibilityActionSignalType mActionMoveToFirstSignal;
465 AccessibilityActionSignalType mActionMoveToLastSignal;
466 AccessibilityActionSignalType mActionReadFromTopSignal;
467 AccessibilityActionSignalType mActionReadFromNextSignal;
468 AccessibilityActionSignalType mActionZoomSignal;
469 AccessibilityActionSignalType mActionReadIndicatorInformationSignal;
470 AccessibilityActionSignalType mActionReadPauseResumeSignal;
471 AccessibilityActionSignalType mActionStartStopSignal;
472 AccessibilityActionScrollSignalType mActionScrollSignal;
473 Toolkit::AccessibilityManager::FocusChangedSignalType mFocusChangedSignal;
474 Toolkit::AccessibilityManager::FocusOvershotSignalType mFocusOvershotSignal;
475 Toolkit::AccessibilityManager::FocusedActorActivatedSignalType mFocusedActorActivatedSignal;
478 } // namespace Internal
480 inline Internal::AccessibilityManager& GetImpl(Dali::Toolkit::AccessibilityManager& obj)
482 DALI_ASSERT_ALWAYS(obj);
484 Dali::BaseObject& handle = obj.GetBaseObject();
486 return static_cast<Internal::AccessibilityManager&>(handle);
489 inline const Internal::AccessibilityManager& GetImpl(const Dali::Toolkit::AccessibilityManager& obj)
491 DALI_ASSERT_ALWAYS(obj);
493 const Dali::BaseObject& handle = obj.GetBaseObject();
495 return static_cast<const Internal::AccessibilityManager&>(handle);
498 } // namespace Toolkit
502 #endif // DALI_TOOLKIT_INTERNAL_ACCESSIBILITY_MANAGER_H