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 "button-impl.h"
22 #include <cstring> // for strcmp
23 #include <dali/public-api/events/touch-data.h>
24 #include <dali/public-api/images/resource-image.h>
25 #include <dali/public-api/object/type-registry.h>
26 #include <dali/public-api/object/type-registry-helper.h>
27 #include <dali/devel-api/scripting/scripting.h>
30 #include <dali-toolkit/public-api/controls/text-controls/text-label.h>
31 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
34 * Button states and contents
35 * (3) mSelectedContent
36 * (2) mUnselectedContent (2) mSelectedBackgroundContent
37 * (1) mBackgroundContent (1) mBackgroundContent
38 * < unselected > ----------------------- < selected >
40 * | OnDisabled() | OnDisabled()
42 * < disabled > < disabled-selected >
43 * (2) mDisabledContent (2) mDisabledSelectedContent
44 * (1) mDisabledBackgroundContent (1) mDisabledBackgroundContent
46 * The drawing order of child actors is as follows.
49 * | mUnselectedContent / mSelectedContent / mDisabledContent / mDisabledSelectedContent
50 * | mSelectedBackgroundContent
51 * Bottom mBackgroundContent / mDisabledBackgroundContent
53 * Some of contents may be missed.
54 * And 2 images - fade-in image and fade-out image - in the same layer can be shown during the transition animation. Fade-in image should be above fade-out image.
71 // empty handle as we cannot create button (but type registered for clicked signal)
75 // Setup properties, signals and actions using the type-registry.
76 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::Button, Toolkit::Control, Create );
78 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "disabled", BOOLEAN, DISABLED )
79 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "autoRepeating", BOOLEAN, AUTO_REPEATING )
80 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "initialAutoRepeatingDelay", FLOAT, INITIAL_AUTO_REPEATING_DELAY )
81 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "nextAutoRepeatingDelay", FLOAT, NEXT_AUTO_REPEATING_DELAY )
82 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "togglable", BOOLEAN, TOGGLABLE )
83 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "selected", BOOLEAN, SELECTED )
84 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "unselectedStateImage", STRING, UNSELECTED_STATE_IMAGE )
85 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "selectedStateImage", STRING, SELECTED_STATE_IMAGE )
86 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "disabledStateImage", STRING, DISABLED_STATE_IMAGE )
87 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "unselectedColor", VECTOR4, UNSELECTED_COLOR )
88 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "selectedColor", VECTOR4, SELECTED_COLOR )
89 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "label", MAP, LABEL )
91 // Deprecated properties:
92 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "labelText", STRING, LABEL_TEXT )
95 DALI_SIGNAL_REGISTRATION( Toolkit, Button, "pressed", SIGNAL_PRESSED )
96 DALI_SIGNAL_REGISTRATION( Toolkit, Button, "released", SIGNAL_RELEASED )
97 DALI_SIGNAL_REGISTRATION( Toolkit, Button, "clicked", SIGNAL_CLICKED )
98 DALI_SIGNAL_REGISTRATION( Toolkit, Button, "stateChanged", SIGNAL_STATE_CHANGED )
101 DALI_ACTION_REGISTRATION( Toolkit, Button, "buttonClick", ACTION_BUTTON_CLICK )
103 DALI_TYPE_REGISTRATION_END()
105 const unsigned int INITIAL_AUTOREPEATING_DELAY( 0.15f );
106 const unsigned int NEXT_AUTOREPEATING_DELAY( 0.05f );
108 } // unnamed namespace
111 : Control( ControlBehaviour( REQUIRES_STYLE_CHANGE_SIGNALS ) ),
112 mAutoRepeatingTimer(),
113 mUnselectedColor( Color::WHITE ), // The natural colors of the specified images will be used by default.
114 mSelectedColor( Color::WHITE ),
116 mAutoRepeating( false ),
117 mTogglableButton( false ),
119 mInitialAutoRepeatingDelay( INITIAL_AUTOREPEATING_DELAY ),
120 mNextAutoRepeatingDelay( NEXT_AUTOREPEATING_DELAY ),
121 mAnimationTime( 0.0f ),
122 mClickActionPerforming( false ),
124 mPaintState( UnselectedState )
132 void Button::SetDisabled( bool disabled )
134 if( disabled == mDisabled )
139 StopTransitionAnimation();
141 mDisabled = disabled;
143 // Notifies the derived class the button has been disabled.
146 switch( mPaintState )
148 case UnselectedState:
151 //(3) mDisabledContent (Inserted)
152 //(4) mUnselectedContent
153 //(2) mDisabledBackgroundContent (Inserted)
154 //(1) mBackgroundContent
156 AddButtonImage( mBackgroundContent );
157 TransitionButtonImage( mDisabledBackgroundContent );
158 AddButtonImage( mUnselectedContent );
159 TransitionButtonImage( mDisabledContent );
161 AddButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
164 TransitionOut( mDecoration[ SELECTED_DECORATION ] );
165 TransitionOut( mUnselectedContent );
166 TransitionOut( mSelectedContent );
167 TransitionOut( mBackgroundContent );
168 TransitionOut( mSelectedBackgroundContent );
169 TransitionOut( mDisabledSelectedContent );
171 mPaintState = DisabledUnselectedState;
177 //(5) mDisabledSelectedContent (Inserted)
178 //(4) mSelectedContent
179 //(3) mDisabledBackgroundContent (Inserted)
180 //(2) mSelectedBackgroundContent
181 //(1) mBackgroundContent
183 AddButtonImage( mBackgroundContent );
184 AddButtonImage( mSelectedBackgroundContent );
185 TransitionButtonImage( mDisabledBackgroundContent );
186 AddButtonImage( mSelectedContent );
187 TransitionButtonImage( mDisabledSelectedContent );
189 AddButtonImage( mDecoration[ SELECTED_DECORATION ] );
192 TransitionOut( mDecoration[ UNSELECTED_DECORATION ] );
193 TransitionOut( mUnselectedContent );
194 TransitionOut( mSelectedContent );
195 TransitionOut( mBackgroundContent );
196 TransitionOut( mSelectedBackgroundContent );
197 TransitionOut( mDisabledContent );
199 mPaintState = DisabledSelectedState;
202 case DisabledUnselectedState:
205 //(3) mUnselectedContent (Inserted)
206 //(4) mDisabledContent
207 //(2) mBackgroundContent (Inserted)
208 //(1) mDisabledBackgroundContent
210 AddButtonImage( mDisabledBackgroundContent );
211 TransitionButtonImage( mBackgroundContent );
212 AddButtonImage( mDisabledContent );
213 TransitionButtonImage( mUnselectedContent );
215 AddButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
218 TransitionOut( mDecoration[ SELECTED_DECORATION ] );
219 TransitionOut( mSelectedContent );
220 TransitionOut( mSelectedBackgroundContent );
221 TransitionOut( mDisabledContent );
222 TransitionOut( mDisabledSelectedContent );
223 TransitionOut( mDisabledBackgroundContent );
225 mPaintState = UnselectedState;
228 case DisabledSelectedState:
231 //(4) mSelectedContent (Inserted)
232 //(5) mDisabledSelectedContent
233 //(3) mSelectedBackgroundContent (Inserted)
234 //(2) mBackgroundContent (Inserted)
235 //(1) mDisabledBackgroundContent
237 AddButtonImage( mDisabledBackgroundContent );
238 TransitionButtonImage( mBackgroundContent );
239 TransitionButtonImage( mSelectedBackgroundContent );
240 AddButtonImage( mDisabledSelectedContent );
241 TransitionButtonImage( mSelectedContent );
243 AddButtonImage( mDecoration[ SELECTED_DECORATION ] );
246 TransitionOut( mDecoration[ UNSELECTED_DECORATION ] );
247 TransitionOut( mUnselectedContent );
248 TransitionOut( mDisabledContent );
249 TransitionOut( mDisabledSelectedContent );
250 TransitionOut( mDisabledBackgroundContent );
252 mPaintState = SelectedState;
257 StartTransitionAnimation();
260 bool Button::IsDisabled() const
265 void Button::SetAutoRepeating( bool autoRepeating )
267 mAutoRepeating = autoRepeating;
269 // An autorepeating button can't be a togglable button.
272 mTogglableButton = false;
276 // Emit a signal is not wanted, only change the appearance.
277 SetSelected( false, false );
282 bool Button::IsAutoRepeating() const
284 return mAutoRepeating;
287 void Button::SetInitialAutoRepeatingDelay( float initialAutoRepeatingDelay )
289 DALI_ASSERT_ALWAYS( initialAutoRepeatingDelay > 0.f );
290 mInitialAutoRepeatingDelay = initialAutoRepeatingDelay;
293 float Button::GetInitialAutoRepeatingDelay() const
295 return mInitialAutoRepeatingDelay;
298 void Button::SetNextAutoRepeatingDelay( float nextAutoRepeatingDelay )
300 DALI_ASSERT_ALWAYS( nextAutoRepeatingDelay > 0.f );
301 mNextAutoRepeatingDelay = nextAutoRepeatingDelay;
304 float Button::GetNextAutoRepeatingDelay() const
306 return mNextAutoRepeatingDelay;
309 void Button::SetTogglableButton( bool togglable )
311 mTogglableButton = togglable;
313 // A togglable button can't be an autorepeating button.
316 mAutoRepeating = false;
320 bool Button::IsTogglableButton() const
322 return mTogglableButton;
325 void Button::SetSelected( bool selected )
327 if( !mDisabled && mTogglableButton && ( selected != mSelected ) )
329 SetSelected( selected, true );
333 void Button::SetSelected( bool selected, bool emitSignal )
335 StopTransitionAnimation();
337 mSelected = selected;
339 // Notifies the derived class the button has been selected.
342 switch( mPaintState )
344 case UnselectedState:
347 //(3) mSelectedContent (Inserted)
348 //(4) mUnselectedContent
349 //(2) mSelectedBackgroundContent (Inserted)
350 //(1) mBackgroundContent
352 AddButtonImage( mBackgroundContent );
353 TransitionButtonImage( mSelectedBackgroundContent );
354 AddButtonImage( mUnselectedContent );
355 TransitionButtonImage( mSelectedContent );
357 AddButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
358 TransitionButtonImage( mDecoration[ SELECTED_DECORATION ] );
361 TransitionOut( mDecoration[ UNSELECTED_DECORATION ] );
362 TransitionOut( mUnselectedContent );
363 TransitionOut( mDisabledContent );
364 TransitionOut( mDisabledSelectedContent );
365 TransitionOut( mDisabledBackgroundContent );
367 mPaintState = SelectedState;
373 //(3) mUnselectedContent (Inserted)
374 //(2) mSelectedContent
375 //(1) mBackgroundContent
377 AddButtonImage( mBackgroundContent );
378 AddButtonImage( mSelectedContent );
379 TransitionButtonImage( mUnselectedContent );
381 AddButtonImage( mDecoration[ SELECTED_DECORATION ] );
382 TransitionButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
385 TransitionOut( mDecoration[ SELECTED_DECORATION ] );
386 TransitionOut( mSelectedContent );
387 TransitionOut( mSelectedBackgroundContent );
388 TransitionOut( mDisabledContent );
389 TransitionOut( mDisabledSelectedContent );
390 TransitionOut( mDisabledBackgroundContent );
392 mPaintState = UnselectedState;
395 case DisabledUnselectedState:
396 case DisabledSelectedState:
398 DALI_ASSERT_DEBUG( 0 && "Shouldn't be able to change paint state if the button is disabled." );
403 StartTransitionAnimation();
407 Toolkit::Button handle( GetOwner() );
410 mStateChangedSignal.Emit( handle );
416 bool Button::IsSelected() const
418 return mTogglableButton && mSelected;
421 void Button::SetAnimationTime( float animationTime )
423 mAnimationTime = animationTime;
426 float Button::GetAnimationTime() const
428 return mAnimationTime;
431 void Button::SetLabelText( const std::string& label )
433 Property::Map labelProperty;
434 labelProperty.Insert( "text", label );
435 ModifyLabel( labelProperty );
438 std::string Button::GetLabelText() const
440 Toolkit::TextLabel label = Dali::Toolkit::TextLabel::DownCast( mLabel );
443 return label.GetProperty<std::string>( Dali::Toolkit::TextLabel::Property::TEXT );
445 return std::string();
448 void Button::ModifyLabel( const Property::Map& properties )
450 // If we don't have a label yet, create one.
453 // If we don't have a label, create one and set it up.
454 // Note: The label text is set from the passed in property map after creation.
455 mLabel = Toolkit::TextLabel::New();
456 mLabel.SetPosition( 0.0f, 0.0f );
457 // label should be the top of the button
458 Self().Add( mLabel );
461 // Set any properties specified for the label by iterating through all property key-value pairs.
462 for( unsigned int i = 0, mapCount = properties.Count(); i < mapCount; ++i )
464 const StringValuePair& propertyPair( properties.GetPair( i ) );
466 // Convert the property string to a property index.
467 Property::Index setPropertyIndex = mLabel.GetPropertyIndex( propertyPair.first );
468 if( setPropertyIndex != Property::INVALID_INDEX )
470 // If the conversion worked, we have a valid property index,
471 // Set the property to the new value.
472 mLabel.SetProperty( setPropertyIndex, propertyPair.second );
476 // Notify derived button classes of the change.
482 Actor& Button::GetLabelActor()
487 void Button::SetDecoration( DecorationState state, Actor actor )
489 if( mDecoration[ state ] && mDecoration[ state ].GetParent() )
491 mDecoration[ state ].Unparent();
494 mDecoration[ state ] = actor;
495 mDecoration[ state ].SetColorMode( USE_OWN_COLOR );
501 Actor& Button::GetDecoration( DecorationState state )
503 return mDecoration[ state ];
506 void Button::SetupContent( Actor& actorToModify, Actor newActor )
510 StopTransitionAnimation();
512 if( actorToModify && actorToModify.GetParent() )
514 actorToModify.Unparent();
517 actorToModify = newActor;
521 actorToModify.SetAnchorPoint( AnchorPoint::TOP_LEFT );
522 actorToModify.SetParentOrigin( ParentOrigin::TOP_LEFT );
523 actorToModify.SetPosition( 0.f, 0.f );
530 void Button::SetUnselectedColor( const Vector4& color )
532 mUnselectedColor = color;
534 if( mUnselectedContent && !GetUnselectedImageFilename().empty() )
536 // If there is existing unselected content, change the color on it directly.
537 mUnselectedContent.SetColor( mUnselectedColor );
541 // If there is no existing content, create a new actor to use for flat color.
542 Toolkit::Control unselectedContentActor = Toolkit::Control::New();
543 unselectedContentActor.SetBackgroundColor( mUnselectedColor );
544 SetupContent( mUnselectedContent, unselectedContentActor );
545 mUnselectedContent.SetResizePolicy( ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS );
549 const Vector4 Button::GetUnselectedColor() const
551 return mUnselectedColor;
554 void Button::SetSelectedColor( const Vector4& color )
556 mSelectedColor = color;
558 if( mSelectedContent && !GetSelectedImageFilename().empty() )
560 // If there is existing unselected content, change the color on it directly.
561 mSelectedContent.SetColor( mSelectedColor );
565 // If there is no existing content, create a new actor to use for flat color.
566 Toolkit::Control selectedContentActor = Toolkit::Control::New();
567 selectedContentActor.SetBackgroundColor( mSelectedColor );
568 SetupContent( mSelectedContent, selectedContentActor );
569 mSelectedContent.SetResizePolicy( ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS );
573 const Vector4 Button::GetSelectedColor() const
575 return mSelectedColor;
578 void Button::SetUnselectedImage( const std::string& filename )
580 Toolkit::ImageView newContent;
581 if( !filename.empty() )
583 newContent = Toolkit::ImageView::New( filename );
587 newContent = Toolkit::ImageView::New();
592 SetupContent( mUnselectedContent, newContent );
594 mUnselectedContent.SetColor( mUnselectedColor );
596 OnUnselectedImageSet();
601 Actor& Button::GetUnselectedImage()
603 return mUnselectedContent;
606 void Button::SetSelectedImage( const std::string& filename )
608 Toolkit::ImageView newContent;
609 if( !filename.empty() )
611 newContent = Toolkit::ImageView::New( filename );
615 newContent = Toolkit::ImageView::New();
620 SetupContent( mSelectedContent, newContent );
622 mSelectedContent.SetColor( mSelectedColor );
624 OnSelectedImageSet();
629 Actor& Button::GetSelectedImage()
631 return mSelectedContent;
634 void Button::SetBackgroundImage( const std::string& filename )
636 SetupContent( mBackgroundContent, Toolkit::ImageView::New( filename ) );
638 OnBackgroundImageSet();
642 Actor& Button::GetBackgroundImage()
644 return mBackgroundContent;
647 void Button::SetSelectedBackgroundImage( const std::string& filename )
649 SetupContent( mSelectedBackgroundContent, Toolkit::ImageView::New( filename ) );
651 OnSelectedBackgroundImageSet();
655 Actor& Button::GetSelectedBackgroundImage()
657 return mSelectedBackgroundContent;
660 void Button::SetDisabledImage( const std::string& filename )
662 SetupContent( mDisabledContent, Toolkit::ImageView::New( filename ) );
664 OnDisabledImageSet();
668 Actor& Button::GetDisabledImage()
670 return mDisabledContent;
673 void Button::SetDisabledSelectedImage( const std::string& filename )
675 SetupContent( mDisabledSelectedContent, Toolkit::ImageView::New( filename ) );
677 OnDisabledSelectedImageSet();
681 Actor& Button::GetDisabledSelectedImage()
683 return mDisabledSelectedContent;
686 void Button::SetDisabledBackgroundImage( const std::string& filename )
688 SetupContent( mDisabledBackgroundContent, Toolkit::ImageView::New( filename ) );
690 OnDisabledBackgroundImageSet();
694 Actor& Button::GetDisabledBackgroundImage()
696 return mDisabledBackgroundContent;
699 std::string Button::GetUnselectedImageFilename() const
701 if( mUnselectedContent )
703 ResourceImage image = ResourceImage::DownCast( mUnselectedContent );
706 return image.GetUrl();
709 return std::string();
712 std::string Button::GetSelectedImageFilename() const
714 if( mSelectedContent )
716 ResourceImage image = ResourceImage::DownCast( mSelectedContent );
719 return image.GetUrl();
722 return std::string();
725 std::string Button::GetBackgroundImageFilename() const
727 if( mBackgroundContent )
729 ResourceImage image = ResourceImage::DownCast( mBackgroundContent );
732 return image.GetUrl();
735 return std::string();
738 std::string Button::GetSelectedBackgroundImageFilename() const
740 if( mSelectedBackgroundContent )
742 ResourceImage image = ResourceImage::DownCast( mSelectedBackgroundContent );
745 return image.GetUrl();
748 return std::string();
751 std::string Button::GetDisabledImageFilename() const
753 if( mDisabledContent )
755 ResourceImage image = ResourceImage::DownCast( mDisabledContent );
758 return image.GetUrl();
761 return std::string();
764 std::string Button::GetDisabledSelectedImageFilename() const
766 if( mDisabledSelectedContent )
768 ResourceImage image = ResourceImage::DownCast( mDisabledSelectedContent );
771 return image.GetUrl();
774 return std::string();
777 std::string Button::GetDisabledBackgroundImageFilename() const
779 if( mDisabledBackgroundContent )
781 ResourceImage image = ResourceImage::DownCast( mDisabledBackgroundContent );
784 return image.GetUrl();
787 return std::string();
790 bool Button::DoAction( BaseObject* object, const std::string& actionName, const Property::Map& attributes )
794 Dali::BaseHandle handle( object );
796 Toolkit::Button button = Toolkit::Button::DownCast( handle );
798 DALI_ASSERT_ALWAYS( button );
800 if( 0 == strcmp( actionName.c_str(), ACTION_BUTTON_CLICK ) )
802 ret = GetImplementation( button ).DoClickAction( attributes );
808 bool Button::DoClickAction( const Property::Map& attributes )
810 // Prevents the button signals from doing a recursive loop by sending an action
811 // and re-emitting the signals.
812 if( !mClickActionPerforming )
814 mClickActionPerforming = true;
818 mClickActionPerforming = false;
826 void Button::OnButtonDown()
828 if( !mTogglableButton )
834 SetUpTimer( mInitialAutoRepeatingDelay );
838 // The pressed signal should be emitted regardless of toggle mode.
839 Toolkit::Button handle( GetOwner() );
840 mPressedSignal.Emit( handle );
843 void Button::OnButtonUp()
845 if( ButtonDown == mState )
847 if( mTogglableButton )
849 SetSelected( !mSelected );
857 mAutoRepeatingTimer.Reset();
861 // The clicked and released signals should be emitted regardless of toggle mode.
862 Toolkit::Button handle( GetOwner() );
863 mReleasedSignal.Emit( handle );
864 mClickedSignal.Emit( handle );
868 void Button::OnTouchPointLeave()
870 if( ButtonDown == mState )
872 if( !mTogglableButton )
878 mAutoRepeatingTimer.Reset();
882 // The released signal should be emitted regardless of toggle mode.
883 Toolkit::Button handle( GetOwner() );
884 mReleasedSignal.Emit( handle );
888 void Button::OnTouchPointInterrupted()
893 Toolkit::Button::ButtonSignalType& Button::PressedSignal()
895 return mPressedSignal;
898 Toolkit::Button::ButtonSignalType& Button::ReleasedSignal()
900 return mReleasedSignal;
903 Toolkit::Button::ButtonSignalType& Button::ClickedSignal()
905 return mClickedSignal;
908 Toolkit::Button::ButtonSignalType& Button::StateChangedSignal()
910 return mStateChangedSignal;
913 bool Button::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
915 Dali::BaseHandle handle( object );
917 bool connected( true );
918 Toolkit::Button button = Toolkit::Button::DownCast( handle );
920 if( 0 == strcmp( signalName.c_str(), SIGNAL_PRESSED ) )
922 button.PressedSignal().Connect( tracker, functor );
924 else if( 0 == strcmp( signalName.c_str(), SIGNAL_RELEASED ) )
926 button.ReleasedSignal().Connect( tracker, functor );
928 else if( 0 == strcmp( signalName.c_str(), SIGNAL_CLICKED ) )
930 button.ClickedSignal().Connect( tracker, functor );
932 else if( 0 == strcmp( signalName.c_str(), SIGNAL_STATE_CHANGED ) )
934 button.StateChangedSignal().Connect( tracker, functor );
938 // signalName does not match any signal
945 void Button::OnInitialize()
949 mTapDetector = TapGestureDetector::New();
950 mTapDetector.Attach( self );
951 mTapDetector.DetectedSignal().Connect(this, &Button::OnTap);
953 self.SetKeyboardFocusable( true );
955 self.TouchSignal().Connect( this, &Button::OnTouch );
958 bool Button::OnAccessibilityActivated()
960 return OnKeyboardEnter();
963 bool Button::OnKeyboardEnter()
965 // When the enter key is pressed, or button is activated, the click action is performed.
966 Property::Map attributes;
967 bool ret = DoClickAction( attributes );
972 void Button::OnStageDisconnection()
974 if( ButtonDown == mState )
976 if( !mTogglableButton )
982 mAutoRepeatingTimer.Reset();
989 Control::OnStageDisconnection();
992 bool Button::OnTouch( Actor actor, const TouchData& touch )
994 // Only events are processed when the button is not disabled and the touch event has only
996 if( ( !mDisabled ) && ( 1 == touch.GetPointCount() ) )
998 switch( touch.GetState( 0 ) )
1000 case PointState::DOWN:
1002 OnButtonDown(); // Notification for derived classes.
1004 // Sets the button state to ButtonDown.
1005 mState = ButtonDown;
1008 case PointState::UP:
1010 OnButtonUp(); // Notification for derived classes.
1012 // Sets the button state to ButtonUp.
1016 case PointState::INTERRUPTED:
1018 OnTouchPointInterrupted(); // Notification for derived classes.
1020 // Sets the button state to the default (ButtonUp).
1024 case PointState::LEAVE:
1026 OnTouchPointLeave(); // Notification for derived classes.
1028 // Sets the button state to the default (ButtonUp).
1032 case PointState::MOTION:
1033 case PointState::STATIONARY: // FALLTHROUGH
1040 else if( 1 < touch.GetPointCount() )
1042 OnTouchPointLeave(); // Notification for derived classes.
1044 // Sets the button state to the default (ButtonUp).
1051 void Button::OnTap(Actor actor, const TapGesture& tap)
1056 void Button::SetUpTimer( float delay )
1058 mAutoRepeatingTimer = Dali::Timer::New( static_cast<unsigned int>( 1000.f * delay ) );
1059 mAutoRepeatingTimer.TickSignal().Connect( this, &Button::AutoRepeatingSlot );
1060 mAutoRepeatingTimer.Start();
1063 bool Button::AutoRepeatingSlot()
1065 bool consumed = false;
1068 // Restart the autorepeat timer.
1069 SetUpTimer( mNextAutoRepeatingDelay );
1073 Toolkit::Button handle( GetOwner() );
1076 consumed = mReleasedSignal.Emit( handle );
1077 consumed |= mClickedSignal.Emit( handle );
1078 consumed |= mPressedSignal.Emit( handle );
1084 void Button::Pressed()
1086 if( mPaintState == UnselectedState )
1088 StopTransitionAnimation();
1090 // Notifies the derived class the button has been pressed.
1094 //(4) mSelectedContent (Inserted)
1095 //(3) mUnselectedContent
1096 //(2) mSelectedBackgroundContent (Inserted)
1097 //(1) mBackgroundContent
1099 AddButtonImage( mBackgroundContent );
1100 TransitionButtonImage( mSelectedBackgroundContent );
1101 AddButtonImage( mUnselectedContent );
1102 TransitionButtonImage( mSelectedContent );
1104 AddButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1105 TransitionButtonImage( mDecoration[ SELECTED_DECORATION ] );
1108 TransitionOut( mDecoration[ UNSELECTED_DECORATION ] );
1109 TransitionOut( mUnselectedContent );
1110 TransitionOut( mDisabledContent );
1111 TransitionOut( mDisabledSelectedContent );
1112 TransitionOut( mDisabledBackgroundContent );
1114 mPaintState = SelectedState;
1116 StartTransitionAnimation();
1120 void Button::Released()
1122 if( mPaintState == SelectedState )
1124 StopTransitionAnimation();
1126 // Notifies the derived class the button has been released.
1130 //(3) mUnselectedContent (Inserted)
1131 //(2) mSelectedContent
1132 //(1) mBackgroundContent
1134 AddButtonImage( mBackgroundContent );
1135 AddButtonImage( mSelectedContent );
1136 TransitionButtonImage( mUnselectedContent );
1138 AddButtonImage( mDecoration[ SELECTED_DECORATION ] );
1139 TransitionButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1142 TransitionOut( mDecoration[ SELECTED_DECORATION ] );
1143 TransitionOut( mSelectedContent );
1144 TransitionOut( mSelectedBackgroundContent );
1145 TransitionOut( mDisabledContent );
1146 TransitionOut( mDisabledSelectedContent );
1147 TransitionOut( mDisabledBackgroundContent );
1149 mPaintState = UnselectedState;
1151 StartTransitionAnimation();
1155 Button::ButtonState Button::GetState()
1160 Button::PaintState Button::GetPaintState()
1165 void Button::PrepareAddButtonImage( Actor& actor )
1169 Self().Add( actor );
1170 PrepareForTranstionOut( actor );
1174 void Button::TransitionButtonImage( Actor& actor )
1178 if( !actor.GetParent() )
1180 Self().Add( actor );
1183 OnTransitionIn( actor );
1187 void Button::AddButtonImage( Actor& actor )
1191 Self().Add( actor );
1195 void Button::ReAddLabel()
1200 Self().Add( mLabel );
1204 void Button::RemoveButtonImage( Actor& actor )
1208 if( actor.GetParent() )
1210 Self().Remove( actor );
1212 PrepareForTranstionIn( actor );
1216 unsigned int Button::FindChildIndex( Actor& actor )
1218 Actor self = Self();
1219 unsigned int childrenNum = self.GetChildCount();
1221 for( unsigned int i = 0; i < childrenNum; i++ )
1223 Actor child = self.GetChildAt( i );
1224 if( child == actor )
1233 void Button::TransitionOut( Actor actor )
1235 OnTransitionOut( actor );
1238 void Button::ResetImageLayers()
1240 // Ensure that all layers are in the correct order and state according to the paint state
1242 switch( mPaintState )
1244 case UnselectedState:
1247 //(2) mUnselectedContent
1248 //(1) mBackgroundContent
1250 RemoveButtonImage( mDecoration[ SELECTED_DECORATION ] );
1251 RemoveButtonImage( mSelectedContent );
1252 RemoveButtonImage( mSelectedBackgroundContent );
1253 RemoveButtonImage( mDisabledContent );
1254 RemoveButtonImage( mDisabledSelectedContent );
1255 RemoveButtonImage( mDisabledBackgroundContent );
1257 PrepareAddButtonImage( mBackgroundContent );
1258 PrepareAddButtonImage( mUnselectedContent );
1260 PrepareAddButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1267 //(3) mSelectedContent
1268 //(2) mSelectedBackgroundContent
1269 //(1) mBackgroundContent
1271 RemoveButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1272 RemoveButtonImage( mUnselectedContent );
1273 RemoveButtonImage( mDisabledContent );
1274 RemoveButtonImage( mDisabledSelectedContent );
1275 RemoveButtonImage( mDisabledBackgroundContent );
1277 PrepareAddButtonImage( mBackgroundContent );
1278 PrepareAddButtonImage( mSelectedBackgroundContent );
1279 PrepareAddButtonImage( mSelectedContent );
1281 PrepareAddButtonImage( mDecoration[ SELECTED_DECORATION ] );
1285 case DisabledUnselectedState:
1288 //(2) mDisabledContent
1289 //(1) mDisabledBackgroundContent
1291 RemoveButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1292 RemoveButtonImage( mUnselectedContent );
1293 RemoveButtonImage( mBackgroundContent );
1294 RemoveButtonImage( mDecoration[ SELECTED_DECORATION ] );
1295 RemoveButtonImage( mSelectedContent );
1296 RemoveButtonImage( mDisabledSelectedContent );
1297 RemoveButtonImage( mSelectedBackgroundContent );
1299 PrepareAddButtonImage( mDisabledBackgroundContent ? mDisabledBackgroundContent : mBackgroundContent );
1300 PrepareAddButtonImage( mDisabledContent ? mDisabledContent : mUnselectedContent );
1302 PrepareAddButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1306 case DisabledSelectedState:
1309 // (2) mDisabledSelectedContent
1310 // (1) mDisabledBackgroundContent
1312 RemoveButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1313 RemoveButtonImage( mUnselectedContent );
1314 RemoveButtonImage( mDecoration[ SELECTED_DECORATION ] );
1315 RemoveButtonImage( mSelectedContent );
1316 RemoveButtonImage( mBackgroundContent );
1317 RemoveButtonImage( mSelectedBackgroundContent );
1318 RemoveButtonImage( mDisabledContent );
1320 if( mDisabledBackgroundContent )
1322 PrepareAddButtonImage( mDisabledBackgroundContent );
1326 PrepareAddButtonImage( mBackgroundContent );
1327 PrepareAddButtonImage( mSelectedBackgroundContent );
1330 PrepareAddButtonImage( mDisabledSelectedContent ? mDisabledSelectedContent : mSelectedContent );
1332 PrepareAddButtonImage( mDecoration[ SELECTED_DECORATION ] );
1339 void Button::StartTransitionAnimation()
1341 if( mTransitionAnimation )
1343 mTransitionAnimation.Play();
1351 void Button::StopTransitionAnimation()
1353 if( mTransitionAnimation )
1355 mTransitionAnimation.Clear();
1356 mTransitionAnimation.Reset();
1360 Dali::Animation Button::GetTransitionAnimation()
1362 if( !mTransitionAnimation )
1364 mTransitionAnimation = Dali::Animation::New( GetAnimationTime() );
1365 mTransitionAnimation.FinishedSignal().Connect( this, &Button::TransitionAnimationFinished );
1368 return mTransitionAnimation;
1371 void Button::TransitionAnimationFinished( Dali::Animation& source )
1373 StopTransitionAnimation();
1377 void Button::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
1379 Toolkit::Button button = Toolkit::Button::DownCast( Dali::BaseHandle( object ) );
1385 case Toolkit::Button::Property::DISABLED:
1387 GetImplementation( button ).SetDisabled( value.Get< bool >() );
1391 case Toolkit::Button::Property::AUTO_REPEATING:
1393 GetImplementation( button ).SetAutoRepeating( value.Get< bool >() );
1397 case Toolkit::Button::Property::INITIAL_AUTO_REPEATING_DELAY:
1399 GetImplementation( button ).SetInitialAutoRepeatingDelay( value.Get< float >() );
1403 case Toolkit::Button::Property::NEXT_AUTO_REPEATING_DELAY:
1405 GetImplementation( button ).SetNextAutoRepeatingDelay( value.Get< float >() );
1409 case Toolkit::Button::Property::TOGGLABLE:
1411 GetImplementation( button ).SetTogglableButton( value.Get< bool >() );
1415 case Toolkit::Button::Property::SELECTED:
1417 GetImplementation( button ).SetSelected( value.Get< bool >() );
1421 case Toolkit::Button::Property::UNSELECTED_STATE_IMAGE:
1423 GetImplementation( button ).SetUnselectedImage( value.Get< std::string >() );
1427 case Toolkit::Button::Property::SELECTED_STATE_IMAGE:
1429 GetImplementation( button ).SetSelectedImage( value.Get< std::string >() );
1433 case Toolkit::Button::Property::DISABLED_STATE_IMAGE:
1435 GetImplementation( button ).SetDisabledImage( value.Get< std::string >() );
1439 case Toolkit::Button::Property::UNSELECTED_COLOR:
1441 GetImplementation( button ).SetUnselectedColor( value.Get< Vector4 >() );
1445 case Toolkit::Button::Property::SELECTED_COLOR:
1447 GetImplementation( button ).SetSelectedColor( value.Get< Vector4 >() );
1451 case Toolkit::Button::Property::LABEL_TEXT:
1453 GetImplementation( button ).SetLabelText( value.Get< std::string >() );
1457 case Toolkit::Button::Property::LABEL:
1459 // Get a Property::Map from the property if possible.
1460 Property::Map setPropertyMap;
1461 if( value.Get( setPropertyMap ) )
1463 GetImplementation( button ).ModifyLabel( setPropertyMap );
1471 Property::Value Button::GetProperty( BaseObject* object, Property::Index propertyIndex )
1473 Property::Value value;
1475 Toolkit::Button button = Toolkit::Button::DownCast( Dali::BaseHandle( object ) );
1479 switch ( propertyIndex )
1481 case Toolkit::Button::Property::DISABLED:
1483 value = GetImplementation( button ).mDisabled;
1487 case Toolkit::Button::Property::AUTO_REPEATING:
1489 value = GetImplementation( button ).mAutoRepeating;
1493 case Toolkit::Button::Property::INITIAL_AUTO_REPEATING_DELAY:
1495 value = GetImplementation( button ).mInitialAutoRepeatingDelay;
1499 case Toolkit::Button::Property::NEXT_AUTO_REPEATING_DELAY:
1501 value = GetImplementation( button ).mNextAutoRepeatingDelay;
1505 case Toolkit::Button::Property::TOGGLABLE:
1507 value = GetImplementation( button ).mTogglableButton;
1511 case Toolkit::Button::Property::SELECTED:
1513 value = GetImplementation( button ).mSelected;
1517 case Toolkit::Button::Property::UNSELECTED_STATE_IMAGE:
1519 value = GetImplementation( button ).GetUnselectedImageFilename();
1523 case Toolkit::Button::Property::SELECTED_STATE_IMAGE:
1525 value = GetImplementation( button ).GetSelectedImageFilename();
1529 case Toolkit::Button::Property::DISABLED_STATE_IMAGE:
1531 value = GetImplementation( button ).GetDisabledImageFilename();
1535 case Toolkit::Button::Property::UNSELECTED_COLOR:
1537 value = GetImplementation( button ).GetUnselectedColor();
1541 case Toolkit::Button::Property::SELECTED_COLOR:
1543 value = GetImplementation( button ).GetSelectedColor();
1547 case Toolkit::Button::Property::LABEL_TEXT:
1549 value = GetImplementation( button ).GetLabelText();
1553 case Toolkit::Button::Property::LABEL:
1555 Property::Map emptyMap;
1567 void Button::SetLabel( Actor label )
1569 if( mLabel != label )
1571 if( mLabel && mLabel.GetParent() )
1573 mLabel.GetParent().Remove( mLabel );
1577 mLabel.SetPosition( 0.0f, 0.0f );
1579 // label should be the top of the button
1580 Self().Add( mLabel );
1589 void Button::SetButtonImage( Actor image )
1593 StopTransitionAnimation();
1595 SetupContent( mUnselectedContent, image );
1597 OnUnselectedImageSet();
1602 void Button::SetSelectedImage( Actor image )
1606 StopTransitionAnimation();
1608 SetupContent( mSelectedContent, image );
1610 OnSelectedImageSet();
1615 void Button::SetBackgroundImage( Actor image )
1619 StopTransitionAnimation();
1621 SetupContent( mBackgroundContent, image );
1623 OnBackgroundImageSet();
1628 void Button::SetSelectedBackgroundImage( Actor image )
1632 StopTransitionAnimation();
1634 SetupContent( mSelectedBackgroundContent, image );
1636 OnSelectedBackgroundImageSet();
1641 void Button::SetDisabledImage( Actor image )
1645 StopTransitionAnimation();
1647 SetupContent( mDisabledContent, image );
1649 OnDisabledImageSet();
1654 void Button::SetDisabledSelectedImage( Actor image )
1658 StopTransitionAnimation();
1660 SetupContent( mDisabledSelectedContent, image );
1662 OnDisabledSelectedImageSet();
1667 void Button::SetDisabledBackgroundImage( Actor image )
1671 StopTransitionAnimation();
1673 SetupContent( mDisabledBackgroundContent, image );
1675 OnDisabledBackgroundImageSet();
1680 Actor Button::GetButtonImage() const
1682 return mUnselectedContent;
1685 Actor Button::GetSelectedImage() const
1687 return mSelectedContent;
1691 } // namespace Internal
1693 } // namespace Toolkit