Button should not propagate handled touch events
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / controls / buttons / button-impl.cpp
index 79ac7db..84dd7a1 100644 (file)
 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
 #include <dali-toolkit/public-api/visuals/color-visual-properties.h>
 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
-#include <dali-toolkit/devel-api/align-enums.h>
+#include <dali-toolkit/public-api/align-enumerations.h>
 #include <dali-toolkit/devel-api/controls/control-depth-index-ranges.h>
+#include <dali-toolkit/devel-api/controls/control-devel.h>
 #include <dali-toolkit/devel-api/controls/buttons/button-devel.h>
 #include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
 #include <dali-toolkit/internal/visuals/text/text-visual.h>
-#include <dali-toolkit/devel-api/visuals/text-visual-properties.h>
-#include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
+#include <dali-toolkit/public-api/visuals/text-visual-properties.h>
+#include <dali-toolkit/public-api/visuals/visual-properties.h>
 
 #if defined(DEBUG_ENABLED)
     Debug::Filter* gLogButtonFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_BUTTON_CONTROL");
@@ -363,7 +364,10 @@ std::string Button::GetLabelText() const
   if ( labelProperty )
   {
     Property::Value* value = labelProperty->Find( Toolkit::TextVisual::Property::TEXT );
-    value->Get( textLabel );
+    if( value )
+    {
+      value->Get( textLabel );
+    }
   }
 
   return textLabel;
@@ -382,7 +386,7 @@ void Button::MergeWithExistingLabelProperties( const Property::Map& inMap, Prope
    * 3) Merge with new properties ( settings )
    * 4) Return new merged map
    */
-  Toolkit::Visual::Base visual = GetVisual( Toolkit::Button::Property::LABEL );
+  Toolkit::Visual::Base visual = DevelControl::GetVisual( *this, Toolkit::Button::Property::LABEL );
   if ( visual )
   {
     DALI_LOG_INFO( gLogButtonFilter, Debug::Verbose, "MergeLabelProperties Visual already exists, retrieving existing map\n");
@@ -418,7 +422,7 @@ Button::Align Button::GetLabelAlignment()
  * 4) Unregister visual if empty map was provided. This is the method to remove a visual
  */
 
