[AT-SPI] Make DevelControl::GetAccessibilityRelations() equivalent to Accessible...
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / devel-api / controls / control-devel.cpp
old mode 100755 (executable)
new mode 100644 (file)
index a4685ff..51e0564
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2021 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
 #include "control-devel.h"
 
 // EXTERNAL INCLUDES
+#include <dali/public-api/actors/actor.h>
 #include <dali/public-api/animation/animation.h>
 
 // INTERNAL INCLUDES
+#include <dali-toolkit/devel-api/visual-factory/transition-data.h>
 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
 #include <dali-toolkit/public-api/controls/control-impl.h>
-#include <dali-toolkit/devel-api/visual-factory/transition-data.h>
+#include <dali-toolkit/public-api/controls/control.h>
 
-namespace Dali
+namespace
 {
+Dali::Toolkit::Internal::Control::Impl& GetControlImplementation(Dali::Toolkit::Control control)
+{
+  auto& internalControl = Dali::Toolkit::Internal::GetImplementation(control);
+
+  return Dali::Toolkit::Internal::Control::Impl::Get(internalControl);
+}
+
+} // unnamed namespace
 
+namespace Dali
+{
 namespace Toolkit
 {
-
 namespace DevelControl
 {
+void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual)
+{
+  Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(control);
+  controlDataImpl.RegisterVisual(index, visual);
+}
+
+void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, int depthIndex)
+{
+  Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(control);
+  controlDataImpl.RegisterVisual(index, visual, depthIndex);
+}
+
+void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, bool enabled)
+{
+  Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(control);
+  controlDataImpl.RegisterVisual(index, visual, enabled);
+}
+
+void RegisterVisual(Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, bool enabled, int depthIndex)
+{
+  Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(control);
+  controlDataImpl.RegisterVisual(index, visual, enabled, depthIndex);
+}
+
+void UnregisterVisual(Internal::Control& control, Dali::Property::Index index)
+{
+  Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(control);
+  controlDataImpl.UnregisterVisual(index);
+}
+
+Toolkit::Visual::Base GetVisual(const Internal::Control& control, Dali::Property::Index index)
+{
+  const Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(control);
+  return controlDataImpl.GetVisual(index);
+}
 
-void RegisterVisual( Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual )
+void EnableVisual(Internal::Control& control, Dali::Property::Index index, bool enable)
 {
-  Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get( control );
-  controlDataImpl.RegisterVisual( index, visual );
+  Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(control);
+  controlDataImpl.EnableVisual(index, enable);
 }
 
-void RegisterVisual( Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, int depthIndex )
+bool IsVisualEnabled(const Internal::Control& control, Dali::Property::Index index)
 {
-  Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get( control );
-  controlDataImpl.RegisterVisual( index, visual, depthIndex );
+  const Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(control);
+  return controlDataImpl.IsVisualEnabled(index);
 }
 
-void RegisterVisual( Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, bool enabled )
+Dali::Animation CreateTransition(Internal::Control& control, const Toolkit::TransitionData& handle)
 {
-  Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get( control );
-  controlDataImpl.RegisterVisual( index, visual, enabled );
+  Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(control);
+  return controlDataImpl.CreateTransition(handle);
 }
 
-void RegisterVisual( Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, bool enabled, int depthIndex )
+void AddTransitions(Internal::Control&             control,
+                    Dali::Animation                animation,
+                    const Toolkit::TransitionData& transitionData)
 {
-  Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get( control );
-  controlDataImpl.RegisterVisual( index, visual, enabled, depthIndex );
+  Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(control);
+  controlDataImpl.AddTransitions(animation, transitionData);
 }
 
-void UnregisterVisual( Internal::Control& control, Dali::Property::Index index )
+void DoAction(Control& control, Dali::Property::Index visualIndex, Dali::Property::Index actionId, const Dali::Property::Value attributes)
 {
-  Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get( control );
-  controlDataImpl.UnregisterVisual( index );
+  Internal::Control&       controlInternal = Toolkit::Internal::GetImplementation(control);
+  Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(controlInternal);
+  controlDataImpl.DoAction(visualIndex, actionId, attributes);
 }
 
