[AT-SPI] Fix role setting
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / controls / popup / popup-impl.cpp
index 8672c4a..94a0ead 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2020 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.
@@ -26,9 +26,9 @@
 #include <dali/integration-api/debug.h>
 #include <dali/public-api/adaptor-framework/key.h>
 #include <dali/public-api/animation/constraints.h>
-#include <dali/public-api/common/stage.h>
+#include <dali/devel-api/common/stage.h>
 #include <dali/public-api/events/key-event.h>
-#include <dali/public-api/events/touch-data.h>
+#include <dali/public-api/events/touch-event.h>
 #include <dali/public-api/object/type-registry.h>
 #include <dali/devel-api/scripting/scripting.h>
 #include <dali/devel-api/actors/actor-devel.h>
 #include <dali-toolkit/internal/focus-manager/keyboard-focus-manager-impl.h>
 #include <dali-toolkit/public-api/controls/control-impl.h>
 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
-#include <dali-toolkit/public-api/accessibility-manager/accessibility-manager.h>
 #include <dali-toolkit/public-api/visuals/color-visual-properties.h>
 #include <dali-toolkit/public-api/visuals/visual-properties.h>
 #include <dali-toolkit/internal/focus-manager/keyboard-focus-manager-impl.h>
+#include <dali-toolkit/internal/controls/control/control-data-impl.h>
 
 using namespace Dali;
 
@@ -82,7 +82,7 @@ BaseHandle CreateToast()
   Toolkit::Popup popup = Toolkit::Popup::New();
 
   // Setup for Toast Popup type.
-  popup.SetSizeModeFactor( DEFAULT_TOAST_WIDTH_OF_STAGE_RATIO );
+  popup.SetProperty( Actor::Property::SIZE_MODE_FACTOR, DEFAULT_TOAST_WIDTH_OF_STAGE_RATIO );
   popup.SetResizePolicy( ResizePolicy::SIZE_RELATIVE_TO_PARENT, Dimension::WIDTH );
   popup.SetResizePolicy( ResizePolicy::USE_NATURAL_SIZE, Dimension::HEIGHT );
   popup.SetProperty( Toolkit::Popup::Property::CONTEXTUAL_MODE, Toolkit::Popup::NON_CONTEXTUAL );
@@ -282,7 +282,7 @@ void Popup::OnInitialize()
   self.SetProperty( Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER );
   self.SetProperty( Actor::Property::ANCHOR_POINT, AnchorPoint::CENTER );
 
-  self.SetSizeModeFactor( DEFAULT_POPUP_PARENT_RELATIVE_SIZE );
+  self.SetProperty( Actor::Property::SIZE_MODE_FACTOR, DEFAULT_POPUP_PARENT_RELATIVE_SIZE );
   self.SetResizePolicy( ResizePolicy::SIZE_RELATIVE_TO_PARENT, Dimension::WIDTH );
   self.SetResizePolicy( ResizePolicy::USE_NATURAL_SIZE, Dimension::HEIGHT );
 
@@ -325,23 +325,30 @@ void Popup::OnInitialize()
 
   mPopupLayout.SetResizePolicy( ResizePolicy::USE_ASSIGNED_SIZE, Dimension::WIDTH );
   mPopupLayout.SetResizePolicy( ResizePolicy::USE_NATURAL_SIZE, Dimension::HEIGHT );
-  mPopupLayout.SetSize( Stage::GetCurrent().GetSize().x * DEFAULT_RELATIVE_PARENT_WIDTH, 0.0f );
+  mPopupLayout.SetProperty( Actor::Property::SIZE, Vector2( Stage::GetCurrent().GetSize().x * DEFAULT_RELATIVE_PARENT_WIDTH, 0.0f ) );
 
   mPopupLayout.SetFitHeight( 0 ); // Set row to fit.
   mPopupLayout.SetFitHeight( 1 ); // Set row to fit.
 
