Changed all property & signal names to lowerCamelCase
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / controls / buttons / push-button-impl.cpp
index 0df4e3c..4331c87 100644 (file)
 #include "push-button-impl.h"
 
 // EXTERNAL INCLUDES
-#include <algorithm>
 #include <dali/public-api/actors/image-actor.h>
 #include <dali/public-api/object/type-registry.h>
+#include <dali/devel-api/object/type-registry-helper.h>
+#include <dali/public-api/images/resource-image.h>
+#include <dali/devel-api/scripting/scripting.h>
 
 // INTERNAL INCLUDES
-#include "push-button-default-painter-impl.h"
-
-#include <dali-toolkit/public-api/controls/text-view/text-view.h>
-#include <dali-toolkit/internal/controls/relayout-helper.h>
+#include <dali-toolkit/public-api/controls/text-controls/text-label.h>
 
 namespace Dali
 {
@@ -41,42 +40,62 @@ namespace Internal
 namespace
 {
 
+const float   ANIMATION_TIME( 0.2f );
+const Padding DEFAULT_LABEL_PADDING( 12.0f, 12.0f, 12.0f, 12.0f );
+const Padding DEFAULT_ICON_PADDING( 12.0f, 12.0f, 12.0f, 12.0f );
+
 BaseHandle Create()
 {
   return Toolkit::PushButton::New();
 }
 
-TypeRegistration typeRegistration( typeid(Toolkit::PushButton), typeid(Toolkit::Button), Create );
+// Properties
+
+DALI_TYPE_REGISTRATION_BEGIN( Toolkit::PushButton, Toolkit::Button, Create )
+
+DALI_PROPERTY_REGISTRATION( Toolkit, PushButton, "unselectedIcon",  STRING, UNSELECTED_ICON )
+DALI_PROPERTY_REGISTRATION( Toolkit, PushButton, "selectedIcon",  STRING, SELECTED_ICON )
+DALI_PROPERTY_REGISTRATION( Toolkit, PushButton, "iconAlignment",  STRING, ICON_ALIGNMENT )
+DALI_PROPERTY_REGISTRATION( Toolkit, PushButton, "labelPadding",  STRING, LABEL_PADDING )
+DALI_PROPERTY_REGISTRATION( Toolkit, PushButton, "iconPadding",  STRING, ICON_PADDING )
+
+DALI_TYPE_REGISTRATION_END()
+
+/*
+ * Table to define Text-to-enum conversions for IconAlignment.
+ */
+const Dali::Scripting::StringEnum IconAlignmentTable[] = {
+  { "LEFT",   Toolkit::Internal::PushButton::LEFT },
+  { "RIGHT",  Toolkit::Internal::PushButton::RIGHT },
+  { "TOP",    Toolkit::Internal::PushButton::TOP },
+  { "BOTTOM", Toolkit::Internal::PushButton::BOTTOM },
+}; const unsigned int IconAlignmentTableCount = sizeof( IconAlignmentTable ) / sizeof( IconAlignmentTable[0] );
+
+const char* const UNSELECTED_BUTTON_IMAGE_DIR = DALI_IMAGE_DIR "button-up.9.png";
+const char* const SELECTED_BUTTON_IMAGE_DIR = DALI_IMAGE_DIR "button-down.9.png";
+const char* const DISABLED_UNSELECTED_BUTTON_IMAGE_DIR = DALI_IMAGE_DIR "button-disabled.9.png";
+const char* const DISABLED_SELECTED_BUTTON_IMAGE_DIR = DALI_IMAGE_DIR "button-down-disabled.9.png";
 
 } // unnamed namespace
 
 namespace
 {
 
-const float TEXT_PADDING = 12.0f;
-
 /**
- * Find the first image actor in the actor hierarchy
+ * Get size of Actor if larger than given size
+ * @param[in] root the actor to get the size of
+ * @param[out] size the greater of the given size or the size of the Actor
  */
-ImageActor FindImageActor( Actor root )
+void SizeOfActorIfLarger( Actor root, Vector3& size )
 {
-  ImageActor imageActor = ImageActor::DownCast( root );
-  if( !imageActor && root )
+  if ( root )
   {
-    for( unsigned int i = 0, numChildren = root.GetChildCount(); i < numChildren; ++i )
-    {
-      ImageActor childImageActor = FindImageActor( root.GetChildAt( i ) );
-      if( childImageActor )
-      {
-        return childImageActor;
-      }
-    }
+    // RelayoutSize retreived for Actor to use any padding set to it.
+    size.width = std::max( root.GetRelayoutSize( Dimension::WIDTH ), size.width );
+    size.height = std::max( root.GetRelayoutSize( Dimension::HEIGHT ), size.height );
   }
-
-  return imageActor;
 }
 
-
 } // unnamed namespace
 
 Dali::Toolkit::PushButton PushButton::New()
@@ -94,89 +113,491 @@ Dali::Toolkit::PushButton PushButton::New()
   return pushButton;
 }
 