-Toolkit::Visual::Base GetVisual( const Internal::Control& control, Dali::Property::Index index )
+void SetInputMethodContext(Internal::Control& control, InputMethodContext& inputMethodContext)
 {
-  const Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get( control );
-  return controlDataImpl.GetVisual( index );
+  Internal::Control::Impl::Get(control).SetInputMethodContext(inputMethodContext);
 }
 
-void EnableVisual( Internal::Control& control, Dali::Property::Index index, bool enable )
+VisualEventSignalType& VisualEventSignal(Control control)
 {
-  Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get( control );
-  controlDataImpl.EnableVisual( index, enable );
+  Internal::Control&       internalControl = Toolkit::Internal::GetImplementation(control);
+  Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(internalControl);
+  return controlDataImpl.VisualEventSignal();
 }
 
-bool IsVisualEnabled( const Internal::Control& control, Dali::Property::Index index )
+Dali::Property GetVisualProperty(Control control, Dali::Property::Index index, Dali::Property::Key visualPropertyKey)
 {
-  const Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get( control );
-  return controlDataImpl.IsVisualEnabled( index );
+  Internal::Control&       internalControl = Toolkit::Internal::GetImplementation(control);
+  Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(internalControl);
+  return controlDataImpl.GetVisualProperty(index, visualPropertyKey);
 }
 
-Dali::Animation CreateTransition( Internal::Control& control, const Toolkit::TransitionData& handle )
+Toolkit::DevelControl::AccessibilityActivateSignalType& AccessibilityActivateSignal(Toolkit::Control control)
 {
-  Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get( control );
-  return controlDataImpl.CreateTransition( handle );
+  return GetControlImplementation(control).mAccessibilityActivateSignal;
 }
 
+Toolkit::DevelControl::AccessibilityReadingSkippedSignalType& AccessibilityReadingSkippedSignal(Toolkit::Control control)
+{
+  return GetControlImplementation(control).mAccessibilityReadingSkippedSignal;
+}
 
-void AddTransitions( Internal::Control& control,
-                     Dali::Animation animation,
-                     const Toolkit::TransitionData& transitionData )
+Toolkit::DevelControl::AccessibilityReadingPausedSignalType& AccessibilityReadingPausedSignal(Toolkit::Control control)
 {
-  Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get( control );
-  controlDataImpl.AddTransitions( animation, transitionData );
+  return GetControlImplementation(control).mAccessibilityReadingPausedSignal;
 }
 
-void DoAction( Control& control, Dali::Property::Index visualIndex, Dali::Property::Index actionId, const Dali::Property::Value attributes )
+Toolkit::DevelControl::AccessibilityReadingResumedSignalType& AccessibilityReadingResumedSignal(Toolkit::Control control)
 {
-  Internal::Control& controlInternal = Toolkit::Internal::GetImplementation( control );
-  Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get( controlInternal );
-  controlDataImpl.DoAction( visualIndex, actionId, attributes );
+  return GetControlImplementation(control).mAccessibilityReadingResumedSignal;
 }
 
-void SetInputMethodContext( Internal::Control& control, InputMethodContext& inputMethodContext )
+Toolkit::DevelControl::AccessibilityReadingCancelledSignalType& AccessibilityReadingCancelledSignal(Toolkit::Control control)
 {
-  Internal::Control::Impl::Get( control ).SetInputMethodContext( inputMethodContext );
+  return GetControlImplementation(control).mAccessibilityReadingCancelledSignal;
 }
 
-Toolkit::LayoutItem GetLayout( Control control )
+Toolkit::DevelControl::AccessibilityReadingStoppedSignalType& AccessibilityReadingStoppedSignal(Toolkit::Control control)
 {
-  const Internal::Control& internalControl = Toolkit::Internal::GetImplementation( control );
-  const Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get( internalControl );
-  return Toolkit::LayoutItem( controlDataImpl.GetLayout().Get() );
+  return GetControlImplementation(control).mAccessibilityReadingStoppedSignal;
 }
 
-Toolkit::LayoutItem GetLayout( Internal::Control& control )
+Toolkit::DevelControl::AccessibilityGetNameSignalType& AccessibilityGetNameSignal(Toolkit::Control control)
 {
-  Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get( control );
-  return Toolkit::LayoutItem( controlDataImpl.GetLayout().Get() );
+  return GetControlImplementation(control).mAccessibilityGetNameSignal;
 }
 