-void Button::CreateVisualsForComponent( Property::Index index, const Property::Value& value, const float visualDepth )
+void Button::CreateVisualsForComponent( Property::Index index, const Property::Value& value, const int visualDepth )
 {
   DALI_LOG_INFO( gLogButtonFilter, Debug::Verbose, "CreateVisualsForComponent index(%d)\n", index );
   Toolkit::VisualFactory visualFactory = Toolkit::VisualFactory::Get();
@@ -448,13 +452,12 @@ void Button::CreateVisualsForComponent( Property::Index index, const Property::V
   if ( buttonVisual )
   {
     DALI_LOG_INFO( gLogButtonFilter, Debug::Verbose, "CreateVisualsForComponent RegisterVisual index(%d) enabled(%s)\n",
-                   index, IsVisualEnabled( index )?"true":"false" );
-    buttonVisual.SetDepthIndex( visualDepth );
-    RegisterVisual( index, buttonVisual, IsVisualEnabled( index ) );
+                   index, DevelControl::IsVisualEnabled( *this, index )?"true":"false" );
+    DevelControl::RegisterVisual( *this, index, buttonVisual, DevelControl::IsVisualEnabled( *this, index ), visualDepth );
   }
   else
   {
-    UnregisterVisual( index );
+    DevelControl::UnregisterVisual( *this, index );
     DALI_LOG_INFO( gLogButtonFilter, Debug::General, "CreateVisualsForComponent Visual not created or empty map (clearing visual).(%d)\n", index);
   }
   PerformFunctionOnVisualsInState( &Button::SelectRequiredVisual, mButtonState );
@@ -464,7 +467,7 @@ bool Button::GetPropertyMapForVisual( Property::Index visualIndex, Property::Map
 {
   DALI_LOG_INFO( gLogButtonFilter, Debug::General, "GetPropertyMapForVisual visual(%d)\n", visualIndex);
   bool success = false;
-  Toolkit::Visual::Base visual = GetVisual( visualIndex );
+  Toolkit::Visual::Base visual = DevelControl::GetVisual( *this, visualIndex );
   if ( visual )
   {
     visual.CreatePropertyMap( retreivedMap );
@@ -686,50 +689,53 @@ bool Button::OnAccessibilityActivated()
 bool Button::OnTouch( Actor actor, const TouchData& touch )
 {
 
-  // Only events are processed when the button is not disabled and the touch event has only
-  // one touch point.
+  // Only events are processed when the button is not disabled
+  auto result( false );
 
-  if( !IsDisabled() && ( 1 == touch.GetPointCount() ) )
+  if( !IsDisabled() )
   {
-    switch( touch.GetState( 0 ) )
+    if ( 1 == touch.GetPointCount() )
     {
-      case PointState::DOWN:
-      {
-        ButtonDown();
-        break;
-      }
-      case PointState::UP:
-      {
-        ButtonUp();
-        break;
-      }
-      case PointState::INTERRUPTED:
-      {
-        OnTouchPointInterrupted();
-        break;
-      }
-      case PointState::LEAVE:
+      switch( touch.GetState( 0 ) )
       {
-        OnTouchPointLeave();
-        break;
-      }
-      case PointState::MOTION:
-      case PointState::STATIONARY: // FALLTHROUGH
-      {
-        // Nothing to do
-        break;
+        case PointState::DOWN:
+        {
+          ButtonDown();
+          break;
+        }
+        case PointState::UP:
+        {
+          ButtonUp();
+          break;
+        }
+        case PointState::INTERRUPTED:
+        {
+          OnTouchPointInterrupted();
+          break;
+        }
+        case PointState::LEAVE:
+        {
+          OnTouchPointLeave();
+          break;
+        }
+        case PointState::MOTION:
+        case PointState::STATIONARY: // FALLTHROUGH
+        {
+          // Nothing to do
+          break;
+        }
       }
     }
-  }
-  else if( 1 < touch.GetPointCount() )
-  {
-    OnTouchPointLeave(); // Notification for derived classes.
+    else if( 1 < touch.GetPointCount() )
+    {
+      OnTouchPointLeave(); // Notification for derived classes.
 
-    // Sets the button state to the default
-    mButtonPressedState = UNPRESSED;
+      // Sets the button state to the default
+      mButtonPressedState = UNPRESSED;
+    }
+    result = true;
   }
-
-  return false;
+  return result;
 }
 
 bool Button::OnKeyboardEnter()
@@ -784,7 +790,7 @@ Vector3 Button::GetNaturalSize()
 
   for ( int state = Button::UNSELECTED_STATE; state < Button::STATE_COUNT; state++ )
   {
-    Toolkit::Visual::Base visual = GetVisual( GET_VISUAL_INDEX_FOR_STATE[state][FOREGROUND] );
+    Toolkit::Visual::Base visual = DevelControl::GetVisual( *this, GET_VISUAL_INDEX_FOR_STATE[state][FOREGROUND] );
     Size visualSize;
     if ( visual )
     {
@@ -799,7 +805,7 @@ Vector3 Button::GetNaturalSize()
   {
     for ( int state = Button::UNSELECTED_STATE; state < Button::STATE_COUNT; state++ )
     {
-      Toolkit::Visual::Base visual = GetVisual( GET_VISUAL_INDEX_FOR_STATE[state][BACKGROUND] );
+      Toolkit::Visual::Base visual = DevelControl::GetVisual( *this, GET_VISUAL_INDEX_FOR_STATE[state][BACKGROUND] );
       Size visualSize;
       if ( visual )
       {
@@ -827,7 +833,7 @@ Vector3 Button::GetNaturalSize()
   // Get natural size of label if text has been set
   if ( mTextStringSetFlag )
   {
-    Toolkit::Visual::Base visual = GetVisual( Toolkit::Button::Property::LABEL );
+    Toolkit::Visual::Base visual = DevelControl::GetVisual( *this, Toolkit::Button::Property::LABEL );
 
     if ( visual )
     {
@@ -880,9 +886,9 @@ void Button::OnRelayout( const Vector2& size, RelayoutContainer& container )
 {
   DALI_LOG_INFO( gLogButtonFilter, Debug::General, "OnRelayout targetSize(%f,%f) ptr(%p) state[%d]\n", size.width, size.height, this, mButtonState );
 
-  Toolkit::Visual::Base currentVisual = GetVisual( GET_VISUAL_INDEX_FOR_STATE[mButtonState][FOREGROUND] );
+  Toolkit::Visual::Base currentVisual = DevelControl::GetVisual( *this, GET_VISUAL_INDEX_FOR_STATE[mButtonState][FOREGROUND] );
 
-  Toolkit::Visual::Base currentBackGroundVisual = GetVisual( GET_VISUAL_INDEX_FOR_STATE[mButtonState][BACKGROUND] );
+  Toolkit::Visual::Base currentBackGroundVisual = DevelControl::GetVisual( *this, GET_VISUAL_INDEX_FOR_STATE[mButtonState][BACKGROUND] );
 
   // Sizes and padding set to zero, if not present then values will no effect calculations.
   Vector2 visualPosition = Vector2::ZERO;
@@ -979,8 +985,8 @@ void Button::OnRelayout( const Vector2& size, RelayoutContainer& container )
 
     Property::Map visualTransform;
 
-    visualTransform.Add( Toolkit::DevelVisual::Transform::Property::SIZE, size )
-                   .Add( Toolkit::DevelVisual::Transform::Property::SIZE_POLICY, Vector2( DevelVisual::Transform::Policy::ABSOLUTE, DevelVisual::Transform::Policy::ABSOLUTE ) );
+    visualTransform.Add( Toolkit::Visual::Transform::Property::SIZE, size )
+                   .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY, Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) );
 
     currentBackGroundVisual.SetTransformAndSize( visualTransform, size );
   }
@@ -991,19 +997,19 @@ void Button::OnRelayout( const Vector2& size, RelayoutContainer& container )
 
     Property::Map visualTransform;
 
-    visualTransform.Add( Toolkit::DevelVisual::Transform::Property::SIZE, visualSize )
-                   .Add( Toolkit::DevelVisual::Transform::Property::OFFSET, visualPosition )
-                   .Add( Toolkit::DevelVisual::Transform::Property::OFFSET_POLICY, Vector2( DevelVisual::Transform::Policy::ABSOLUTE, DevelVisual::Transform::Policy::ABSOLUTE ) )
-                   .Add( Toolkit::DevelVisual::Transform::Property::SIZE_POLICY, Vector2( DevelVisual::Transform::Policy::ABSOLUTE, DevelVisual::Transform::Policy::ABSOLUTE ) )
-                   .Add( Toolkit::DevelVisual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN )
-                   .Add( Toolkit::DevelVisual::Transform::Property::ANCHOR_POINT, visualAnchorPoint );
+    visualTransform.Add( Toolkit::Visual::Transform::Property::SIZE, visualSize )
+                   .Add( Toolkit::Visual::Transform::Property::OFFSET, visualPosition )
+                   .Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY, Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
+                   .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY, Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
+                   .Add( Toolkit::Visual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN )
+                   .Add( Toolkit::Visual::Transform::Property::ANCHOR_POINT, visualAnchorPoint );
 
     currentVisual.SetTransformAndSize( visualTransform, size );
   }
 
   if ( mTextStringSetFlag )
   {
-    Toolkit::Visual::Base textVisual = GetVisual( Toolkit::Button::Property::LABEL ); // No need to search for Label visual if no text set.
+    Toolkit::Visual::Base textVisual = DevelControl::GetVisual( *this, Toolkit::Button::Property::LABEL ); // No need to search for Label visual if no text set.
 
     if ( textVisual )
     {
@@ -1022,12 +1028,12 @@ void Button::OnRelayout( const Vector2& size, RelayoutContainer& container )
 
 
       Property::Map textVisualTransform;
-      textVisualTransform.Add( Toolkit::DevelVisual::Transform::Property::SIZE, preSize )
-                         .Add( Toolkit::DevelVisual::Transform::Property::OFFSET, labelPosition )
-                         .Add( Toolkit::DevelVisual::Transform::Property::OFFSET_POLICY, Vector2( DevelVisual::Transform::Policy::ABSOLUTE, DevelVisual::Transform::Policy::ABSOLUTE ) )
-                         .Add( Toolkit::DevelVisual::Transform::Property::SIZE_POLICY, Vector2( DevelVisual::Transform::Policy::ABSOLUTE, DevelVisual::Transform::Policy::ABSOLUTE ) )
-                         .Add( Toolkit::DevelVisual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN )
-                         .Add( Toolkit::DevelVisual::Transform::Property::ANCHOR_POINT, visualAnchorPoint );
+      textVisualTransform.Add( Toolkit::Visual::Transform::Property::SIZE, preSize )
+                         .Add( Toolkit::Visual::Transform::Property::OFFSET, labelPosition )
+                         .Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY, Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
+                         .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY, Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
+                         .Add( Toolkit::Visual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN )
+                         .Add( Toolkit::Visual::Transform::Property::ANCHOR_POINT, visualAnchorPoint );
 
       textVisual.SetTransformAndSize( textVisualTransform, size );
     }
@@ -1098,7 +1104,7 @@ void Button::SelectRequiredVisual( Property::Index visualIndex )
 {
   DALI_LOG_INFO( gLogButtonFilter, Debug::Verbose, "Button::SelectRequiredVisual index(%d) state(%d)\n", visualIndex, mButtonState );
 
-  EnableVisual( visualIndex, true );
+  DevelControl::EnableVisual( *this, visualIndex, true );
 }
 
 void Button::RemoveVisual( Property::Index visualIndex )
@@ -1106,11 +1112,11 @@ void Button::RemoveVisual( Property::Index visualIndex )
   // Use OnButtonVisualRemoval if want button developer to have the option to override removal.
   DALI_LOG_INFO( gLogButtonFilter, Debug::Verbose, "Button::RemoveVisual index(%d) state(%d)\n", visualIndex, mButtonState );
 
-  Toolkit::Visual::Base visual = GetVisual( visualIndex );
+  Toolkit::Visual::Base visual = DevelControl::GetVisual( *this, visualIndex );
 
   if( visual )
   {
-    EnableVisual( visualIndex, false );
+    DevelControl::EnableVisual( *this, visualIndex, false );
   }
 }
 
@@ -1231,7 +1237,7 @@ void Button::SetProperty( BaseObject* object, Property::Index index, const Prope
           DALI_LOG_INFO( gLogButtonFilter, Debug::Verbose, "Button::SetProperty Setting TextVisual with string[%s]\n", textString.c_str() );
 
           Property::Map setPropertyMap;
-          setPropertyMap.Add( Toolkit::Visual::Property::TYPE, Toolkit::DevelVisual::TEXT )
+          setPropertyMap.Add( Toolkit::Visual::Property::TYPE, Toolkit::Visual::TEXT )
                         .Add( Toolkit::TextVisual::Property::TEXT, textString );
 
           GetImplementation( button ).MergeWithExistingLabelProperties( setPropertyMap, outTextVisualProperties );
@@ -1508,7 +1514,7 @@ void Button::SetBackgroundImage( const std::string& filename )
   }
   else
   {
-    UnregisterVisual( Toolkit::DevelButton::Property::UNSELECTED_BACKGROUND_VISUAL );
+    DevelControl::UnregisterVisual( *this, Toolkit::DevelButton::Property::UNSELECTED_BACKGROUND_VISUAL );
   }
 }
 
@@ -1525,7 +1531,7 @@ void Button::SetSelectedBackgroundImage( const std::string& filename )
   }
   else
   {
-    UnregisterVisual( Toolkit::DevelButton::Property::UNSELECTED_BACKGROUND_VISUAL );
+    DevelControl::UnregisterVisual( *this, Toolkit::DevelButton::Property::UNSELECTED_BACKGROUND_VISUAL );
   }
 }
 
@@ -1556,7 +1562,7 @@ void Button::SetDisabledSelectedImage( const std::string& filename )
 // Used by Deprecated Properties which don't use the Visual Property maps for setting and getting
 std::string Button::GetUrlForImageVisual( const Property::Index index ) const
 {
-  Toolkit::Visual::Base visual = GetVisual( index );
+  Toolkit::Visual::Base visual = DevelControl::GetVisual( *this, index );
   std::string result;
 
   if ( visual )
@@ -1597,27 +1603,52 @@ void Button::SetButtonImage( Image image )
 {
   DALI_LOG_WARNING("Button::SetButtonImage @DEPRECATED_1_0.50\n");
   SetUnselectedImage( GetUrlFromImage( image ) );
+  mSetButtonImage = image;
 }
 
 void Button::SetSelectedImage( Image image )
 {
   DALI_LOG_WARNING("Button::SetSelectedImage @DEPRECATED_1_0.50\n");
   SetSelectedImage( GetUrlFromImage( image ) );
+  mSetSelectedImage = image;
 }
 
 Actor Button::GetButtonImage() const
 {
+  // When deprecated ImageView API removed then this button API can be removed too.
   DALI_LOG_WARNING("Button::GetButtonImage @DEPRECATED_1_0.50\n");
-  Actor imageView = Toolkit::ImageView::New( GetUrlForImageVisual( Toolkit::DevelButton::Property::UNSELECTED_BACKGROUND_VISUAL ) );
+
+  Actor imageView;
+
+  if ( mSetButtonImage )
+  {
+    imageView = Toolkit::ImageView::New( mSetButtonImage );
+  }
+  else
+  {
+    ResourceImage image = ResourceImage::New( GetUrlForImageVisual( Toolkit::DevelButton::Property::UNSELECTED_BACKGROUND_VISUAL ) );
+    imageView = Toolkit::ImageView::New( image );
+  }
 
   return imageView;
 }
 
 Actor Button::GetSelectedImage() const
 {
+  // When deprecated ImageView API removed then this button API can be removed too.
   DALI_LOG_WARNING("Button::GetSelectedImage @DEPRECATED_1_0.50\n");
-  Actor imageView = Toolkit::ImageView::New( GetUrlForImageVisual( Toolkit::DevelButton::Property::SELECTED_BACKGROUND_VISUAL ) );
 
+  Actor imageView;
+
+  if ( mSetSelectedImage )
+  {
+    imageView = Toolkit::ImageView::New( mSetSelectedImage );
+  }
+  else
+  {
+    ResourceImage image = ResourceImage::New( GetUrlForImageVisual( Toolkit::DevelButton::Property::SELECTED_BACKGROUND_VISUAL ) );
+    imageView = Toolkit::ImageView::New( image );
+  }
   return imageView;
 }