+PushButton::PushButton()
+: Button(),
+  mLabelPadding( DEFAULT_LABEL_PADDING ),
+  mIconPadding( DEFAULT_ICON_PADDING ),
+  mIconAlignment( RIGHT ),
+  mSize()
+{
+  SetAnimationTime( ANIMATION_TIME );
+}
+
+PushButton::~PushButton()
+{
+}
+
 void PushButton::OnButtonInitialize()
 {
   // Push button requires the Leave event.
-  Actor root = Self();
-  root.SetLeaveRequired( true );
+  Actor self = Self();
+  self.SetLeaveRequired( true );
+
+  // Set resize policy to natural size so that buttons will resize to background images
+  self.SetResizePolicy( ResizePolicy::USE_NATURAL_SIZE, Dimension::ALL_DIMENSIONS );
+
+  SetUnselectedImage( UNSELECTED_BUTTON_IMAGE_DIR );
+  SetSelectedImage( SELECTED_BUTTON_IMAGE_DIR );
+  SetDisabledImage( DISABLED_UNSELECTED_BUTTON_IMAGE_DIR );
+  SetDisabledSelectedImage( DISABLED_SELECTED_BUTTON_IMAGE_DIR );
 }
 
-PushButton::PushButton()
-: Button()
+void PushButton::SetIcon( DecorationState state, const std::string iconFilename )
 {
-  // Creates specific painter.GetBu
-  ButtonPainterPtr painter = PushButtonDefaultPainterPtr( new PushButtonDefaultPainter() );
-  SetPainter( painter );
+  mIconName[ state ] = iconFilename;
+  SetDecoration( state, ImageActor::New( Dali::ResourceImage::New( iconFilename ) ) );
+  ConfigureSizeNegotiation();
 }
 
-PushButton::~PushButton()
+std::string& PushButton::GetIcon( DecorationState state )
 {
-  SetPainter( NULL );
+  return mIconName[ state ];
 }
 
-Vector3 PushButton::GetNaturalSize()
+void PushButton::SetIconAlignment( const PushButton::IconAlignment iconAlignment )
+{
+  mIconAlignment = iconAlignment;
+  ConfigureSizeNegotiation();
+}
+
+const PushButton::IconAlignment PushButton::GetIconAlignment() const
+{
+  return mIconAlignment;
+}
+
+void PushButton::SetLabelPadding( const Vector4& padding )
+{
+  mLabelPadding = Padding( padding.x, padding.y, padding.z, padding.w );
+  ConfigureSizeNegotiation();
+}
+
+Vector4 PushButton::GetLabelPadding()
+{
+  return Vector4( mLabelPadding.left, mLabelPadding.right, mLabelPadding.top, mLabelPadding.bottom );
+}
+
+void PushButton::SetIconPadding( const Vector4& padding )
 {
-  Vector3 size = Control::GetNaturalSize();
+  mIconPadding = Padding( padding.x, padding.y, padding.z, padding.w );
+  ConfigureSizeNegotiation();
+}
 