-  mPopupLayout.TouchSignal().Connect( this, &Popup::OnDialogTouched );
-
   mPopupContainer.Add( mPopupLayout );
 
   // Any content after this point which is added to Self() will be re-parented to mContent.
   mAlterAddedChild = true;
 
   SetAsKeyboardFocusGroup( true );
+
+  SetupTouch();
+
+  DevelControl::SetAccessibilityConstructor( self, []( Dali::Actor actor ) {
+    return std::unique_ptr< Dali::Accessibility::Accessible >(
+      new Control::Impl::AccessibleImpl( actor, Dali::Accessibility::Role::DIALOG, true ) );
+  } );
 }
 
 Popup::~Popup()
 {
+  if( DevelControl::GetBoundAccessibilityObject( Self() ) )
+    Accessibility::Bridge::GetCurrentBridge()->RemovePopup( DevelControl::GetBoundAccessibilityObject( Self() ) );
   mEntryAnimationData.Clear();
   mExitAnimationData.Clear();
 }
@@ -354,14 +361,14 @@ void Popup::LayoutAnimation()
     case Toolkit::Popup::ZOOM:
     {
       // Zoom animations start fully zoomed out.
-      mPopupContainer.SetScale( Vector3::ZERO );
+      mPopupContainer.SetProperty( Actor::Property::SCALE, Vector3::ZERO );
       break;
     }
 
     case Toolkit::Popup::FADE:
     {
       // Fade animations start transparent.
-      mPopupContainer.SetProperty( DevelActor::Property::OPACITY, 0.0f );
+      mPopupContainer.SetProperty( Actor::Property::OPACITY, 0.0f );
       break;
     }
 