-void SetLayout( Internal::Control& control, Toolkit::LayoutItem layout )
+Toolkit::DevelControl::AccessibilityGetDescriptionSignalType& AccessibilityGetDescriptionSignal(Toolkit::Control control)
 {
-  Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get( control );
-  controlDataImpl.SetLayout( GetImplementation( layout ) );
+  return GetControlImplementation(control).mAccessibilityGetDescriptionSignal;
 }
 
-void SetLayout( Control control, Toolkit::LayoutItem layout )
+Toolkit::DevelControl::AccessibilityDoGestureSignalType& AccessibilityDoGestureSignal(Toolkit::Control control)
 {
-  Internal::Control& internalControl = Toolkit::Internal::GetImplementation( control );
-  Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get( internalControl );
-  if( layout )
+  return GetControlImplementation(control).mAccessibilityDoGestureSignal;
+}
+
+void AppendAccessibilityRelation(Toolkit::Control control, Dali::Actor destination, Dali::Accessibility::RelationType relation)
+{
+  if(auto destinationAccessible = Accessibility::Accessible::Get(destination))
   {
-    controlDataImpl.SetLayout( GetImplementation( layout ) );
+    GetControlImplementation(control).mAccessibilityRelations[relation].insert(destinationAccessible);
   }
-  else
+}
+
+void RemoveAccessibilityRelation(Toolkit::Control control, Dali::Actor destination, Dali::Accessibility::RelationType relation)
+{
+  if(auto destinationAccessible = Accessibility::Accessible::Get(destination))
   {
-    controlDataImpl.RemoveLayout();
+    auto& relations = GetControlImplementation(control).mAccessibilityRelations;
+
+    relations[relation].erase(destinationAccessible);
+
+    if(relations[relation].empty())
+    {
+      relations.erase(relation);
+    }
   }
 }
 
+std::vector<Accessibility::Relation> GetAccessibilityRelations(Toolkit::Control control)
+{
+  const auto&                          relations = GetControlImplementation(control).mAccessibilityRelations;
+  std::vector<Accessibility::Relation> result;
+
+  for(auto& relation : relations)
+  {
+    auto& targets = relation.second;
+
+    result.emplace_back(Accessibility::Relation{relation.first, {}});
+    std::copy(targets.begin(), targets.end(), std::back_inserter(result.back().mTargets));
+  }
+
+  return result;
+}
+
+void ClearAccessibilityRelations(Toolkit::Control control)
+{
+  GetControlImplementation(control).mAccessibilityRelations.clear();
+}
+
+void AppendAccessibilityAttribute(Toolkit::Control control, const std::string& key, const std::string& value)
+{
+  GetControlImplementation(control).AppendAccessibilityAttribute(key, value);
+}
+
+void RemoveAccessibilityAttribute(Toolkit::Control control, const std::string& key)
+{
+  GetControlImplementation(control).RemoveAccessibilityAttribute(key);
+}
+
+void ClearAccessibilityAttributes(Toolkit::Control control)
+{
+  GetControlImplementation(control).ClearAccessibilityAttributes();
+}
+
+void SetAccessibilityReadingInfoType(Toolkit::Control control, const Dali::Accessibility::ReadingInfoTypes types)
+{
+  GetControlImplementation(control).SetAccessibilityReadingInfoType(types);
+}
+
+Dali::Accessibility::ReadingInfoTypes GetAccessibilityReadingInfoType(Toolkit::Control control)
+{
+  return GetControlImplementation(control).GetAccessibilityReadingInfoType();
+}
+
+bool ClearAccessibilityHighlight(Toolkit::Control control)
+{
+  return GetControlImplementation(control).GetAccessibleObject()->ClearHighlight();
+}
+
+bool GrabAccessibilityHighlight(Toolkit::Control control)
+{
+  return GetControlImplementation(control).GetAccessibleObject()->GrabHighlight();
+}
+
+Dali::Accessibility::States GetAccessibilityStates(Toolkit::Control control)
+{
+  return GetControlImplementation(control).GetAccessibleObject()->GetStates();
+}
+
+void NotifyAccessibilityStateChange(Toolkit::Control control, Dali::Accessibility::States states, bool recurse)
+{
+  GetControlImplementation(control).GetAccessibleObject()->NotifyAccessibilityStateChange(std::move(states), recurse);
+}
+
 } // namespace DevelControl
 
 } // namespace Toolkit