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.
20 #include "push-button-impl.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_TOGGLED , &PushButton::DoConnectSignal );
63 SignalConnectorType signalConnector2( typeRegistration, Toolkit::PushButton::SIGNAL_PRESSED , &PushButton::DoConnectSignal );
64 SignalConnectorType signalConnector3( typeRegistration, Toolkit::PushButton::SIGNAL_RELEASED, &PushButton::DoConnectSignal );
66 TypeAction action1( typeRegistration, Toolkit::PushButton::ACTION_PUSH_BUTTON_CLICK, &PushButton::DoAction );
68 PropertyRegistration property1( typeRegistration, "auto-repeating", Toolkit::PushButton::PROPERTY_AUTO_REPEATING, Property::BOOLEAN, &PushButton::SetProperty, &PushButton::GetProperty );
69 PropertyRegistration property2( typeRegistration, "initial-auto-repeating-delay", Toolkit::PushButton::PROPERTY_INITIAL_AUTO_REPEATING_DELAY, Property::FLOAT, &PushButton::SetProperty, &PushButton::GetProperty );
70 PropertyRegistration property3( typeRegistration, "next-auto-repeating-delay", Toolkit::PushButton::PROPERTY_NEXT_AUTO_REPEATING_DELAY, Property::FLOAT, &PushButton::SetProperty, &PushButton::GetProperty );
71 PropertyRegistration property4( typeRegistration, "togglable", Toolkit::PushButton::PROPERTY_TOGGLABLE, Property::BOOLEAN, &PushButton::SetProperty, &PushButton::GetProperty );
72 PropertyRegistration property5( typeRegistration, "toggle", Toolkit::PushButton::PROPERTY_TOGGLE, Property::BOOLEAN, &PushButton::SetProperty, &PushButton::GetProperty );
73 PropertyRegistration property6( typeRegistration, "normal-state-actor", Toolkit::PushButton::PROPERTY_NORMAL_STATE_ACTOR, Property::MAP, &PushButton::SetProperty, &PushButton::GetProperty );
74 PropertyRegistration property7( typeRegistration, "pressed-state-actor", Toolkit::PushButton::PROPERTY_PRESSED_STATE_ACTOR, Property::MAP, &PushButton::SetProperty, &PushButton::GetProperty );
75 PropertyRegistration property8( typeRegistration, "dimmed-state-actor", Toolkit::PushButton::PROPERTY_DIMMED_STATE_ACTOR, Property::MAP, &PushButton::SetProperty, &PushButton::GetProperty );
76 PropertyRegistration property9( typeRegistration, "label-actor", Toolkit::PushButton::PROPERTY_LABEL_ACTOR, Property::MAP, &PushButton::SetProperty, &PushButton::GetProperty );
78 } // unnamed namespace
83 const unsigned int INITIAL_AUTOREPEATING_DELAY( 0.15f );
84 const unsigned int NEXT_AUTOREPEATING_DELAY( 0.05f );
86 const float TEXT_PADDING = 12.0f;
88 // Helper function used to cast a ButtonPainter to PushButtonDefaultPainter
89 PushButtonDefaultPainterPtr GetPushButtonPainter( Dali::Toolkit::Internal::ButtonPainterPtr painter )
91 return static_cast<PushButtonDefaultPainter*>( painter.Get() );
95 * Find the first image actor in the actor hierarchy
97 ImageActor FindImageActor( Actor root )
99 ImageActor imageActor = ImageActor::DownCast( root );
100 if( !imageActor && root )
102 for( unsigned int i = 0, numChildren = root.GetChildCount(); i < numChildren; ++i )
104 ImageActor childImageActor = FindImageActor( root.GetChildAt( i ) );
105 if( childImageActor )
107 return childImageActor;
116 } // unnamed namespace
118 Dali::Toolkit::PushButton PushButton::New()
120 // Create the implementation, temporarily owned on stack
121 IntrusivePtr< PushButton > internalPushButton = new PushButton();
123 // Pass ownership to CustomActor
124 Dali::Toolkit::PushButton pushButton( *internalPushButton );
126 // Second-phase init of the implementation
127 // This can only be done after the CustomActor connection has been made...
128 internalPushButton->Initialize();
133 void PushButton::SetAutoRepeating( bool autoRepeating )
135 mAutoRepeating = autoRepeating;
137 // An autorepeating button can't be a toggle button.
140 mToggleButton = false;
143 // Emit a signal is not wanted, only change the appearance.
144 Toolkit::PushButton handle( GetOwner() );
145 GetPushButtonPainter( mPainter )->Toggled( handle );
150 // Notifies the painter.
151 GetPushButtonPainter( mPainter )->SetAutoRepeating( mAutoRepeating );
154 bool PushButton::IsAutoRepeating() const
156 return mAutoRepeating;
159 void PushButton::SetInitialAutoRepeatingDelay( float initialAutoRepeatingDelay )
161 DALI_ASSERT_ALWAYS( initialAutoRepeatingDelay > 0.f );
162 mInitialAutoRepeatingDelay = initialAutoRepeatingDelay;
165 float PushButton::GetInitialAutoRepeatingDelay() const
167 return mInitialAutoRepeatingDelay;
170 void PushButton::SetNextAutoRepeatingDelay( float nextAutoRepeatingDelay )
172 DALI_ASSERT_ALWAYS( nextAutoRepeatingDelay > 0.f );
173 mNextAutoRepeatingDelay = nextAutoRepeatingDelay;
176 float PushButton::GetNextAutoRepeatingDelay() const
178 return mNextAutoRepeatingDelay;
181 void PushButton::SetToggleButton( bool toggle )
183 mToggleButton = toggle;
185 // A toggle button can't be an autorepeating button.
188 mAutoRepeating = false;
190 // Notifies the painter.
191 GetPushButtonPainter( mPainter )->SetAutoRepeating( mAutoRepeating );
195 bool PushButton::IsToggleButton() const
197 return mToggleButton;
200 void PushButton::SetToggled( bool toggle )
202 if( !mDimmed && mToggleButton && ( toggle != mToggled ) )
206 Toolkit::PushButton handle( GetOwner() );
208 // Notifies the painter the button has been toggled.
209 GetPushButtonPainter( mPainter )->Toggled( handle );
212 mToggledSignalV2.Emit( handle, mToggled );
216 bool PushButton::IsToggled() const
218 return mToggleButton && mToggled;
221 void PushButton::SetButtonImage( Image image )
223 SetButtonImage( ImageActor::New( image ) );
226 void PushButton::SetButtonImage( Actor image )
228 Toolkit::PushButton handle( GetOwner() );
229 GetPushButtonPainter( mPainter )->SetButtonImage( handle, image );
232 Actor& PushButton::GetButtonImage()
237 Actor PushButton::GetButtonImage() const
242 void PushButton::SetBackgroundImage( Image image )
244 SetBackgroundImage( ImageActor::New( image ) );
247 void PushButton::SetBackgroundImage( Actor image )
249 Toolkit::PushButton handle( GetOwner() );
250 GetPushButtonPainter( mPainter )->SetBackgroundImage( handle, image );
253 Actor& PushButton::GetBackgroundImage()
255 return mBackgroundImage;
258 Actor PushButton::GetBackgroundImage() const
260 return mBackgroundImage;
263 void PushButton::SetPressedImage( Image image )
265 SetPressedImage( ImageActor::New( image ) );
268 void PushButton::SetPressedImage( Actor image )
270 Toolkit::PushButton handle( GetOwner() );
271 GetPushButtonPainter( mPainter )->SetPressedImage( handle, image );
274 Actor& PushButton::GetPressedImage()
276 return mPressedImage;
279 Actor PushButton::GetPressedImage() const
281 return mPressedImage;
284 void PushButton::SetDimmedBackgroundImage( Image image )
286 SetDimmedBackgroundImage( ImageActor::New( image ) );
289 void PushButton::SetDimmedBackgroundImage( Actor image )
291 Toolkit::PushButton handle( GetOwner() );
292 GetPushButtonPainter( mPainter )->SetDimmedBackgroundImage( handle, image );
295 Actor& PushButton::GetDimmedBackgroundImage()
297 return mDimmedBackgroundImage;
300 Actor PushButton::GetDimmedBackgroundImage() const
302 return mDimmedBackgroundImage;
305 void PushButton::SetDimmedImage( Image image )
307 SetDimmedImage( ImageActor::New( image ) );
310 void PushButton::SetDimmedImage( Actor image )
312 Toolkit::PushButton handle( GetOwner() );
313 GetPushButtonPainter( mPainter )->SetDimmedImage( handle, image );
316 Actor& PushButton::GetDimmedImage()
321 Actor PushButton::GetDimmedImage() const
326 void PushButton::SetLabelText( const std::string& text )
328 Toolkit::TextView textView ( Toolkit::TextView::New( text ) );
329 textView.SetWidthExceedPolicy( Toolkit::TextView::ShrinkToFit ); // Make sure our text always fits inside the button
330 SetLabelText( textView );
333 void PushButton::SetLabelText( Actor text )
335 Toolkit::PushButton handle( GetOwner() );
336 GetPushButtonPainter( mPainter )->SetLabelText( handle, text );
339 Actor& PushButton::GetLabel()
344 Actor PushButton::GetLabelText() const
349 Actor& PushButton::GetFadeOutBackgroundImage()
351 return mFadeOutBackgroundImage;
354 Actor& PushButton::GetFadeOutButtonImage()
356 return mFadeOutButtonImage;
359 Toolkit::PushButton::ToggledSignalV2& PushButton::ToggledSignal()
361 return mToggledSignalV2;
364 Toolkit::PushButton::PressedSignalV2& PushButton::PressedSignal()
366 return mPressedSignalV2;
369 Toolkit::PushButton::ReleasedSignalV2& PushButton::ReleasedSignal()
371 return mReleasedSignalV2;
374 bool PushButton::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
376 Dali::BaseHandle handle( object );
378 bool connected( true );
379 Toolkit::PushButton button = Toolkit::PushButton::DownCast(handle);
381 if( Toolkit::PushButton::SIGNAL_TOGGLED == signalName )
383 button.ToggledSignal().Connect( tracker, functor );
385 else if( Toolkit::PushButton::SIGNAL_PRESSED == signalName )
387 button.PressedSignal().Connect( tracker, functor );
389 else if( Toolkit::PushButton::SIGNAL_RELEASED == signalName )
391 button.ReleasedSignal().Connect( tracker, functor );
395 // signalName does not match any signal
402 void PushButton::SetProperty( BaseObject* object, Property::Index propertyIndex, const Property::Value& value )
404 Toolkit::PushButton pushButton = Toolkit::PushButton::DownCast( Dali::BaseHandle( object ) );
408 PushButton& pushButtonImpl( GetImplementation( pushButton ) );
410 switch ( propertyIndex )
412 case Toolkit::PushButton::PROPERTY_AUTO_REPEATING:
414 pushButtonImpl.SetAutoRepeating( value.Get< bool >() );
418 case Toolkit::PushButton::PROPERTY_INITIAL_AUTO_REPEATING_DELAY:
420 pushButtonImpl.SetInitialAutoRepeatingDelay( value.Get< float >() );
424 case Toolkit::PushButton::PROPERTY_NEXT_AUTO_REPEATING_DELAY:
426 pushButtonImpl.SetNextAutoRepeatingDelay( value.Get< float >() );
430 case Toolkit::PushButton::PROPERTY_TOGGLABLE:
432 pushButtonImpl.SetToggleButton( value.Get< bool >() );
436 case Toolkit::PushButton::PROPERTY_TOGGLE:
438 pushButtonImpl.SetToggled( value.Get< bool >() );
442 case Toolkit::PushButton::PROPERTY_NORMAL_STATE_ACTOR:
444 pushButtonImpl.SetButtonImage( Scripting::NewActor( value.Get< Property::Map >() ) );
448 case Toolkit::PushButton::PROPERTY_PRESSED_STATE_ACTOR:
450 pushButtonImpl.SetPressedImage( Scripting::NewActor( value.Get< Property::Map >() ) );
454 case Toolkit::PushButton::PROPERTY_DIMMED_STATE_ACTOR:
456 pushButtonImpl.SetDimmedImage( Scripting::NewActor( value.Get< Property::Map >() ) );
460 case Toolkit::PushButton::PROPERTY_LABEL_ACTOR:
462 pushButtonImpl.SetLabelText( Scripting::NewActor( value.Get< Property::Map >() ) );
469 Property::Value PushButton::GetProperty( BaseObject* object, Property::Index propertyIndex )
471 Property::Value value;
473 Toolkit::PushButton pushButton = Toolkit::PushButton::DownCast( Dali::BaseHandle( object ) );
477 PushButton& pushButtonImpl( GetImplementation( pushButton ) );
479 switch ( propertyIndex )
481 case Toolkit::PushButton::PROPERTY_AUTO_REPEATING:
483 value = pushButtonImpl.mAutoRepeating;
487 case Toolkit::PushButton::PROPERTY_INITIAL_AUTO_REPEATING_DELAY:
489 value = pushButtonImpl.mInitialAutoRepeatingDelay;
493 case Toolkit::PushButton::PROPERTY_NEXT_AUTO_REPEATING_DELAY:
495 value = pushButtonImpl.mNextAutoRepeatingDelay;
499 case Toolkit::PushButton::PROPERTY_TOGGLABLE:
501 value = pushButtonImpl.mToggleButton;
505 case Toolkit::PushButton::PROPERTY_TOGGLE:
507 value = pushButtonImpl.mToggled;
511 case Toolkit::PushButton::PROPERTY_NORMAL_STATE_ACTOR:
514 Scripting::CreatePropertyMap( pushButtonImpl.mButtonImage, map );
519 case Toolkit::PushButton::PROPERTY_PRESSED_STATE_ACTOR:
522 Scripting::CreatePropertyMap( pushButtonImpl.mPressedImage, map );
527 case Toolkit::PushButton::PROPERTY_DIMMED_STATE_ACTOR:
530 Scripting::CreatePropertyMap( pushButtonImpl.mDimmedImage, map );
535 case Toolkit::PushButton::PROPERTY_LABEL_ACTOR:
538 Scripting::CreatePropertyMap( pushButtonImpl.mLabel, map );
548 void PushButton::OnButtonInitialize()
550 // Push button requires the Leave event.
552 root.SetLeaveRequired( true );
555 void PushButton::OnButtonDown()
559 Toolkit::PushButton handle( GetOwner() );
561 // Notifies the painter the button has been pressed.
562 GetPushButtonPainter( mPainter )->Pressed( handle );
566 SetUpTimer( mInitialAutoRepeatingDelay );
570 mPressedSignalV2.Emit( handle );
574 void PushButton::OnButtonUp()
576 if( ButtonDown == mState )
580 mToggled = !mToggled;
582 Toolkit::PushButton handle( GetOwner() );
584 // Notifies the painter the button has been toggled.
585 GetPushButtonPainter( mPainter )->Toggled( handle );
588 mToggledSignalV2.Emit( handle, mToggled );
592 Toolkit::PushButton handle( GetOwner() );
594 // Notifies the painter the button has been clicked.
595 GetPushButtonPainter( mPainter )->Released( handle );
596 GetPushButtonPainter( mPainter )->Clicked( handle );
600 mAutoRepeatingTimer.Reset();
604 mReleasedSignalV2.Emit( handle );
605 mClickedSignalV2.Emit( handle );
610 void PushButton::OnTouchPointLeave()
612 if( ButtonDown == mState )
616 Toolkit::PushButton handle( GetOwner() );
618 // Notifies the painter the button has been released.
619 GetPushButtonPainter( mPainter )->Released( handle );
623 mAutoRepeatingTimer.Reset();
627 mReleasedSignalV2.Emit( handle );
632 void PushButton::OnTouchPointInterrupted()
637 void PushButton::OnAnimationTimeSet( float animationTime )
639 GetPushButtonPainter( mPainter )->SetAnimationTime( animationTime );
642 float PushButton::OnAnimationTimeRequested() const
644 return GetPushButtonPainter( mPainter )->GetAnimationTime();
647 PushButton::PushButton()
649 mAutoRepeating( false ),
650 mInitialAutoRepeatingDelay( INITIAL_AUTOREPEATING_DELAY ),
651 mNextAutoRepeatingDelay( NEXT_AUTOREPEATING_DELAY ),
652 mToggleButton( false ),
653 mAutoRepeatingTimer(),
655 mClickActionPerforming(false)
657 // Creates specific painter.
658 mPainter = PushButtonDefaultPainterPtr( new PushButtonDefaultPainter() );
661 PushButton::~PushButton()
663 if( mAutoRepeatingTimer )
665 mAutoRepeatingTimer.Reset();
671 void PushButton::SetUpTimer( float delay )
673 mAutoRepeatingTimer = Dali::Timer::New( static_cast<unsigned int>( 1000.f * delay ) );
674 mAutoRepeatingTimer.TickSignal().Connect( this, &PushButton::AutoRepeatingSlot );
675 mAutoRepeatingTimer.Start();
678 bool PushButton::AutoRepeatingSlot()
680 bool consumed = false;
683 // Restart the autorepeat timer.
684 SetUpTimer( mNextAutoRepeatingDelay );
686 Toolkit::PushButton handle( GetOwner() );
688 // Notifies the painter the button has been pressed.
689 GetPushButtonPainter( mPainter )->Pressed( handle );
692 consumed = mReleasedSignalV2.Emit( handle );
693 consumed |= mClickedSignalV2.Emit( handle );
694 consumed |= mPressedSignalV2.Emit( handle );
700 void PushButton::OnActivated()
702 // When the button is activated, it performs the click action
703 std::vector<Property::Value> attributes;
704 DoClickAction(attributes);
707 Vector3 PushButton::GetNaturalSize()
709 Vector3 size = Control::GetNaturalSize();
711 const bool widthIsZero = EqualsZero( size.width );
712 const bool heightIsZero = EqualsZero( size.height );
714 if( widthIsZero || heightIsZero )
716 // If background and background not scale9 try get size from that
717 ImageActor imageActor = FindImageActor( mButtonImage );
718 if( imageActor && imageActor.GetStyle() != ImageActor::STYLE_NINE_PATCH )
720 Vector3 imageSize = RelayoutHelper::GetNaturalSize( imageActor );
724 size.width = imageSize.width;
729 size.height = imageSize.height;
733 ImageActor backgroundImageActor = FindImageActor( mBackgroundImage );
734 if( backgroundImageActor && backgroundImageActor.GetStyle() != ImageActor::STYLE_NINE_PATCH )
736 Vector3 imageSize = RelayoutHelper::GetNaturalSize( backgroundImageActor );
740 size.width = std::max( size.width, imageSize.width );
745 size.height = std::max( size.height, imageSize.height );
749 // If label, test against it's size
750 Toolkit::TextView textView = Toolkit::TextView::DownCast( mLabel );
753 Vector3 textViewSize = textView.GetNaturalSize();
757 size.width = std::max( size.width, textViewSize.width + TEXT_PADDING * 2.0f );
762 size.height = std::max( size.height, textViewSize.height + TEXT_PADDING * 2.0f );
770 void PushButton::DoClickAction(const PropertyValueContainer& attributes)
772 // Prevents the button signals from doing a recursive loop by sending an action
773 // and re-emitting the signals.
774 if(!mClickActionPerforming)
776 mClickActionPerforming = true;
780 mClickActionPerforming = false;
784 bool PushButton::DoAction(BaseObject* object, const std::string& actionName, const std::vector<Property::Value>& attributes)
788 Dali::BaseHandle handle(object);
790 Toolkit::PushButton button = Toolkit::PushButton::DownCast(handle);
792 DALI_ASSERT_ALWAYS(button);
794 if(Toolkit::PushButton::ACTION_PUSH_BUTTON_CLICK == actionName)
796 GetImplementation(button).DoClickAction(attributes);
803 } // namespace Internal
805 } // namespace Toolkit