Adding RegisterVisual API to Control base class
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / controls / buttons / button-impl.cpp
index a4c5101..53ccf41 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2016 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.
 
 // EXTERNAL INCLUDES
 #include <cstring> // for strcmp
-#include <dali/public-api/events/touch-event.h>
+#include <dali/public-api/events/touch-data.h>
 #include <dali/public-api/images/resource-image.h>
 #include <dali/public-api/object/type-registry.h>
-#include <dali/devel-api/object/type-registry-helper.h>
-#include <dali/public-api/actors/image-actor.h>
+#include <dali/public-api/object/type-registry-helper.h>
 #include <dali/devel-api/scripting/scripting.h>
 
 // INTERNAL INCLUDES
-#include <dali-toolkit/public-api/controls/default-controls/solid-color-actor.h>
 #include <dali-toolkit/public-api/controls/text-controls/text-label.h>
+#include <dali-toolkit/public-api/controls/image-view/image-view.h>
+#include <dali-toolkit/public-api/visuals/color-visual-properties.h>
+#include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
+
 
 /**
  * Button states and contents
@@ -77,29 +79,29 @@ BaseHandle Create()
 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::Button, Toolkit::Control, Create );
 
 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "disabled",                     BOOLEAN, DISABLED                     )
-DALI_PROPERTY_REGISTRATION( Toolkit, Button, "auto-repeating",               BOOLEAN, AUTO_REPEATING               )
-DALI_PROPERTY_REGISTRATION( Toolkit, Button, "initial-auto-repeating-delay", FLOAT,   INITIAL_AUTO_REPEATING_DELAY )
-DALI_PROPERTY_REGISTRATION( Toolkit, Button, "next-auto-repeating-delay",    FLOAT,   NEXT_AUTO_REPEATING_DELAY    )
+DALI_PROPERTY_REGISTRATION( Toolkit, Button, "autoRepeating",                BOOLEAN, AUTO_REPEATING               )
+DALI_PROPERTY_REGISTRATION( Toolkit, Button, "initialAutoRepeatingDelay",    FLOAT,   INITIAL_AUTO_REPEATING_DELAY )
+DALI_PROPERTY_REGISTRATION( Toolkit, Button, "nextAutoRepeatingDelay",       FLOAT,   NEXT_AUTO_REPEATING_DELAY    )
 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "togglable",                    BOOLEAN, TOGGLABLE                    )
 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "selected",                     BOOLEAN, SELECTED                     )
-DALI_PROPERTY_REGISTRATION( Toolkit, Button, "unselected-state-image",       STRING,  UNSELECTED_STATE_IMAGE       )
-DALI_PROPERTY_REGISTRATION( Toolkit, Button, "selected-state-image",         STRING,  SELECTED_STATE_IMAGE         )
-DALI_PROPERTY_REGISTRATION( Toolkit, Button, "disabled-state-image",         STRING,  DISABLED_STATE_IMAGE         )
-DALI_PROPERTY_REGISTRATION( Toolkit, Button, "unselected-color",             VECTOR4, UNSELECTED_COLOR             )
-DALI_PROPERTY_REGISTRATION( Toolkit, Button, "selected-color",               VECTOR4, SELECTED_COLOR               )
+DALI_PROPERTY_REGISTRATION( Toolkit, Button, "unselectedStateImage",         STRING,  UNSELECTED_STATE_IMAGE       )
+DALI_PROPERTY_REGISTRATION( Toolkit, Button, "selectedStateImage",           STRING,  SELECTED_STATE_IMAGE         )
+DALI_PROPERTY_REGISTRATION( Toolkit, Button, "disabledStateImage",           STRING,  DISABLED_STATE_IMAGE         )
+DALI_PROPERTY_REGISTRATION( Toolkit, Button, "unselectedColor",              VECTOR4, UNSELECTED_COLOR             )
+DALI_PROPERTY_REGISTRATION( Toolkit, Button, "selectedColor",                VECTOR4, SELECTED_COLOR               )
 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "label",                        MAP,     LABEL                        )
 
 // Deprecated properties:
-DALI_PROPERTY_REGISTRATION( Toolkit, Button, "label-text",                   STRING,  LABEL_TEXT                   )
+DALI_PROPERTY_REGISTRATION( Toolkit, Button, "labelText",                    STRING,  LABEL_TEXT                   )
 
 // Signals:
 DALI_SIGNAL_REGISTRATION(   Toolkit, Button, "pressed",                               SIGNAL_PRESSED               )
 DALI_SIGNAL_REGISTRATION(   Toolkit, Button, "released",                              SIGNAL_RELEASED              )
 DALI_SIGNAL_REGISTRATION(   Toolkit, Button, "clicked",                               SIGNAL_CLICKED               )
-DALI_SIGNAL_REGISTRATION(   Toolkit, Button, "state-changed",                         SIGNAL_STATE_CHANGED         )
+DALI_SIGNAL_REGISTRATION(   Toolkit, Button, "stateChanged",                          SIGNAL_STATE_CHANGED         )
 
 // Actions:
-DALI_ACTION_REGISTRATION(   Toolkit, Button, "button-click",                          ACTION_BUTTON_CLICK          )
+DALI_ACTION_REGISTRATION(   Toolkit, Button, "buttonClick",                           ACTION_BUTTON_CLICK          )
 
 DALI_TYPE_REGISTRATION_END()
 
@@ -109,7 +111,7 @@ const unsigned int NEXT_AUTOREPEATING_DELAY( 0.05f );
 } // unnamed namespace
 
 Button::Button()
-: Control( ControlBehaviour( REQUIRES_TOUCH_EVENTS | REQUIRES_STYLE_CHANGE_SIGNALS ) ),
+: Control( ControlBehaviour( REQUIRES_STYLE_CHANGE_SIGNALS ) ),
   mAutoRepeatingTimer(),
   mUnselectedColor( Color::WHITE ), // The natural colors of the specified images will be used by default.
   mSelectedColor( Color::WHITE ),
@@ -528,42 +530,57 @@ void Button::SetupContent( Actor& actorToModify, Actor newActor )
   }
 }
 
-void Button::SetUnselectedColor( const Vector4& color )
-{
-  mUnselectedColor = color;
-
-  if( mUnselectedContent && !GetUnselectedImageFilename().empty() )
-  {
-    // If there is existing unselected content, change the color on it directly.
-    mUnselectedContent.SetColor( mUnselectedColor );
-  }
-  else
-  {
-    // If there is no existing content, create a new actor to use for flat color.
-    SetupContent( mUnselectedContent, CreateSolidColorActor( mUnselectedColor ) );
-    mUnselectedContent.SetResizePolicy( ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS );
-  }
-}
-
 const Vector4 Button::GetUnselectedColor() const
 {
   return mUnselectedColor;
 }
 
-void Button::SetSelectedColor( const Vector4& color )
+void Button::SetColor( const Vector4& color, Button::PaintState selectedState )
 {
-  mSelectedColor = color;
+  Actor* contentActor = NULL; // Using a pointer as SetupContent assigns the new Actor to this.
+  bool imageFileExists = false;
+  Property::Index visualIndex = Toolkit::Button::Property::SELECTED_STATE_IMAGE;
 
-  if( mSelectedContent && !GetSelectedImageFilename().empty() )
+  if ( selectedState == SelectedState || selectedState == DisabledSelectedState )
   {
-    // If there is existing unselected content, change the color on it directly.
-    mSelectedContent.SetColor( mSelectedColor );
+    mSelectedColor = color;
+    contentActor = &mSelectedContent;
+    imageFileExists = !GetSelectedImageFilename().empty();
   }
   else
   {
-    // If there is no existing content, create a new actor to use for flat color.
-    SetupContent( mSelectedContent, CreateSolidColorActor( mSelectedColor ) );
-    mSelectedContent.SetResizePolicy( ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS );
+    mUnselectedColor = color;
+    contentActor = &mUnselectedContent;
+    imageFileExists = !GetUnselectedImageFilename().empty();
+    visualIndex = Toolkit::Button::Property::UNSELECTED_STATE_IMAGE;
+  }
+
+  if ( contentActor )
+  {
+    if( imageFileExists )
+    {
+      // If there is existing unselected content, change the color on it directly.
+      contentActor->SetColor( color );
+    }
+    else
+    {
+      // If there is no existing content, create a new actor to use for flat color.
+      Actor placementActor = Actor::New();
+      Toolkit::VisualFactory visualFactory = Toolkit::VisualFactory::Get();
+      Toolkit::Visual::Base visual;
+
+      Property::Map map;
+      map[ Toolkit::Visual::Property::TYPE ] = Toolkit::Visual::COLOR;
+      map[ Toolkit::ColorVisual::Property::MIX_COLOR ] = color;
+
+      visual = visualFactory.CreateVisual( map );
+
+      RegisterVisual( visualIndex, placementActor, visual );
+      visual.SetOnStage( placementActor );
+
+      SetupContent( *contentActor, placementActor ); //
+      contentActor->SetResizePolicy( ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS );
+    }
   }
 }
 
@@ -574,18 +591,14 @@ const Vector4 Button::GetSelectedColor() const
 
 void Button::SetUnselectedImage( const std::string& filename )
 {
-  ImageActor newContent;
+  Toolkit::ImageView newContent;
   if( !filename.empty() )
   {
-    Image resourceimage = Dali::ResourceImage::New( filename );
-    if( resourceimage )
-    {
-      newContent = ImageActor::New( resourceimage );
-    }
+    newContent = Toolkit::ImageView::New( filename );
   }
   else
   {
-    newContent = ImageActor::New();
+    newContent = Toolkit::ImageView::New();
   }
 
   if( newContent )
@@ -606,18 +619,14 @@ Actor& Button::GetUnselectedImage()
 
 void Button::SetSelectedImage( const std::string& filename )
 {
-  ImageActor newContent;
+  Toolkit::ImageView newContent;
   if( !filename.empty() )
   {
-    Image resourceimage = Dali::ResourceImage::New( filename );
-    if( resourceimage )
-    {
-      newContent = ImageActor::New( resourceimage );
-    }
+   newContent = Toolkit::ImageView::New( filename );
   }
   else
   {
-    newContent = ImageActor::New();
+    newContent = Toolkit::ImageView::New();
   }
 
   if( newContent )
@@ -638,14 +647,10 @@ Actor& Button::GetSelectedImage()
 
 void Button::SetBackgroundImage( const std::string& filename )
 {
-  Image resourceimage = Dali::ResourceImage::New( filename );
-  if( resourceimage )
-  {
-    SetupContent( mBackgroundContent, ImageActor::New( resourceimage ) );
+  SetupContent( mBackgroundContent, Toolkit::ImageView::New( filename ) );
 
-    OnBackgroundImageSet();
-    RelayoutRequest();
-  }
+  OnBackgroundImageSet();
+  RelayoutRequest();
 }
 
 Actor& Button::GetBackgroundImage()
@@ -655,14 +660,10 @@ Actor& Button::GetBackgroundImage()
 
 void Button::SetSelectedBackgroundImage( const std::string& filename )
 {
-  Image resourceimage = Dali::ResourceImage::New( filename );
-  if( resourceimage )
-  {
-    SetupContent( mSelectedBackgroundContent, ImageActor::New( resourceimage ) );
+  SetupContent( mSelectedBackgroundContent, Toolkit::ImageView::New( filename ) );
 
-    OnSelectedBackgroundImageSet();
-    RelayoutRequest();
-  }
+  OnSelectedBackgroundImageSet();
+  RelayoutRequest();
 }
 
 Actor& Button::GetSelectedBackgroundImage()
@@ -672,14 +673,10 @@ Actor& Button::GetSelectedBackgroundImage()
 
 void Button::SetDisabledImage( const std::string& filename )
 {
-  Image resourceimage = Dali::ResourceImage::New( filename );
-  if( resourceimage )
-  {
-    SetupContent( mDisabledContent, ImageActor::New( resourceimage ) );
+  SetupContent( mDisabledContent, Toolkit::ImageView::New( filename ) );
 
-    OnDisabledImageSet();
-    RelayoutRequest();
-  }
+  OnDisabledImageSet();
+  RelayoutRequest();
 }
 
 Actor& Button::GetDisabledImage()
@@ -689,14 +686,10 @@ Actor& Button::GetDisabledImage()
 
 void Button::SetDisabledSelectedImage( const std::string& filename )
 {
-  Image resourceimage = Dali::ResourceImage::New( filename );
-  if( resourceimage )
-  {
-    SetupContent( mDisabledSelectedContent, ImageActor::New( resourceimage ) );
+  SetupContent( mDisabledSelectedContent, Toolkit::ImageView::New( filename ) );
 
-    OnDisabledSelectedImageSet();
-    RelayoutRequest();
-  }
+  OnDisabledSelectedImageSet();
+  RelayoutRequest();
 }
 
 Actor& Button::GetDisabledSelectedImage()
@@ -706,14 +699,10 @@ Actor& Button::GetDisabledSelectedImage()
 
 void Button::SetDisabledBackgroundImage( const std::string& filename )
 {
-  Image resourceimage = Dali::ResourceImage::New( filename );
-  if( resourceimage )
-  {
-    SetupContent( mDisabledBackgroundContent, ImageActor::New( resourceimage ) );
+  SetupContent( mDisabledBackgroundContent, Toolkit::ImageView::New( filename ) );
 
-    OnDisabledBackgroundImageSet();
-    RelayoutRequest();
-  }
+  OnDisabledBackgroundImageSet();
+  RelayoutRequest();
 }
 
 Actor& Button::GetDisabledBackgroundImage()
@@ -747,32 +736,6 @@ std::string Button::GetSelectedImageFilename() const
   return std::string();
 }
 
-std::string Button::GetBackgroundImageFilename() const
-{
-  if( mBackgroundContent )
-  {
-    ResourceImage image = ResourceImage::DownCast( mBackgroundContent );
-    if( image )
-    {
-      return image.GetUrl();
-    }
-  }
-  return std::string();
-}
-
-std::string Button::GetSelectedBackgroundImageFilename() const
-{
-  if( mSelectedBackgroundContent )
-  {
-    ResourceImage image = ResourceImage::DownCast( mSelectedBackgroundContent );
-    if( image )
-    {
-      return image.GetUrl();
-    }
-  }
-  return std::string();
-}
-
 std::string Button::GetDisabledImageFilename() const
 {
   if( mDisabledContent )
@@ -786,32 +749,6 @@ std::string Button::GetDisabledImageFilename() const
   return std::string();
 }
 
-std::string Button::GetDisabledSelectedImageFilename() const
-{
-  if( mDisabledSelectedContent )
-  {
-    ResourceImage image = ResourceImage::DownCast( mDisabledSelectedContent );
-    if( image )
-    {
-      return image.GetUrl();
-    }
-  }
-  return std::string();
-}
-
-std::string Button::GetDisabledBackgroundImageFilename() const
-{
-  if( mDisabledBackgroundContent )
-  {
-    ResourceImage image = ResourceImage::DownCast( mDisabledBackgroundContent );
-    if( image )
-    {
-      return image.GetUrl();
-    }
-  }
-  return std::string();
-}
-
 bool Button::DoAction( BaseObject* object, const std::string& actionName, const Property::Map& attributes )
 {
   bool ret = false;
@@ -848,22 +785,6 @@ bool Button::DoClickAction( const Property::Map& attributes )
   return false;
 }
 
-void Button::OnButtonStageDisconnection()
-{
-  if( ButtonDown == mState )
-  {
-    if( !mTogglableButton )
-    {
-      Released();
-
-      if( mAutoRepeating )
-      {
-        mAutoRepeatingTimer.Reset();
-      }
-    }
-  }
-}
-
 void Button::OnButtonDown()
 {
   if( !mTogglableButton )
@@ -983,15 +904,62 @@ bool Button::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tr
   return connected;
 }
 
-bool Button::OnTouchEvent(const TouchEvent& event)
+void Button::OnInitialize()
+{
+  Actor self = Self();
+
+  mTapDetector = TapGestureDetector::New();
+  mTapDetector.Attach( self );
+  mTapDetector.DetectedSignal().Connect(this, &Button::OnTap);
+
+  self.SetKeyboardFocusable( true );
+
+  self.TouchSignal().Connect( this, &Button::OnTouch );
+}
+
+bool Button::OnAccessibilityActivated()
+{
+  return OnKeyboardEnter();
+}
+
+bool Button::OnKeyboardEnter()
+{
+  // When the enter key is pressed, or button is activated, the click action is performed.
+  Property::Map attributes;
+  bool ret = DoClickAction( attributes );
+
+  return ret;
+}
+
+void Button::OnStageDisconnection()
+{
+  if( ButtonDown == mState )
+  {
+    if( !mTogglableButton )
+    {
+      Released();
+
+      if( mAutoRepeating )
+      {
+        mAutoRepeatingTimer.Reset();
+      }
+    }
+  }
+
+  mState = ButtonUp;
+
+  Control::OnStageDisconnection();
+}
+
+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.
-  if( ( !mDisabled ) && ( 1 == event.GetPointCount() ) )
+  if( ( !mDisabled ) && ( 1 == touch.GetPointCount() ) )
   {
-    switch( event.GetPoint(0).state )
+    switch( touch.GetState( 0 ) )
     {
-      case TouchPoint::Down:
+      case PointState::DOWN:
       {
         OnButtonDown(); // Notification for derived classes.
 
@@ -999,7 +967,7 @@ bool Button::OnTouchEvent(const TouchEvent& event)
         mState = ButtonDown;
         break;
       }
-      case TouchPoint::Up:
+      case PointState::UP:
       {
         OnButtonUp(); // Notification for derived classes.
 
@@ -1007,7 +975,7 @@ bool Button::OnTouchEvent(const TouchEvent& event)
         mState = ButtonUp;
         break;
       }
-      case TouchPoint::Interrupted:
+      case PointState::INTERRUPTED:
       {
         OnTouchPointInterrupted(); // Notification for derived classes.
 
@@ -1015,7 +983,7 @@ bool Button::OnTouchEvent(const TouchEvent& event)
         mState = ButtonUp;
         break;
       }
-      case TouchPoint::Leave:
+      case PointState::LEAVE:
       {
         OnTouchPointLeave(); // Notification for derived classes.
 
@@ -1023,20 +991,15 @@ bool Button::OnTouchEvent(const TouchEvent& event)
         mState = ButtonUp;
         break;
       }
-      case TouchPoint::Motion:
-      case TouchPoint::Stationary: // FALLTHROUGH
+      case PointState::MOTION:
+      case PointState::STATIONARY: // FALLTHROUGH
       {
         // Nothing to do
         break;
       }
-      default:
-      {
-        DALI_ASSERT_ALWAYS( !"Point status unhandled." );
-        break;
-      }
     }
   }
-  else if( 1 < event.GetPointCount() )
+  else if( 1 < touch.GetPointCount() )
   {
     OnTouchPointLeave(); // Notification for derived classes.
 
@@ -1047,39 +1010,6 @@ bool Button::OnTouchEvent(const TouchEvent& event)
   return false;
 }
 
-void Button::OnInitialize()
-{
-  Actor self = Self();
-
-  mTapDetector = TapGestureDetector::New();
-  mTapDetector.Attach( self );
-  mTapDetector.DetectedSignal().Connect(this, &Button::OnTap);
-
-  OnButtonInitialize();
-
-  self.SetKeyboardFocusable( true );
-}
-
-bool Button::OnAccessibilityActivated()
-{
-  return OnKeyboardEnter();
-}
-
-bool Button::OnKeyboardEnter()
-{
-  // When the enter key is pressed, or button is activated, the click action is performed.
-  Property::Map attributes;
-  bool ret = DoClickAction( attributes );
-
-  return ret;
-}
-
-void Button::OnControlStageDisconnection()
-{
-  OnButtonStageDisconnection(); // Notification for derived classes.
-  mState = ButtonUp;
-}
-
 void Button::OnTap(Actor actor, const TapGesture& tap)
 {
   // Do nothing.
@@ -1198,7 +1128,6 @@ void Button::PrepareAddButtonImage( Actor& actor )
 {
   if( actor )
   {
-    actor.Unparent();
     Self().Add( actor );
     PrepareForTranstionOut( actor );
   }
@@ -1221,7 +1150,6 @@ void Button::AddButtonImage( Actor& actor )
 {
   if( actor )
   {
-    actor.Unparent();
     Self().Add( actor );
   }
 }
@@ -1472,13 +1400,13 @@ void Button::SetProperty( BaseObject* object, Property::Index index, const Prope
 
       case Toolkit::Button::Property::UNSELECTED_COLOR:
       {
-        GetImplementation( button ).SetUnselectedColor( value.Get< Vector4 >() );
+        GetImplementation( button ).SetColor( value.Get< Vector4 >(), UnselectedState );
         break;
       }
 
       case Toolkit::Button::Property::SELECTED_COLOR:
       {
-        GetImplementation( button ).SetSelectedColor( value.Get< Vector4 >() );
+        GetImplementation( button ).SetColor( value.Get< Vector4 >(), SelectedState );
         break;
       }