-  const bool widthIsZero = EqualsZero( size.width );
-  const bool heightIsZero = EqualsZero( size.height );
+Vector4 PushButton::GetIconPadding()
+{
+  return Vector4( mIconPadding.left, mIconPadding.right, mIconPadding.top, mIconPadding.bottom );
+}
 
-  if( widthIsZero || heightIsZero )
+void PushButton::SetProperty( BaseObject* object, Property::Index propertyIndex, const Property::Value& value )
+{
+  Toolkit::PushButton pushButton = Toolkit::PushButton::DownCast( Dali::BaseHandle( object ) );
+
+  if ( pushButton )
   {
-    // If background and background not scale9 try get size from that
-    ImageActor imageActor = FindImageActor( GetButtonImage() );
-    if( imageActor && imageActor.GetStyle() != ImageActor::STYLE_NINE_PATCH )
-    {
-      Vector3 imageSize = RelayoutHelper::GetNaturalSize( imageActor );
+    PushButton& pushButtonImpl( GetImplementation( pushButton ) );
 
-      if( widthIsZero )
+    switch ( propertyIndex )
+    {
+      case Toolkit::PushButton::Property::UNSELECTED_ICON:
       {
-        size.width = imageSize.width;
+        pushButtonImpl.SetIcon( UNSELECTED_DECORATION, value.Get< std::string >() );
+        break;
       }
-
-      if( heightIsZero )
+      case Toolkit::PushButton::Property::SELECTED_ICON:
+      {
+        pushButtonImpl.SetIcon( SELECTED_DECORATION, value.Get< std::string >() );
+        break;
+      }
+      case Toolkit::PushButton::Property::ICON_ALIGNMENT:
+      {
+        IconAlignment iconAlignment;
+        if( Scripting::GetEnumeration< IconAlignment >( value.Get< std::string >().c_str(), IconAlignmentTable, IconAlignmentTableCount, iconAlignment ) )
+        {
+          pushButtonImpl.SetIconAlignment( iconAlignment );
+        }
+        break;
+      }
+      case Toolkit::PushButton::Property::LABEL_PADDING:
       {
-        size.height = imageSize.height;
+        pushButtonImpl.SetLabelPadding( value.Get< Vector4 >() );
+        break;
+      }
+      case Toolkit::PushButton::Property::ICON_PADDING:
+      {
+        pushButtonImpl.SetIconPadding( value.Get< Vector4 >() );
+        break;
       }
     }
+  }
+}
 
-    ImageActor backgroundImageActor = FindImageActor( GetBackgroundImage() );
-    if( backgroundImageActor && backgroundImageActor.GetStyle() != ImageActor::STYLE_NINE_PATCH )
-    {
-      Vector3 imageSize = RelayoutHelper::GetNaturalSize( backgroundImageActor );
+Property::Value PushButton::GetProperty( BaseObject* object, Property::Index propertyIndex )
+{
+  Property::Value value;
+
+  Toolkit::PushButton pushButton = Toolkit::PushButton::DownCast( Dali::BaseHandle( object ) );
 
-      if( widthIsZero )
+  if ( pushButton )
+  {
+    PushButton& pushButtonImpl( GetImplementation( pushButton ) );
+
+    switch ( propertyIndex )
+    {
+      case Toolkit::PushButton::Property::UNSELECTED_ICON:
       {
-        size.width = std::max( size.width, imageSize.width );
+        value = pushButtonImpl.GetIcon( UNSELECTED_DECORATION );
+        break;
       }
-
-      if( heightIsZero )
+      case Toolkit::PushButton::Property::SELECTED_ICON:
+      {
+        value = pushButtonImpl.GetIcon( UNSELECTED_DECORATION );
+        break;
+      }
+      case Toolkit::PushButton::Property::ICON_ALIGNMENT:
       {
-        size.height = std::max( size.height, imageSize.height );
+        value = Scripting::GetLinearEnumerationName< IconAlignment >( pushButtonImpl.GetIconAlignment(), IconAlignmentTable, IconAlignmentTableCount );
+        break;
       }
+      case Toolkit::PushButton::Property::LABEL_PADDING:
+      {
+        value = pushButtonImpl.GetLabelPadding();
+        break;
+      }
+      case Toolkit::PushButton::Property::ICON_PADDING:
+      {
+        value = pushButtonImpl.GetIconPadding();
+        break;
+      }
+    }
+  }
+
+  return value;
+}
+
+void PushButton::OnLabelSet( bool noPadding )
+{
+  Actor& label = GetLabelActor();
+
+  if( label )
+  {
+    if( noPadding )
+    {
+      mLabelPadding = Padding( 0.0f, 0.0f, 0.0f, 0.0f );
+    }
+
+    Toolkit::TextLabel textLabel = Toolkit::TextLabel::DownCast( label );
+    if( textLabel )
+    {
+      textLabel.SetProperty( Toolkit::TextLabel::Property::MULTI_LINE, false );
+    }
+  }
+  ConfigureSizeNegotiation();
+}
+
+void PushButton::OnButtonImageSet()
+{
+  ConfigureSizeNegotiation();
+}
+
+void PushButton::OnSelectedImageSet()
+{
+  ConfigureSizeNegotiation();
+}
+
+void PushButton::OnBackgroundImageSet()
+{
+  ConfigureSizeNegotiation();
+}
+
+void PushButton::OnSelectedBackgroundImageSet()
+{
+  ConfigureSizeNegotiation();
+}
+
+void PushButton::OnDisabledImageSet()
+{
+  ConfigureSizeNegotiation();
+}
+
+void PushButton::OnDisabledSelectedImageSet()
+{
+  ConfigureSizeNegotiation();
+}
+
+void PushButton::OnDisabledBackgroundImageSet()
+{
+  ConfigureSizeNegotiation();
+}
+
+void PushButton::OnSizeSet( const Vector3& targetSize )
+{
+  if( targetSize != mSize )
+  {
+    mSize = targetSize;
+
+    Actor& label = GetLabelActor();
+
+    if( label )
+    {
+      label.SetSize( mSize );
+    }
+  }
+}
+
+void PushButton::PrepareForTranstionIn( Actor actor )
+{
+  actor.SetOpacity( 0.0f );
+}
+
+void PushButton::PrepareForTranstionOut( Actor actor )
+{
+  actor.SetOpacity( 1.0f );
+}
+
+void PushButton::OnTransitionIn( Actor actor )
+{
+  FadeImageTo( actor, 1.f );
+}
+
+void PushButton::OnTransitionOut( Actor actor )
+{
+  FadeImageTo( actor, 0.0f );
+}
+
+void PushButton::FadeImageTo( Actor actor, float opacity )
+{
+  if( actor )
+  {
+    Dali::Animation transitionAnimation = GetTransitionAnimation();
+    DALI_ASSERT_DEBUG( transitionAnimation );
+
+    if( transitionAnimation )
+    {
+      transitionAnimation.AnimateTo( Property( actor, Actor::Property::COLOR_ALPHA ), opacity );
     }
+  }
+}
+
+Vector3 PushButton::GetNaturalSize()
+{
+  Vector3 size;
+
+  // If label, test against it's size
+  Toolkit::TextLabel label = Toolkit::TextLabel::DownCast( GetLabelActor() );
 
-    // If label, test against it's size
-    Toolkit::TextView textView = Toolkit::TextView::DownCast( GetLabel() );
-    if( textView )
+  Actor icon = GetDecoration( UNSELECTED_DECORATION );
+  if( label || icon )
+  {
+    Vector3 labelSize( Vector3::ZERO );
+    Vector3 iconSize( Vector3::ZERO );
+
+    if( label )
+    {
+      Vector3 labelNaturalSize = label.GetNaturalSize();
+      labelSize.width = labelNaturalSize.width + mLabelPadding.left + mLabelPadding.right;
+      labelSize.height = labelNaturalSize.height + mLabelPadding.top + mLabelPadding.bottom;
+    }
+
+    if( icon )
     {
-      Vector3 textViewSize = textView.GetNaturalSize();
+      Vector3 iconNaturalSize = icon.GetNaturalSize();
+      iconSize.width = iconNaturalSize.width + mIconPadding.left + mIconPadding.right;
+      iconSize.height = iconNaturalSize.height + mIconPadding.top + mIconPadding.bottom;
 
-      if( widthIsZero )
+      switch( mIconAlignment )
       {
-        size.width = std::max( size.width, textViewSize.width + TEXT_PADDING * 2.0f );
+        case LEFT:
+        case RIGHT:
+        {
+          size.width = labelSize.width + iconSize.width;
+          size.height = std::max( labelSize.height, iconSize.height );
+          break;
+        }
+        case TOP:
+        case BOTTOM:
+        {
+          size.width = std::max( labelSize.width, iconSize.width );
+          size.height = labelSize.height + iconSize.height;
+          break;
+        }
       }
+    }
+    else
+    {
+      // No icon, so size is the same as label size.
+      // (If there is no label this is zero).
+      size = labelSize;
+    }
+  }
+  else
+  {
+    // Check Image and Background image and use the largest size as the control's Natural size.
+    SizeOfActorIfLarger( GetUnselectedImage(), size );
+    SizeOfActorIfLarger( GetBackgroundImage(), size );
+  }
+
+  return size;
+}
+
+void PushButton::OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension )
+{
+  ConfigureSizeNegotiation();
+}
+
+void PushButton::ConfigureSizeNegotiation()
+{
+  std::vector< Actor > images;
+  images.reserve( 7 );
 
-      if( heightIsZero )
+  images.push_back( GetUnselectedImage() );
+  images.push_back( GetSelectedImage() );
+  images.push_back( GetSelectedBackgroundImage() );
+  images.push_back( GetBackgroundImage() );
+  images.push_back( GetDisabledImage() );
+  images.push_back( GetDisabledSelectedImage() );
+  images.push_back( GetDisabledBackgroundImage() );
+
+  Actor label = GetLabelActor();
+
+  for( unsigned int i = 0; i < Dimension::DIMENSION_COUNT; ++i )
+  {
+    ConfigureSizeNegotiationDimension( static_cast< Dimension::Type >( 1 << i ), images, label );
+  }
+
+  // Add any vertical padding directly to the actors.
+  Actor icon = GetDecoration( UNSELECTED_DECORATION );
+  Actor selectedIcon = GetDecoration( SELECTED_DECORATION );
+  bool iconExists = icon || selectedIcon;
+
+  if( label )
+  {
+    label.SetPadding( mLabelPadding );
+  }
+  if( icon )
+  {
+    icon.SetPadding( mIconPadding );
+  }
+  if( selectedIcon )
+  {
+    selectedIcon.SetPadding( mIconPadding );
+  }
+
+  // Calculate and apply horizontal alignments and offsets
+  // to text and icon (depending on existence).
+  Vector3 iconPosition( Vector3::ZERO );
+  Vector3 labelPosition( Vector3::ZERO );
+  Vector3 iconAnchoring( AnchorPoint::CENTER );
+  Vector3 labelAnchoring( AnchorPoint::CENTER );
+  std::string horizontalLabelAlignment = "CENTER";
+  std::string verticalLabelAlignment = "CENTER";
+
+  if( iconExists && label )
+  {
+    // There is an icon and a label to lay out.
+    switch( mIconAlignment )
+    {
+      case LEFT:
+      {
+        iconPosition.x = mIconPadding.left;
+        labelPosition.x = -mLabelPadding.right;
+        iconAnchoring = AnchorPoint::CENTER_LEFT;
+        labelAnchoring = AnchorPoint::CENTER_RIGHT;
+        horizontalLabelAlignment = "END";
+        break;
+      }
+      case RIGHT:
+      {
+        iconPosition.x = -mIconPadding.right;
+        labelPosition.x = mLabelPadding.left;
+        iconAnchoring = AnchorPoint::CENTER_RIGHT;
+        labelAnchoring = AnchorPoint::CENTER_LEFT;
+        horizontalLabelAlignment = "BEGIN";
+        break;
+      }
+      case TOP:
       {
-        size.height = std::max( size.height, textViewSize.height + TEXT_PADDING * 2.0f );
+        iconPosition.y = mIconPadding.top;
+        labelPosition.y = -mLabelPadding.bottom;
+        iconAnchoring = AnchorPoint::TOP_CENTER;
+        labelAnchoring = AnchorPoint::BOTTOM_CENTER;
+        verticalLabelAlignment = "BOTTOM";
+        break;
+      }
+      case BOTTOM:
+      {
+        iconPosition.y = -mIconPadding.bottom;
+        labelPosition.y = mLabelPadding.top;
+        iconAnchoring = AnchorPoint::BOTTOM_CENTER;
+        labelAnchoring = AnchorPoint::TOP_CENTER;
+        verticalLabelAlignment = "TOP";
+        break;
       }
     }
   }
 
-  return size;
+  // Note: If there is only an icon, or only a label, the default values are now correct.
+  // Setup the icon(s) with the precalculated values.
+  if( icon )
+  {
+    icon.SetPosition( iconPosition );
+    icon.SetParentOrigin( iconAnchoring );
+    icon.SetAnchorPoint( iconAnchoring );
+  }
+  if( selectedIcon )
+  {
+    selectedIcon.SetPosition( iconPosition );
+    selectedIcon.SetParentOrigin( iconAnchoring );
+    selectedIcon.SetAnchorPoint( iconAnchoring );
+  }
+
+  // Setup the label.
+  if( label )
+  {
+    label.SetPosition( labelPosition );
+    label.SetParentOrigin( labelAnchoring );
+    label.SetAnchorPoint( labelAnchoring );
+    label.SetProperty( Toolkit::TextLabel::Property::HORIZONTAL_ALIGNMENT, horizontalLabelAlignment );
+    label.SetProperty( Toolkit::TextLabel::Property::VERTICAL_ALIGNMENT, verticalLabelAlignment );
+  }
+
+  RelayoutRequest();
+}
+
+
+void PushButton::ConfigureSizeNegotiationDimension( Dimension::Type dimension, const std::vector< Actor >& images, Actor& label )
+{
+  ResizePolicy::Type imageResizePolicy = ResizePolicy::FILL_TO_PARENT;
+  ResizePolicy::Type labelResizePolicy = ResizePolicy::FILL_TO_PARENT;
+
+  ResizePolicy::Type resizePolicy = Self().GetResizePolicy( dimension );
+
+  if( resizePolicy == ResizePolicy::FIT_TO_CHILDREN || resizePolicy == ResizePolicy::USE_NATURAL_SIZE )
+  {
+    if( label )
+    {
+      labelResizePolicy = ResizePolicy::USE_NATURAL_SIZE;
+    }
+    else
+    {
+      imageResizePolicy = ResizePolicy::USE_NATURAL_SIZE;
+    }
+  }
+
+  if( label )
+  {
+    label.SetResizePolicy( labelResizePolicy, dimension );
+  }
+
+  for( std::vector< Actor >::const_iterator it = images.begin(), itEnd = images.end(); it != itEnd; ++it )
+  {
+    Actor actor = *it;
+    if( actor )
+    {
+      actor.SetResizePolicy( imageResizePolicy, dimension );
+    }
+  }
 }
 
+
 } // namespace Internal
 
 } // namespace Toolkit