@@ -435,7 +442,7 @@ void Popup::StartTransitionAnimation( bool transitionIn, bool instantaneous /* f
       }
       else
       {
-        mPopupContainer.SetScale( transitionIn ? Vector3::ONE : Vector3::ZERO );
+        mPopupContainer.SetProperty( Actor::Property::SCALE, transitionIn ? Vector3::ONE : Vector3::ZERO );
       }
       break;
     }
@@ -456,7 +463,7 @@ void Popup::StartTransitionAnimation( bool transitionIn, bool instantaneous /* f
       }
       else
       {
-        mPopupContainer.SetProperty( DevelActor::Property::OPACITY, transitionIn ? 1.0f : 0.0f );
+        mPopupContainer.SetProperty( Actor::Property::OPACITY, transitionIn ? 1.0f : 0.0f );
       }
       break;
     }
@@ -593,9 +600,6 @@ void Popup::SetPopupBackgroundImage( Actor image )
   mPopupBackgroundImage.SetProperty( Actor::Property::ANCHOR_POINT, AnchorPoint::CENTER );
   mPopupBackgroundImage.SetProperty( Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER );
 
-  // OnDialogTouched only consumes the event. It prevents the touch event to be caught by the backing.
-  mPopupBackgroundImage.TouchSignal().Connect( this, &Popup::OnDialogTouched );
-
   // Set the popup border to be slightly larger than the layout contents.
   UpdateBackgroundPositionAndSize();
 
@@ -636,7 +640,7 @@ void Popup::SetTitle( Actor titleActor )
   {
     // Set up padding to give sensible default behaviour
     // (an application developer can later override this if they wish).
-    mTitle.SetPadding( DEFAULT_TITLE_PADDING );
+    mTitle.SetProperty( Actor::Property::PADDING, DEFAULT_TITLE_PADDING );
 
     mPopupLayout.AddChild( mTitle, Toolkit::TableView::CellPosition( 0, 0 ) );
   }
@@ -747,16 +751,16 @@ void Popup::SetDisplayState( Toolkit::Popup::DisplayState displayState )
     {
       mPreviousFocusedActor = keyboardFocusManager.GetCurrentFocusActor();
 
-      if( Self().IsKeyboardFocusable() )
+      if( Self().GetProperty< bool >( Actor::Property::KEYBOARD_FOCUSABLE ) )
       {
         // Setup the actgor to start focus from.
         Actor focusActor;
-        if( mContent && mContent.IsKeyboardFocusable() )
+        if( mContent && mContent.GetProperty< bool >( Actor::Property::KEYBOARD_FOCUSABLE ) )
         {
           // If the content is focusable, move the focus to the content.
           focusActor = mContent;
         }
-        else if( mFooter && mFooter.IsKeyboardFocusable() )
+        else if( mFooter && mFooter.GetProperty< bool >( Actor::Property::KEYBOARD_FOCUSABLE ) )
         {
           // If the footer is focusable, move the focus to the footer.
           focusActor = mFooter;
@@ -779,7 +783,7 @@ void Popup::SetDisplayState( Toolkit::Popup::DisplayState displayState )
     ClearKeyInputFocus();
 
     // Restore the keyboard focus when popup is hidden.
-    if( mPreviousFocusedActor && mPreviousFocusedActor.IsKeyboardFocusable() )
+    if( mPreviousFocusedActor && mPreviousFocusedActor.GetProperty< bool >( Actor::Property::KEYBOARD_FOCUSABLE ) )
     {
       Dali::Toolkit::KeyboardFocusManager keyboardFocusManager = Dali::Toolkit::KeyboardFocusManager::Get();
       if( keyboardFocusManager )
@@ -823,11 +827,11 @@ void Popup::LayoutPopup()
   {
     if( !mContent && !mFooter )
     {
-      mTitle.SetPadding( DEFAULT_TITLE_ONLY_PADDING );
+      mTitle.SetProperty( Actor::Property::PADDING, DEFAULT_TITLE_ONLY_PADDING );
     }
     else
     {
-      mTitle.SetPadding( DEFAULT_TITLE_PADDING );
+      mTitle.SetProperty( Actor::Property::PADDING, DEFAULT_TITLE_PADDING );
     }
   }
 
@@ -898,7 +902,7 @@ void Popup::LayoutTail()
     mTailImage.SetProperty( Dali::Actor::Property::NAME, "tailImage" );
     mTailImage.SetProperty( Actor::Property::PARENT_ORIGIN, parentOrigin );
     mTailImage.SetProperty( Actor::Property::ANCHOR_POINT, anchorPoint );
-    mTailImage.SetPosition( position );
+    mTailImage.SetProperty( Actor::Property::POSITION, position );
 
     if( mPopupBackgroundImage )
     {
@@ -931,14 +935,13 @@ Toolkit::Control Popup::CreateBacking()
 
   // Always the full size of the stage.
   backing.SetResizePolicy( ResizePolicy::FIXED, Dimension::ALL_DIMENSIONS );
-  backing.SetSize( Stage::GetCurrent().GetSize() );
+  backing.SetProperty( Actor::Property::SIZE, Stage::GetCurrent().GetSize() );
 
   // Catch events.
   backing.SetProperty( Actor::Property::SENSITIVE, true );
 
   // Default to being transparent.
   backing.SetProperty( Actor::Property::COLOR_ALPHA, 0.0f );
-  backing.TouchSignal().Connect( this, &Popup::OnBackingTouched );
   backing.WheelEventSignal().Connect( this, &Popup::OnBackingWheelEvent );
   return backing;
 }
@@ -1029,10 +1032,10 @@ void Popup::UpdateBackgroundPositionAndSize()
   if( mPopupBackgroundImage )
   {
     mPopupBackgroundImage.SetResizePolicy( ResizePolicy::SIZE_FIXED_OFFSET_FROM_PARENT, Dimension::ALL_DIMENSIONS );
-    mPopupBackgroundImage.SetSizeModeFactor( Vector3( mBackgroundBorder.left + mBackgroundBorder.right, mBackgroundBorder.top + mBackgroundBorder.bottom, 0.0f ) );
+    mPopupBackgroundImage.SetProperty( Actor::Property::SIZE_MODE_FACTOR, Vector3( mBackgroundBorder.left + mBackgroundBorder.right, mBackgroundBorder.top + mBackgroundBorder.bottom, 0.0f ) );
 
     // Adjust the position of the background so the transparent areas are set appropriately
-    mPopupBackgroundImage.SetPosition( ( mBackgroundBorder.right - mBackgroundBorder.left ) * 0.5f, ( mBackgroundBorder.bottom - mBackgroundBorder.top ) * 0.5f );
+    mPopupBackgroundImage.SetProperty( Actor::Property::POSITION, Vector2( ( mBackgroundBorder.right - mBackgroundBorder.left ) * 0.5f, ( mBackgroundBorder.bottom - mBackgroundBorder.top ) * 0.5f ));
   }
 }
 
@@ -1119,7 +1122,11 @@ const std::string& Popup::GetTailRightImage() const
 
 void Popup::SetTouchTransparent( bool enabled )
 {
-  mTouchTransparent = enabled;
+  if( mTouchTransparent != enabled )
+  {
+    mTouchTransparent = enabled;
+    SetupTouch();
+  }
 }
 
 const bool Popup::IsTouchTransparent() const
@@ -1532,28 +1539,20 @@ bool Popup::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tra
   return connected;
 }
 
-bool Popup::OnBackingTouched( Actor actor, const TouchData& touch )
+bool Popup::OnBackingTouched( Actor actor, const TouchEvent& touch )
 {
-  // Allow events to pass through if touch transparency is enabled.
-  if( mTouchTransparent )
+  // Allow events to pass through if the backing isn't the hit-actor
+  if( (touch.GetHitActor(0) == actor) &&
+      (touch.GetPointCount() > 0) &&
+      (touch.GetState( 0 ) == PointState::DOWN))
   {
-    return false;
-  }
-
-  if( touch.GetPointCount() > 0 )
-  {
-    if( touch.GetState( 0 ) == PointState::DOWN )
-    {
-      // Guard against destruction during signal emission.
-      Toolkit::Popup handle( GetOwner() );
+    // Guard against destruction during signal emission.
+    Toolkit::Popup handle( GetOwner() );
 
-      mTouchedOutsideSignal.Emit();
-    }
+    mTouchedOutsideSignal.Emit();
   }
 
-  // Block anything behind backing becoming touched.
-  mLayer.SetTouchConsumed( true );
-  return true;
+  return false;
 }
 
 bool Popup::OnBackingWheelEvent( Actor actor, const WheelEvent& event )
@@ -1564,30 +1563,30 @@ bool Popup::OnBackingWheelEvent( Actor actor, const WheelEvent& event )
     return false;
   }
 
-  // Consume wheel event in dimmed backing actor.
-  mLayer.SetTouchConsumed( true );
   return true;
 }
 
-bool Popup::OnDialogTouched( Actor actor, const TouchData& touch )
+bool Popup::OnDialogTouched( Actor actor, const TouchEvent& touch )
 {
-  // Allow events to pass through if touch transparency is enabled.
-  if( mTouchTransparent )
-  {
-    return false;
-  }
+  // Only connecting this so the backing does not become the default hit-actor and inadvertently closes the popup
+  return false;
+}
 
-  // Consume event (stops backing actor receiving touch events)
-  mLayer.SetTouchConsumed( true );
-  return true;
+void Popup::OnSceneDisconnection()
+{
+  auto p = Dali::Accessibility::Accessible::Get(Self());
+  Accessibility::Bridge::GetCurrentBridge()->RemovePopup( p );
+  Control::OnSceneDisconnection();
 }
 
-void Popup::OnStageConnection( int depth )
+void Popup::OnSceneConnection( int depth )
 {
   mLayoutDirty = true;
   RelayoutRequest();
 
-  Control::OnStageConnection( depth );
+  Control::OnSceneConnection( depth );
+  auto p = Dali::Accessibility::Accessible::Get(Self());
+  Accessibility::Bridge::GetCurrentBridge()->AddPopup( p );
 }
 
 void Popup::OnChildAdd( Actor& child )
@@ -1687,7 +1686,7 @@ void Popup::LayoutContext( const Vector2& size )
   }
 
   // Set the final position.
-  mPopupContainer.SetPosition( newPosition );
+  mPopupContainer.SetProperty( Actor::Property::POSITION, newPosition );
 }
 
 void Popup::OnRelayout( const Vector2& size, RelayoutContainer& container )
@@ -1812,9 +1811,9 @@ bool Popup::OnKeyEvent( const KeyEvent& event )
 
   bool consumed = false;
 
-  if( event.state == KeyEvent::Down )
+  if( event.GetState() == KeyEvent::DOWN )
   {
-    if (event.keyCode == Dali::DALI_KEY_ESCAPE || event.keyCode == Dali::DALI_KEY_BACK)
+    if (event.GetKeyCode() == Dali::DALI_KEY_ESCAPE || event.GetKeyCode() == Dali::DALI_KEY_BACK)
     {
       SetDisplayState( Toolkit::Popup::HIDDEN );
       consumed = true;
@@ -1831,7 +1830,7 @@ void Popup::AddFocusableChildrenRecursive( Actor parent, std::vector< Actor >& f
     Toolkit::Control control = Toolkit::Control::DownCast( parent );
     bool layoutControl = control && GetImplementation( control ).IsKeyboardNavigationSupported();
 
-    if( parent.IsKeyboardFocusable() || layoutControl )
+    if( parent.GetProperty< bool >( Actor::Property::KEYBOARD_FOCUSABLE ) || layoutControl )
     {
       focusableActors.push_back( parent );
 
@@ -1889,12 +1888,12 @@ Actor Popup::GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::
     ( currentFocusedActor && ( ( !mContent || ( currentFocusGroup != mContent ) ) && ( !mFooter || ( currentFocusGroup != mFooter ) ) ) ) )
   {
     // The current focused actor is not within popup.
-    if( mContent && mContent.IsKeyboardFocusable() )
+    if( mContent && mContent.GetProperty< bool >( Actor::Property::KEYBOARD_FOCUSABLE ) )
     {
       // If the content is focusable, move the focus to the content.
       nextFocusableActor = mContent;
     }
-    else if( mFooter && mFooter.IsKeyboardFocusable() )
+    else if( mFooter && mFooter.GetProperty< bool >( Actor::Property::KEYBOARD_FOCUSABLE ) )
     {
       // If the footer is focusable, move the focus to the footer.
       nextFocusableActor = mFooter;
@@ -1975,6 +1974,25 @@ Actor Popup::GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::
   return nextFocusableActor;
 }
 
+void Popup::SetupTouch()
+{
+  if( ! mTouchTransparent )
+  {
+    // Connect all the signals and set us up to consume all touch events
+    mBacking.TouchedSignal().Connect( this, &Popup::OnBackingTouched );
+    mPopupBackgroundImage.TouchedSignal().Connect( this, &Popup::OnDialogTouched );
+    mPopupLayout.TouchedSignal().Connect( this, &Popup::OnDialogTouched );
+    mLayer.SetProperty( Layer::Property::CONSUMES_TOUCH, true );
+  }
+  else
+  {
+    // We are touch transparent so disconnect all signals and ensure our layer does not consumed all touch events
+    mBacking.TouchedSignal().Disconnect( this, &Popup::OnBackingTouched );
+    mPopupBackgroundImage.TouchedSignal().Disconnect( this, &Popup::OnDialogTouched );
+    mPopupLayout.TouchedSignal().Disconnect( this, &Popup::OnDialogTouched );
+    mLayer.SetProperty( Layer::Property::CONSUMES_TOUCH, false );
+  }
+}
 
 } // namespace Internal