2 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include "push-button-impl.h"
23 #include <dali/public-api/actors/image-actor.h>
24 #include <dali/public-api/object/type-registry.h>
25 #include <dali/public-api/scripting/scripting.h>
28 #include "push-button-default-painter-impl.h"
30 #include <dali-toolkit/public-api/controls/text-view/text-view.h>
31 #include <dali-toolkit/internal/controls/relayout-helper.h>
39 const Property::Index PushButton::PROPERTY_AUTO_REPEATING = Internal::Button::BUTTON_PROPERTY_END_INDEX + 1;
40 const Property::Index PushButton::PROPERTY_INITIAL_AUTO_REPEATING_DELAY = Internal::Button::BUTTON_PROPERTY_END_INDEX + 2;
41 const Property::Index PushButton::PROPERTY_NEXT_AUTO_REPEATING_DELAY = Internal::Button::BUTTON_PROPERTY_END_INDEX + 3;
42 const Property::Index PushButton::PROPERTY_TOGGLABLE = Internal::Button::BUTTON_PROPERTY_END_INDEX + 4;
43 const Property::Index PushButton::PROPERTY_TOGGLE = Internal::Button::BUTTON_PROPERTY_END_INDEX + 5;
44 const Property::Index PushButton::PROPERTY_NORMAL_STATE_ACTOR = Internal::Button::BUTTON_PROPERTY_END_INDEX + 6;
45 const Property::Index PushButton::PROPERTY_PRESSED_STATE_ACTOR = Internal::Button::BUTTON_PROPERTY_END_INDEX + 7;
46 const Property::Index PushButton::PROPERTY_DIMMED_STATE_ACTOR = Internal::Button::BUTTON_PROPERTY_END_INDEX + 8;
47 const Property::Index PushButton::PROPERTY_LABEL_ACTOR = Internal::Button::BUTTON_PROPERTY_END_INDEX + 9;
57 return Toolkit::PushButton::New();
60 TypeRegistration typeRegistration( typeid(Toolkit::PushButton), typeid(Toolkit::Button), Create );
62 SignalConnectorType signalConnector1( typeRegistration, Toolkit::PushButton::SIGNAL_PRESSED , &PushButton::DoConnectSignal );
63 SignalConnectorType signalConnector2( typeRegistration, Toolkit::PushButton::SIGNAL_RELEASED, &PushButton::DoConnectSignal );
65 TypeAction action1( typeRegistration, Toolkit::PushButton::ACTION_PUSH_BUTTON_CLICK, &PushButton::DoAction );
67 PropertyRegistration property1( typeRegistration, "auto-repeating", Toolkit::PushButton::PROPERTY_AUTO_REPEATING, Property::BOOLEAN, &PushButton::SetProperty, &PushButton::GetProperty );
68 PropertyRegistration property2( typeRegistration, "initial-auto-repeating-delay", Toolkit::PushButton::PROPERTY_INITIAL_AUTO_REPEATING_DELAY, Property::FLOAT, &PushButton::SetProperty, &PushButton::GetProperty );
69 PropertyRegistration property3( typeRegistration, "next-auto-repeating-delay", Toolkit::PushButton::PROPERTY_NEXT_AUTO_REPEATING_DELAY, Property::FLOAT, &PushButton::SetProperty, &PushButton::GetProperty );
70 PropertyRegistration property4( typeRegistration, "togglable", Toolkit::PushButton::PROPERTY_TOGGLABLE, Property::BOOLEAN, &PushButton::SetProperty, &PushButton::GetProperty );
71 PropertyRegistration property5( typeRegistration, "toggle", Toolkit::PushButton::PROPERTY_TOGGLE, Property::BOOLEAN, &PushButton::SetProperty, &PushButton::GetProperty );
72 PropertyRegistration property6( typeRegistration, "normal-state-actor", Toolkit::PushButton::PROPERTY_NORMAL_STATE_ACTOR, Property::MAP, &PushButton::SetProperty, &PushButton::GetProperty );
73 PropertyRegistration property7( typeRegistration, "pressed-state-actor", Toolkit::PushButton::PROPERTY_PRESSED_STATE_ACTOR, Property::MAP, &PushButton::SetProperty, &PushButton::GetProperty );
74 PropertyRegistration property8( typeRegistration, "dimmed-state-actor", Toolkit::PushButton::PROPERTY_DIMMED_STATE_ACTOR, Property::MAP, &PushButton::SetProperty, &PushButton::GetProperty );
75 PropertyRegistration property9( typeRegistration, "label-actor", Toolkit::PushButton::PROPERTY_LABEL_ACTOR, Property::MAP, &PushButton::SetProperty, &PushButton::GetProperty );
77 } // unnamed namespace
82 const unsigned int INITIAL_AUTOREPEATING_DELAY( 0.15f );
83 const unsigned int NEXT_AUTOREPEATING_DELAY( 0.05f );
85 const float TEXT_PADDING = 12.0f;
87 // Helper function used to cast a ButtonPainter to PushButtonDefaultPainter
88 PushButtonDefaultPainterPtr GetPushButtonPainter( Dali::Toolkit::Internal::ButtonPainterPtr painter )
90 return static_cast<PushButtonDefaultPainter*>( painter.Get() );
94 * Find the first image actor in the actor hierarchy
96 ImageActor FindImageActor( Actor root )
98 ImageActor imageActor = ImageActor::DownCast( root );
99 if( !imageActor && root )
101 for( unsigned int i = 0, numChildren = root.GetChildCount(); i < numChildren; ++i )
103 ImageActor childImageActor = FindImageActor( root.GetChildAt( i ) );
104 if( childImageActor )
106 return childImageActor;
115 } // unnamed namespace
117 Dali::Toolkit::PushButton PushButton::New()
119 // Create the implementation, temporarily owned on stack
120 IntrusivePtr< PushButton > internalPushButton = new PushButton();
122 // Pass ownership to CustomActor
123 Dali::Toolkit::PushButton pushButton( *internalPushButton );
125 // Second-phase init of the implementation
126 // This can only be done after the CustomActor connection has been made...
127 internalPushButton->Initialize();
132 void PushButton::SetAutoRepeating( bool autoRepeating )
134 mAutoRepeating = autoRepeating;
136 // An autorepeating button can't be a toggle button.
139 mToggleButton = false;
142 // Emit a signal is not wanted, only change the appearance.
143 Toolkit::PushButton handle( GetOwner() );
144 GetPushButtonPainter( mPainter )->Toggled( handle );
149 // Notifies the painter.
150 GetPushButtonPainter( mPainter )->SetAutoRepeating( mAutoRepeating );
153 bool PushButton::IsAutoRepeating() const
155 return mAutoRepeating;
158 void PushButton::SetInitialAutoRepeatingDelay( float initialAutoRepeatingDelay )
160 DALI_ASSERT_ALWAYS( initialAutoRepeatingDelay > 0.f );
161 mInitialAutoRepeatingDelay = initialAutoRepeatingDelay;
164 float PushButton::GetInitialAutoRepeatingDelay() const
166 return mInitialAutoRepeatingDelay;
169 void PushButton::SetNextAutoRepeatingDelay( float nextAutoRepeatingDelay )
171 DALI_ASSERT_ALWAYS( nextAutoRepeatingDelay > 0.f );
172 mNextAutoRepeatingDelay = nextAutoRepeatingDelay;
175 float PushButton::GetNextAutoRepeatingDelay() const
177 return mNextAutoRepeatingDelay;
180 void PushButton::SetToggleButton( bool toggle )
182 mToggleButton = toggle;
184 // A toggle button can't be an autorepeating button.
187 mAutoRepeating = false;
189 // Notifies the painter.
190 GetPushButtonPainter( mPainter )->SetAutoRepeating( mAutoRepeating );
194 bool PushButton::IsToggleButton() const
196 return mToggleButton;
199 void PushButton::SetToggled( bool toggle )
201 if( !mDimmed && mToggleButton && ( toggle != mToggled ) )
205 Toolkit::PushButton handle( GetOwner() );
207 // Notifies the painter the button has been toggled.
208 GetPushButtonPainter( mPainter )->Toggled( handle );
211 mToggledSignal.Emit( handle, mToggled );
215 bool PushButton::IsToggled() const
217 return mToggleButton && mToggled;
220 void PushButton::SetButtonImage( Image image )
222 SetButtonImage( ImageActor::New( image ) );
225 void PushButton::SetButtonImage( Actor image )
227 Toolkit::PushButton handle( GetOwner() );
228 GetPushButtonPainter( mPainter )->SetButtonImage( handle, image );
231 Actor& PushButton::GetButtonImage()
236 Actor PushButton::GetButtonImage() const
241 void PushButton::SetBackgroundImage( Image image )
243 SetBackgroundImage( ImageActor::New( image ) );
246 void PushButton::SetBackgroundImage( Actor image )
248 Toolkit::PushButton handle( GetOwner() );
249 GetPushButtonPainter( mPainter )->SetBackgroundImage( handle, image );
252 Actor& PushButton::GetBackgroundImage()
254 return mBackgroundImage;
257 Actor PushButton::GetBackgroundImage() const
259 return mBackgroundImage;
262 void PushButton::SetPressedImage( Image image )
264 SetPressedImage( ImageActor::New( image ) );
267 void PushButton::SetPressedImage( Actor image )
269 Toolkit::PushButton handle( GetOwner() );
270 GetPushButtonPainter( mPainter )->SetPressedImage( handle, image );
273 Actor& PushButton::GetPressedImage()
275 return mPressedImage;
278 Actor PushButton::GetPressedImage() const
280 return mPressedImage;
283 void PushButton::SetDimmedBackgroundImage( Image image )
285 SetDimmedBackgroundImage( ImageActor::New( image ) );
288 void PushButton::SetDimmedBackgroundImage( Actor image )
290 Toolkit::PushButton handle( GetOwner() );
291 GetPushButtonPainter( mPainter )->SetDimmedBackgroundImage( handle, image );
294 Actor& PushButton::GetDimmedBackgroundImage()
296 return mDimmedBackgroundImage;
299 Actor PushButton::GetDimmedBackgroundImage() const
301 return mDimmedBackgroundImage;
304 void PushButton::SetDimmedImage( Image image )
306 SetDimmedImage( ImageActor::New( image ) );
309 void PushButton::SetDimmedImage( Actor image )
311 Toolkit::PushButton handle( GetOwner() );
312 GetPushButtonPainter( mPainter )->SetDimmedImage( handle, image );
315 Actor& PushButton::GetDimmedImage()
320 Actor PushButton::GetDimmedImage() const
325 void PushButton::SetLabelText( const std::string& text )
327 Toolkit::TextView textView ( Toolkit::TextView::New( text ) );
328 textView.SetWidthExceedPolicy( Toolkit::TextView::ShrinkToFit ); // Make sure our text always fits inside the button
329 SetLabelText( textView );
332 void PushButton::SetLabelText( Actor text )
334 Toolkit::PushButton handle( GetOwner() );
335 GetPushButtonPainter( mPainter )->SetLabelText( handle, text );
338 Actor& PushButton::GetLabel()
343 Actor PushButton::GetLabelText() const
348 Actor& PushButton::GetFadeOutBackgroundImage()
350 return mFadeOutBackgroundImage;
353 Actor& PushButton::GetFadeOutButtonImage()
355 return mFadeOutButtonImage;
358 Toolkit::PushButton::PressedSignalType& PushButton::PressedSignal()
360 return mPressedSignal;
363 Toolkit::PushButton::ReleasedSignalType& PushButton::ReleasedSignal()
365 return mReleasedSignal;
368 bool PushButton::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
370 Dali::BaseHandle handle( object );
372 bool connected( true );
373 Toolkit::PushButton button = Toolkit::PushButton::DownCast(handle);
375 if( Toolkit::PushButton::SIGNAL_TOGGLED == signalName )
377 button.ToggledSignal().Connect( tracker, functor );
379 else if( Toolkit::PushButton::SIGNAL_PRESSED == signalName )
381 button.PressedSignal().Connect( tracker, functor );
383 else if( Toolkit::PushButton::SIGNAL_RELEASED == signalName )
385 button.ReleasedSignal().Connect( tracker, functor );
389 // signalName does not match any signal
396 void PushButton::SetProperty( BaseObject* object, Property::Index propertyIndex, const Property::Value& value )
398 Toolkit::PushButton pushButton = Toolkit::PushButton::DownCast( Dali::BaseHandle( object ) );
402 PushButton& pushButtonImpl( GetImplementation( pushButton ) );
404 switch ( propertyIndex )
406 case Toolkit::PushButton::PROPERTY_AUTO_REPEATING:
408 pushButtonImpl.SetAutoRepeating( value.Get< bool >() );
412 case Toolkit::PushButton::PROPERTY_INITIAL_AUTO_REPEATING_DELAY:
414 pushButtonImpl.SetInitialAutoRepeatingDelay( value.Get< float >() );
418 case Toolkit::PushButton::PROPERTY_NEXT_AUTO_REPEATING_DELAY:
420 pushButtonImpl.SetNextAutoRepeatingDelay( value.Get< float >() );
424 case Toolkit::PushButton::PROPERTY_TOGGLABLE:
426 pushButtonImpl.SetToggleButton( value.Get< bool >() );
430 case Toolkit::PushButton::PROPERTY_TOGGLE:
432 pushButtonImpl.SetToggled( value.Get< bool >() );
436 case Toolkit::PushButton::PROPERTY_NORMAL_STATE_ACTOR:
438 pushButtonImpl.SetButtonImage( Scripting::NewActor( value.Get< Property::Map >() ) );
442 case Toolkit::PushButton::PROPERTY_PRESSED_STATE_ACTOR:
444 pushButtonImpl.SetPressedImage( Scripting::NewActor( value.Get< Property::Map >() ) );
448 case Toolkit::PushButton::PROPERTY_DIMMED_STATE_ACTOR:
450 pushButtonImpl.SetDimmedImage( Scripting::NewActor( value.Get< Property::Map >() ) );
454 case Toolkit::PushButton::PROPERTY_LABEL_ACTOR:
456 pushButtonImpl.SetLabelText( Scripting::NewActor( value.Get< Property::Map >() ) );
463 Property::Value PushButton::GetProperty( BaseObject* object, Property::Index propertyIndex )
465 Property::Value value;
467 Toolkit::PushButton pushButton = Toolkit::PushButton::DownCast( Dali::BaseHandle( object ) );
471 PushButton& pushButtonImpl( GetImplementation( pushButton ) );
473 switch ( propertyIndex )
475 case Toolkit::PushButton::PROPERTY_AUTO_REPEATING:
477 value = pushButtonImpl.mAutoRepeating;
481 case Toolkit::PushButton::PROPERTY_INITIAL_AUTO_REPEATING_DELAY:
483 value = pushButtonImpl.mInitialAutoRepeatingDelay;
487 case Toolkit::PushButton::PROPERTY_NEXT_AUTO_REPEATING_DELAY:
489 value = pushButtonImpl.mNextAutoRepeatingDelay;
493 case Toolkit::PushButton::PROPERTY_TOGGLABLE:
495 value = pushButtonImpl.mToggleButton;
499 case Toolkit::PushButton::PROPERTY_TOGGLE:
501 value = pushButtonImpl.mToggled;
505 case Toolkit::PushButton::PROPERTY_NORMAL_STATE_ACTOR:
508 Scripting::CreatePropertyMap( pushButtonImpl.mButtonImage, map );
513 case Toolkit::PushButton::PROPERTY_PRESSED_STATE_ACTOR:
516 Scripting::CreatePropertyMap( pushButtonImpl.mPressedImage, map );
521 case Toolkit::PushButton::PROPERTY_DIMMED_STATE_ACTOR:
524 Scripting::CreatePropertyMap( pushButtonImpl.mDimmedImage, map );
529 case Toolkit::PushButton::PROPERTY_LABEL_ACTOR:
532 Scripting::CreatePropertyMap( pushButtonImpl.mLabel, map );
542 void PushButton::OnButtonInitialize()
544 // Push button requires the Leave event.
546 root.SetLeaveRequired( true );
549 void PushButton::OnButtonDown()
553 Toolkit::PushButton handle( GetOwner() );
555 // Notifies the painter the button has been pressed.
556 GetPushButtonPainter( mPainter )->Pressed( handle );
560 SetUpTimer( mInitialAutoRepeatingDelay );
564 mPressedSignal.Emit( handle );
568 void PushButton::OnButtonUp()
570 if( ButtonDown == mState )
574 mToggled = !mToggled;
576 Toolkit::PushButton handle( GetOwner() );
578 // Notifies the painter the button has been toggled.
579 GetPushButtonPainter( mPainter )->Toggled( handle );
582 mToggledSignal.Emit( handle, mToggled );
586 Toolkit::PushButton handle( GetOwner() );
588 // Notifies the painter the button has been clicked.
589 GetPushButtonPainter( mPainter )->Released( handle );
590 GetPushButtonPainter( mPainter )->Clicked( handle );
594 mAutoRepeatingTimer.Reset();
598 mReleasedSignal.Emit( handle );
599 mClickedSignal.Emit( handle );
604 void PushButton::OnTouchPointLeave()
606 if( ButtonDown == mState )
610 Toolkit::PushButton handle( GetOwner() );
612 // Notifies the painter the button has been released.
613 GetPushButtonPainter( mPainter )->Released( handle );
617 mAutoRepeatingTimer.Reset();
621 mReleasedSignal.Emit( handle );
626 void PushButton::OnTouchPointInterrupted()
631 void PushButton::OnAnimationTimeSet( float animationTime )
633 GetPushButtonPainter( mPainter )->SetAnimationTime( animationTime );
636 float PushButton::OnAnimationTimeRequested() const
638 return GetPushButtonPainter( mPainter )->GetAnimationTime();
641 void PushButton::OnButtonStageDisconnection()
643 if( ButtonDown == mState )
647 Toolkit::PushButton handle( GetOwner() );
649 // Notifies the painter the button has been released.
650 GetPushButtonPainter( mPainter )->Released( handle );
654 mAutoRepeatingTimer.Reset();
660 PushButton::PushButton()
662 mAutoRepeating( false ),
663 mInitialAutoRepeatingDelay( INITIAL_AUTOREPEATING_DELAY ),
664 mNextAutoRepeatingDelay( NEXT_AUTOREPEATING_DELAY ),
665 mToggleButton( false ),
666 mAutoRepeatingTimer(),
668 mClickActionPerforming(false)
670 // Creates specific painter.
671 mPainter = PushButtonDefaultPainterPtr( new PushButtonDefaultPainter() );
674 PushButton::~PushButton()
676 if( mAutoRepeatingTimer )
678 mAutoRepeatingTimer.Reset();
684 void PushButton::SetUpTimer( float delay )
686 mAutoRepeatingTimer = Dali::Timer::New( static_cast<unsigned int>( 1000.f * delay ) );
687 mAutoRepeatingTimer.TickSignal().Connect( this, &PushButton::AutoRepeatingSlot );
688 mAutoRepeatingTimer.Start();
691 bool PushButton::AutoRepeatingSlot()
693 bool consumed = false;
696 // Restart the autorepeat timer.
697 SetUpTimer( mNextAutoRepeatingDelay );
699 Toolkit::PushButton handle( GetOwner() );
701 // Notifies the painter the button has been pressed.
702 GetPushButtonPainter( mPainter )->Pressed( handle );
705 consumed = mReleasedSignal.Emit( handle );
706 consumed |= mClickedSignal.Emit( handle );
707 consumed |= mPressedSignal.Emit( handle );
713 void PushButton::OnActivated()
715 // When the button is activated, it performs the click action
716 PropertyValueContainer attributes;
717 DoClickAction(attributes);
720 Vector3 PushButton::GetNaturalSize()
722 Vector3 size = Control::GetNaturalSize();
724 const bool widthIsZero = EqualsZero( size.width );
725 const bool heightIsZero = EqualsZero( size.height );
727 if( widthIsZero || heightIsZero )
729 // If background and background not scale9 try get size from that
730 ImageActor imageActor = FindImageActor( mButtonImage );
731 if( imageActor && imageActor.GetStyle() != ImageActor::STYLE_NINE_PATCH )
733 Vector3 imageSize = RelayoutHelper::GetNaturalSize( imageActor );
737 size.width = imageSize.width;
742 size.height = imageSize.height;
746 ImageActor backgroundImageActor = FindImageActor( mBackgroundImage );
747 if( backgroundImageActor && backgroundImageActor.GetStyle() != ImageActor::STYLE_NINE_PATCH )
749 Vector3 imageSize = RelayoutHelper::GetNaturalSize( backgroundImageActor );
753 size.width = std::max( size.width, imageSize.width );
758 size.height = std::max( size.height, imageSize.height );
762 // If label, test against it's size
763 Toolkit::TextView textView = Toolkit::TextView::DownCast( mLabel );
766 Vector3 textViewSize = textView.GetNaturalSize();
770 size.width = std::max( size.width, textViewSize.width + TEXT_PADDING * 2.0f );
775 size.height = std::max( size.height, textViewSize.height + TEXT_PADDING * 2.0f );
783 void PushButton::DoClickAction(const PropertyValueContainer& attributes)
785 // Prevents the button signals from doing a recursive loop by sending an action
786 // and re-emitting the signals.
787 if(!mClickActionPerforming)
789 mClickActionPerforming = true;
793 mClickActionPerforming = false;
797 bool PushButton::DoAction(BaseObject* object, const std::string& actionName, const PropertyValueContainer& attributes)
801 Dali::BaseHandle handle(object);
803 Toolkit::PushButton button = Toolkit::PushButton::DownCast(handle);
805 DALI_ASSERT_ALWAYS(button);
807 if(Toolkit::PushButton::ACTION_PUSH_BUTTON_CLICK == actionName)
809 GetImplementation(button).DoClickAction(attributes);
816 } // namespace Internal
818 } // namespace Toolkit