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>
32 #include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
35 * Button states and contents
36 * (3) mSelectedContent
37 * (2) mUnselectedContent (2) mSelectedBackgroundContent
38 * (1) mBackgroundContent (1) mBackgroundContent
39 * < unselected > ----------------------- < selected >
41 * | OnDisabled() | OnDisabled()
43 * < disabled > < disabled-selected >
44 * (2) mDisabledContent (2) mDisabledSelectedContent
45 * (1) mDisabledBackgroundContent (1) mDisabledBackgroundContent
47 * The drawing order of child actors is as follows.
50 * | mUnselectedContent / mSelectedContent / mDisabledContent / mDisabledSelectedContent
51 * | mSelectedBackgroundContent
52 * Bottom mBackgroundContent / mDisabledBackgroundContent
54 * Some of contents may be missed.
55 * 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.
72 // empty handle as we cannot create button (but type registered for clicked signal)
76 // Setup properties, signals and actions using the type-registry.
77 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::Button, Toolkit::Control, Create );
79 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "disabled", BOOLEAN, DISABLED )
80 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "autoRepeating", BOOLEAN, AUTO_REPEATING )
81 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "initialAutoRepeatingDelay", FLOAT, INITIAL_AUTO_REPEATING_DELAY )
82 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "nextAutoRepeatingDelay", FLOAT, NEXT_AUTO_REPEATING_DELAY )
83 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "togglable", BOOLEAN, TOGGLABLE )
84 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "selected", BOOLEAN, SELECTED )
85 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "unselectedStateImage", STRING, UNSELECTED_STATE_IMAGE )
86 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "selectedStateImage", STRING, SELECTED_STATE_IMAGE )
87 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "disabledStateImage", STRING, DISABLED_STATE_IMAGE )
88 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "unselectedColor", VECTOR4, UNSELECTED_COLOR )
89 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "selectedColor", VECTOR4, SELECTED_COLOR )
90 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "label", MAP, LABEL )
92 // Deprecated properties:
93 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "labelText", STRING, LABEL_TEXT )
96 DALI_SIGNAL_REGISTRATION( Toolkit, Button, "pressed", SIGNAL_PRESSED )
97 DALI_SIGNAL_REGISTRATION( Toolkit, Button, "released", SIGNAL_RELEASED )
98 DALI_SIGNAL_REGISTRATION( Toolkit, Button, "clicked", SIGNAL_CLICKED )
99 DALI_SIGNAL_REGISTRATION( Toolkit, Button, "stateChanged", SIGNAL_STATE_CHANGED )
102 DALI_ACTION_REGISTRATION( Toolkit, Button, "buttonClick", ACTION_BUTTON_CLICK )
104 DALI_TYPE_REGISTRATION_END()
106 const unsigned int INITIAL_AUTOREPEATING_DELAY( 0.15f );
107 const unsigned int NEXT_AUTOREPEATING_DELAY( 0.05f );
109 } // unnamed namespace
112 : Control( ControlBehaviour( REQUIRES_STYLE_CHANGE_SIGNALS ) ),
113 mAutoRepeatingTimer(),
114 mUnselectedColor( Color::WHITE ), // The natural colors of the specified images will be used by default.
115 mSelectedColor( Color::WHITE ),
117 mAutoRepeating( false ),
118 mTogglableButton( false ),
120 mInitialAutoRepeatingDelay( INITIAL_AUTOREPEATING_DELAY ),
121 mNextAutoRepeatingDelay( NEXT_AUTOREPEATING_DELAY ),
122 mAnimationTime( 0.0f ),
123 mClickActionPerforming( false ),
125 mPaintState( UnselectedState )
133 void Button::SetDisabled( bool disabled )
135 if( disabled == mDisabled )
140 StopTransitionAnimation();
142 mDisabled = disabled;
144 // Notifies the derived class the button has been disabled.
147 switch( mPaintState )
149 case UnselectedState:
152 //(3) mDisabledContent (Inserted)
153 //(4) mUnselectedContent
154 //(2) mDisabledBackgroundContent (Inserted)
155 //(1) mBackgroundContent
157 AddButtonImage( mBackgroundContent );
158 TransitionButtonImage( mDisabledBackgroundContent );
159 AddButtonImage( mUnselectedContent );
160 TransitionButtonImage( mDisabledContent );
162 AddButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
165 TransitionOut( mDecoration[ SELECTED_DECORATION ] );
166 TransitionOut( mUnselectedContent );
167 TransitionOut( mSelectedContent );
168 TransitionOut( mBackgroundContent );
169 TransitionOut( mSelectedBackgroundContent );
170 TransitionOut( mDisabledSelectedContent );
172 mPaintState = DisabledUnselectedState;
178 //(5) mDisabledSelectedContent (Inserted)
179 //(4) mSelectedContent
180 //(3) mDisabledBackgroundContent (Inserted)
181 //(2) mSelectedBackgroundContent
182 //(1) mBackgroundContent
184 AddButtonImage( mBackgroundContent );
185 AddButtonImage( mSelectedBackgroundContent );
186 TransitionButtonImage( mDisabledBackgroundContent );
187 AddButtonImage( mSelectedContent );
188 TransitionButtonImage( mDisabledSelectedContent );
190 AddButtonImage( mDecoration[ SELECTED_DECORATION ] );
193 TransitionOut( mDecoration[ UNSELECTED_DECORATION ] );
194 TransitionOut( mUnselectedContent );
195 TransitionOut( mSelectedContent );
196 TransitionOut( mBackgroundContent );
197 TransitionOut( mSelectedBackgroundContent );
198 TransitionOut( mDisabledContent );
200 mPaintState = DisabledSelectedState;
203 case DisabledUnselectedState:
206 //(3) mUnselectedContent (Inserted)
207 //(4) mDisabledContent
208 //(2) mBackgroundContent (Inserted)
209 //(1) mDisabledBackgroundContent
211 AddButtonImage( mDisabledBackgroundContent );
212 TransitionButtonImage( mBackgroundContent );
213 AddButtonImage( mDisabledContent );
214 TransitionButtonImage( mUnselectedContent );
216 AddButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
219 TransitionOut( mDecoration[ SELECTED_DECORATION ] );
220 TransitionOut( mSelectedContent );
221 TransitionOut( mSelectedBackgroundContent );
222 TransitionOut( mDisabledContent );
223 TransitionOut( mDisabledSelectedContent );
224 TransitionOut( mDisabledBackgroundContent );
226 mPaintState = UnselectedState;
229 case DisabledSelectedState:
232 //(4) mSelectedContent (Inserted)
233 //(5) mDisabledSelectedContent
234 //(3) mSelectedBackgroundContent (Inserted)
235 //(2) mBackgroundContent (Inserted)
236 //(1) mDisabledBackgroundContent
238 AddButtonImage( mDisabledBackgroundContent );
239 TransitionButtonImage( mBackgroundContent );
240 TransitionButtonImage( mSelectedBackgroundContent );
241 AddButtonImage( mDisabledSelectedContent );
242 TransitionButtonImage( mSelectedContent );
244 AddButtonImage( mDecoration[ SELECTED_DECORATION ] );
247 TransitionOut( mDecoration[ UNSELECTED_DECORATION ] );
248 TransitionOut( mUnselectedContent );
249 TransitionOut( mDisabledContent );
250 TransitionOut( mDisabledSelectedContent );
251 TransitionOut( mDisabledBackgroundContent );
253 mPaintState = SelectedState;
258 StartTransitionAnimation();
261 bool Button::IsDisabled() const
266 void Button::SetAutoRepeating( bool autoRepeating )
268 mAutoRepeating = autoRepeating;
270 // An autorepeating button can't be a togglable button.
273 mTogglableButton = false;
277 // Emit a signal is not wanted, only change the appearance.
278 SetSelected( false, false );
283 bool Button::IsAutoRepeating() const
285 return mAutoRepeating;
288 void Button::SetInitialAutoRepeatingDelay( float initialAutoRepeatingDelay )
290 DALI_ASSERT_ALWAYS( initialAutoRepeatingDelay > 0.f );
291 mInitialAutoRepeatingDelay = initialAutoRepeatingDelay;
294 float Button::GetInitialAutoRepeatingDelay() const
296 return mInitialAutoRepeatingDelay;
299 void Button::SetNextAutoRepeatingDelay( float nextAutoRepeatingDelay )
301 DALI_ASSERT_ALWAYS( nextAutoRepeatingDelay > 0.f );
302 mNextAutoRepeatingDelay = nextAutoRepeatingDelay;
305 float Button::GetNextAutoRepeatingDelay() const
307 return mNextAutoRepeatingDelay;
310 void Button::SetTogglableButton( bool togglable )
312 mTogglableButton = togglable;
314 // A togglable button can't be an autorepeating button.
317 mAutoRepeating = false;
321 bool Button::IsTogglableButton() const
323 return mTogglableButton;
326 void Button::SetSelected( bool selected )
328 if( !mDisabled && mTogglableButton && ( selected != mSelected ) )
330 SetSelected( selected, true );
334 void Button::SetSelected( bool selected, bool emitSignal )
336 StopTransitionAnimation();
338 mSelected = selected;
340 // Notifies the derived class the button has been selected.
343 switch( mPaintState )
345 case UnselectedState:
348 //(3) mSelectedContent (Inserted)
349 //(4) mUnselectedContent
350 //(2) mSelectedBackgroundContent (Inserted)
351 //(1) mBackgroundContent
353 AddButtonImage( mBackgroundContent );
354 TransitionButtonImage( mSelectedBackgroundContent );
355 AddButtonImage( mUnselectedContent );
356 TransitionButtonImage( mSelectedContent );
358 AddButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
359 TransitionButtonImage( mDecoration[ SELECTED_DECORATION ] );
362 TransitionOut( mDecoration[ UNSELECTED_DECORATION ] );
363 TransitionOut( mUnselectedContent );
364 TransitionOut( mDisabledContent );
365 TransitionOut( mDisabledSelectedContent );
366 TransitionOut( mDisabledBackgroundContent );
368 mPaintState = SelectedState;
374 //(3) mUnselectedContent (Inserted)
375 //(2) mSelectedContent
376 //(1) mBackgroundContent
378 AddButtonImage( mBackgroundContent );
379 AddButtonImage( mSelectedContent );
380 TransitionButtonImage( mUnselectedContent );
382 AddButtonImage( mDecoration[ SELECTED_DECORATION ] );
383 TransitionButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
386 TransitionOut( mDecoration[ SELECTED_DECORATION ] );
387 TransitionOut( mSelectedContent );
388 TransitionOut( mSelectedBackgroundContent );
389 TransitionOut( mDisabledContent );
390 TransitionOut( mDisabledSelectedContent );
391 TransitionOut( mDisabledBackgroundContent );
393 mPaintState = UnselectedState;
396 case DisabledUnselectedState:
397 case DisabledSelectedState:
399 DALI_ASSERT_DEBUG( 0 && "Shouldn't be able to change paint state if the button is disabled." );
404 StartTransitionAnimation();
408 Toolkit::Button handle( GetOwner() );
411 mStateChangedSignal.Emit( handle );
417 bool Button::IsSelected() const
419 return mTogglableButton && mSelected;
422 void Button::SetAnimationTime( float animationTime )
424 mAnimationTime = animationTime;
427 float Button::GetAnimationTime() const
429 return mAnimationTime;
432 void Button::SetLabelText( const std::string& label )
434 Property::Map labelProperty;
435 labelProperty.Insert( "text", label );
436 ModifyLabel( labelProperty );
439 std::string Button::GetLabelText() const
441 Toolkit::TextLabel label = Dali::Toolkit::TextLabel::DownCast( mLabel );
444 return label.GetProperty<std::string>( Dali::Toolkit::TextLabel::Property::TEXT );
446 return std::string();
449 void Button::ModifyLabel( const Property::Map& properties )
451 // If we don't have a label yet, create one.
454 // If we don't have a label, create one and set it up.
455 // Note: The label text is set from the passed in property map after creation.
456 mLabel = Toolkit::TextLabel::New();
457 mLabel.SetPosition( 0.0f, 0.0f );
458 // label should be the top of the button
459 Self().Add( mLabel );
462 // Set any properties specified for the label by iterating through all property key-value pairs.
463 for( unsigned int i = 0, mapCount = properties.Count(); i < mapCount; ++i )
465 const StringValuePair& propertyPair( properties.GetPair( i ) );
467 // Convert the property string to a property index.
468 Property::Index setPropertyIndex = mLabel.GetPropertyIndex( propertyPair.first );
469 if( setPropertyIndex != Property::INVALID_INDEX )
471 // If the conversion worked, we have a valid property index,
472 // Set the property to the new value.
473 mLabel.SetProperty( setPropertyIndex, propertyPair.second );
477 // Notify derived button classes of the change.
483 Actor& Button::GetLabelActor()
488 void Button::SetDecoration( DecorationState state, Actor actor )
490 if( mDecoration[ state ] && mDecoration[ state ].GetParent() )
492 mDecoration[ state ].Unparent();
495 mDecoration[ state ] = actor;
496 mDecoration[ state ].SetColorMode( USE_OWN_COLOR );
502 Actor& Button::GetDecoration( DecorationState state )
504 return mDecoration[ state ];
507 void Button::SetupContent( Actor& actorToModify, Actor newActor )
511 StopTransitionAnimation();
513 if( actorToModify && actorToModify.GetParent() )
515 actorToModify.Unparent();
518 actorToModify = newActor;
522 actorToModify.SetAnchorPoint( AnchorPoint::TOP_LEFT );
523 actorToModify.SetParentOrigin( ParentOrigin::TOP_LEFT );
524 actorToModify.SetPosition( 0.f, 0.f );
531 const Vector4 Button::GetUnselectedColor() const
533 return mUnselectedColor;
536 void Button::SetColor( const Vector4& color, Button::PaintState selectedState )
538 Actor* contentActor = NULL; // Using a pointer as SetupContent assigns the new Actor to this.
539 bool imageFileExists = false;
541 if ( selectedState == SelectedState || selectedState == DisabledSelectedState )
543 mSelectedColor = color;
544 contentActor = &mSelectedContent;
545 imageFileExists = !GetSelectedImageFilename().empty();
549 mUnselectedColor = color;
550 contentActor = &mUnselectedContent;
551 imageFileExists = !GetUnselectedImageFilename().empty();
556 if( imageFileExists )
558 // If there is existing unselected content, change the color on it directly.
559 contentActor->SetColor( color );
563 // If there is no existing content, create a new actor to use for flat color.
564 Actor placementActor = Actor::New();
565 Toolkit::VisualFactory rendererFactory = Toolkit::VisualFactory::Get();
566 Toolkit::Visual colorRenderer;
569 map["rendererType"] = "COLOR";
570 map["mixColor"] = color;
572 colorRenderer = rendererFactory.CreateVisual( map );
573 colorRenderer.SetOnStage( placementActor );
575 SetupContent( *contentActor, placementActor ); //
576 contentActor->SetResizePolicy( ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS );
581 const Vector4 Button::GetSelectedColor() const
583 return mSelectedColor;
586 void Button::SetUnselectedImage( const std::string& filename )
588 Toolkit::ImageView newContent;
589 if( !filename.empty() )
591 newContent = Toolkit::ImageView::New( filename );
595 newContent = Toolkit::ImageView::New();
600 SetupContent( mUnselectedContent, newContent );
602 mUnselectedContent.SetColor( mUnselectedColor );
604 OnUnselectedImageSet();
609 Actor& Button::GetUnselectedImage()
611 return mUnselectedContent;
614 void Button::SetSelectedImage( const std::string& filename )
616 Toolkit::ImageView newContent;
617 if( !filename.empty() )
619 newContent = Toolkit::ImageView::New( filename );
623 newContent = Toolkit::ImageView::New();
628 SetupContent( mSelectedContent, newContent );
630 mSelectedContent.SetColor( mSelectedColor );
632 OnSelectedImageSet();
637 Actor& Button::GetSelectedImage()
639 return mSelectedContent;
642 void Button::SetBackgroundImage( const std::string& filename )
644 SetupContent( mBackgroundContent, Toolkit::ImageView::New( filename ) );
646 OnBackgroundImageSet();
650 Actor& Button::GetBackgroundImage()
652 return mBackgroundContent;
655 void Button::SetSelectedBackgroundImage( const std::string& filename )
657 SetupContent( mSelectedBackgroundContent, Toolkit::ImageView::New( filename ) );
659 OnSelectedBackgroundImageSet();
663 Actor& Button::GetSelectedBackgroundImage()
665 return mSelectedBackgroundContent;
668 void Button::SetDisabledImage( const std::string& filename )
670 SetupContent( mDisabledContent, Toolkit::ImageView::New( filename ) );
672 OnDisabledImageSet();
676 Actor& Button::GetDisabledImage()
678 return mDisabledContent;
681 void Button::SetDisabledSelectedImage( const std::string& filename )
683 SetupContent( mDisabledSelectedContent, Toolkit::ImageView::New( filename ) );
685 OnDisabledSelectedImageSet();
689 Actor& Button::GetDisabledSelectedImage()
691 return mDisabledSelectedContent;
694 void Button::SetDisabledBackgroundImage( const std::string& filename )
696 SetupContent( mDisabledBackgroundContent, Toolkit::ImageView::New( filename ) );
698 OnDisabledBackgroundImageSet();
702 Actor& Button::GetDisabledBackgroundImage()
704 return mDisabledBackgroundContent;
707 std::string Button::GetUnselectedImageFilename() const
709 if( mUnselectedContent )
711 ResourceImage image = ResourceImage::DownCast( mUnselectedContent );
714 return image.GetUrl();
717 return std::string();
720 std::string Button::GetSelectedImageFilename() const
722 if( mSelectedContent )
724 ResourceImage image = ResourceImage::DownCast( mSelectedContent );
727 return image.GetUrl();
730 return std::string();
733 std::string Button::GetDisabledImageFilename() const
735 if( mDisabledContent )
737 ResourceImage image = ResourceImage::DownCast( mDisabledContent );
740 return image.GetUrl();
743 return std::string();
746 bool Button::DoAction( BaseObject* object, const std::string& actionName, const Property::Map& attributes )
750 Dali::BaseHandle handle( object );
752 Toolkit::Button button = Toolkit::Button::DownCast( handle );
754 DALI_ASSERT_ALWAYS( button );
756 if( 0 == strcmp( actionName.c_str(), ACTION_BUTTON_CLICK ) )
758 ret = GetImplementation( button ).DoClickAction( attributes );
764 bool Button::DoClickAction( const Property::Map& attributes )
766 // Prevents the button signals from doing a recursive loop by sending an action
767 // and re-emitting the signals.
768 if( !mClickActionPerforming )
770 mClickActionPerforming = true;
774 mClickActionPerforming = false;
782 void Button::OnButtonDown()
784 if( !mTogglableButton )
790 SetUpTimer( mInitialAutoRepeatingDelay );
794 // The pressed signal should be emitted regardless of toggle mode.
795 Toolkit::Button handle( GetOwner() );
796 mPressedSignal.Emit( handle );
799 void Button::OnButtonUp()
801 if( ButtonDown == mState )
803 if( mTogglableButton )
805 SetSelected( !mSelected );
813 mAutoRepeatingTimer.Reset();
817 // The clicked and released signals should be emitted regardless of toggle mode.
818 Toolkit::Button handle( GetOwner() );
819 mReleasedSignal.Emit( handle );
820 mClickedSignal.Emit( handle );
824 void Button::OnTouchPointLeave()
826 if( ButtonDown == mState )
828 if( !mTogglableButton )
834 mAutoRepeatingTimer.Reset();
838 // The released signal should be emitted regardless of toggle mode.
839 Toolkit::Button handle( GetOwner() );
840 mReleasedSignal.Emit( handle );
844 void Button::OnTouchPointInterrupted()
849 Toolkit::Button::ButtonSignalType& Button::PressedSignal()
851 return mPressedSignal;
854 Toolkit::Button::ButtonSignalType& Button::ReleasedSignal()
856 return mReleasedSignal;
859 Toolkit::Button::ButtonSignalType& Button::ClickedSignal()
861 return mClickedSignal;
864 Toolkit::Button::ButtonSignalType& Button::StateChangedSignal()
866 return mStateChangedSignal;
869 bool Button::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
871 Dali::BaseHandle handle( object );
873 bool connected( true );
874 Toolkit::Button button = Toolkit::Button::DownCast( handle );
876 if( 0 == strcmp( signalName.c_str(), SIGNAL_PRESSED ) )
878 button.PressedSignal().Connect( tracker, functor );
880 else if( 0 == strcmp( signalName.c_str(), SIGNAL_RELEASED ) )
882 button.ReleasedSignal().Connect( tracker, functor );
884 else if( 0 == strcmp( signalName.c_str(), SIGNAL_CLICKED ) )
886 button.ClickedSignal().Connect( tracker, functor );
888 else if( 0 == strcmp( signalName.c_str(), SIGNAL_STATE_CHANGED ) )
890 button.StateChangedSignal().Connect( tracker, functor );
894 // signalName does not match any signal
901 void Button::OnInitialize()
905 mTapDetector = TapGestureDetector::New();
906 mTapDetector.Attach( self );
907 mTapDetector.DetectedSignal().Connect(this, &Button::OnTap);
909 self.SetKeyboardFocusable( true );
911 self.TouchSignal().Connect( this, &Button::OnTouch );
914 bool Button::OnAccessibilityActivated()
916 return OnKeyboardEnter();
919 bool Button::OnKeyboardEnter()
921 // When the enter key is pressed, or button is activated, the click action is performed.
922 Property::Map attributes;
923 bool ret = DoClickAction( attributes );
928 void Button::OnStageDisconnection()
930 if( ButtonDown == mState )
932 if( !mTogglableButton )
938 mAutoRepeatingTimer.Reset();
945 Control::OnStageDisconnection();
948 bool Button::OnTouch( Actor actor, const TouchData& touch )
950 // Only events are processed when the button is not disabled and the touch event has only
952 if( ( !mDisabled ) && ( 1 == touch.GetPointCount() ) )
954 switch( touch.GetState( 0 ) )
956 case PointState::DOWN:
958 OnButtonDown(); // Notification for derived classes.
960 // Sets the button state to ButtonDown.
966 OnButtonUp(); // Notification for derived classes.
968 // Sets the button state to ButtonUp.
972 case PointState::INTERRUPTED:
974 OnTouchPointInterrupted(); // Notification for derived classes.
976 // Sets the button state to the default (ButtonUp).
980 case PointState::LEAVE:
982 OnTouchPointLeave(); // Notification for derived classes.
984 // Sets the button state to the default (ButtonUp).
988 case PointState::MOTION:
989 case PointState::STATIONARY: // FALLTHROUGH
996 else if( 1 < touch.GetPointCount() )
998 OnTouchPointLeave(); // Notification for derived classes.
1000 // Sets the button state to the default (ButtonUp).
1007 void Button::OnTap(Actor actor, const TapGesture& tap)
1012 void Button::SetUpTimer( float delay )
1014 mAutoRepeatingTimer = Dali::Timer::New( static_cast<unsigned int>( 1000.f * delay ) );
1015 mAutoRepeatingTimer.TickSignal().Connect( this, &Button::AutoRepeatingSlot );
1016 mAutoRepeatingTimer.Start();
1019 bool Button::AutoRepeatingSlot()
1021 bool consumed = false;
1024 // Restart the autorepeat timer.
1025 SetUpTimer( mNextAutoRepeatingDelay );
1029 Toolkit::Button handle( GetOwner() );
1032 consumed = mReleasedSignal.Emit( handle );
1033 consumed |= mClickedSignal.Emit( handle );
1034 consumed |= mPressedSignal.Emit( handle );
1040 void Button::Pressed()
1042 if( mPaintState == UnselectedState )
1044 StopTransitionAnimation();
1046 // Notifies the derived class the button has been pressed.
1050 //(4) mSelectedContent (Inserted)
1051 //(3) mUnselectedContent
1052 //(2) mSelectedBackgroundContent (Inserted)
1053 //(1) mBackgroundContent
1055 AddButtonImage( mBackgroundContent );
1056 TransitionButtonImage( mSelectedBackgroundContent );
1057 AddButtonImage( mUnselectedContent );
1058 TransitionButtonImage( mSelectedContent );
1060 AddButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1061 TransitionButtonImage( mDecoration[ SELECTED_DECORATION ] );
1064 TransitionOut( mDecoration[ UNSELECTED_DECORATION ] );
1065 TransitionOut( mUnselectedContent );
1066 TransitionOut( mDisabledContent );
1067 TransitionOut( mDisabledSelectedContent );
1068 TransitionOut( mDisabledBackgroundContent );
1070 mPaintState = SelectedState;
1072 StartTransitionAnimation();
1076 void Button::Released()
1078 if( mPaintState == SelectedState )
1080 StopTransitionAnimation();
1082 // Notifies the derived class the button has been released.
1086 //(3) mUnselectedContent (Inserted)
1087 //(2) mSelectedContent
1088 //(1) mBackgroundContent
1090 AddButtonImage( mBackgroundContent );
1091 AddButtonImage( mSelectedContent );
1092 TransitionButtonImage( mUnselectedContent );
1094 AddButtonImage( mDecoration[ SELECTED_DECORATION ] );
1095 TransitionButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1098 TransitionOut( mDecoration[ SELECTED_DECORATION ] );
1099 TransitionOut( mSelectedContent );
1100 TransitionOut( mSelectedBackgroundContent );
1101 TransitionOut( mDisabledContent );
1102 TransitionOut( mDisabledSelectedContent );
1103 TransitionOut( mDisabledBackgroundContent );
1105 mPaintState = UnselectedState;
1107 StartTransitionAnimation();
1111 Button::ButtonState Button::GetState()
1116 Button::PaintState Button::GetPaintState()
1121 void Button::PrepareAddButtonImage( Actor& actor )
1125 Self().Add( actor );
1126 PrepareForTranstionOut( actor );
1130 void Button::TransitionButtonImage( Actor& actor )
1134 if( !actor.GetParent() )
1136 Self().Add( actor );
1139 OnTransitionIn( actor );
1143 void Button::AddButtonImage( Actor& actor )
1147 Self().Add( actor );
1151 void Button::ReAddLabel()
1156 Self().Add( mLabel );
1160 void Button::RemoveButtonImage( Actor& actor )
1164 if( actor.GetParent() )
1166 Self().Remove( actor );
1168 PrepareForTranstionIn( actor );
1172 unsigned int Button::FindChildIndex( Actor& actor )
1174 Actor self = Self();
1175 unsigned int childrenNum = self.GetChildCount();
1177 for( unsigned int i = 0; i < childrenNum; i++ )
1179 Actor child = self.GetChildAt( i );
1180 if( child == actor )
1189 void Button::TransitionOut( Actor actor )
1191 OnTransitionOut( actor );
1194 void Button::ResetImageLayers()
1196 // Ensure that all layers are in the correct order and state according to the paint state
1198 switch( mPaintState )
1200 case UnselectedState:
1203 //(2) mUnselectedContent
1204 //(1) mBackgroundContent
1206 RemoveButtonImage( mDecoration[ SELECTED_DECORATION ] );
1207 RemoveButtonImage( mSelectedContent );
1208 RemoveButtonImage( mSelectedBackgroundContent );
1209 RemoveButtonImage( mDisabledContent );
1210 RemoveButtonImage( mDisabledSelectedContent );
1211 RemoveButtonImage( mDisabledBackgroundContent );
1213 PrepareAddButtonImage( mBackgroundContent );
1214 PrepareAddButtonImage( mUnselectedContent );
1216 PrepareAddButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1223 //(3) mSelectedContent
1224 //(2) mSelectedBackgroundContent
1225 //(1) mBackgroundContent
1227 RemoveButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1228 RemoveButtonImage( mUnselectedContent );
1229 RemoveButtonImage( mDisabledContent );
1230 RemoveButtonImage( mDisabledSelectedContent );
1231 RemoveButtonImage( mDisabledBackgroundContent );
1233 PrepareAddButtonImage( mBackgroundContent );
1234 PrepareAddButtonImage( mSelectedBackgroundContent );
1235 PrepareAddButtonImage( mSelectedContent );
1237 PrepareAddButtonImage( mDecoration[ SELECTED_DECORATION ] );
1241 case DisabledUnselectedState:
1244 //(2) mDisabledContent
1245 //(1) mDisabledBackgroundContent
1247 RemoveButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1248 RemoveButtonImage( mUnselectedContent );
1249 RemoveButtonImage( mBackgroundContent );
1250 RemoveButtonImage( mDecoration[ SELECTED_DECORATION ] );
1251 RemoveButtonImage( mSelectedContent );
1252 RemoveButtonImage( mDisabledSelectedContent );
1253 RemoveButtonImage( mSelectedBackgroundContent );
1255 PrepareAddButtonImage( mDisabledBackgroundContent ? mDisabledBackgroundContent : mBackgroundContent );
1256 PrepareAddButtonImage( mDisabledContent ? mDisabledContent : mUnselectedContent );
1258 PrepareAddButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1262 case DisabledSelectedState:
1265 // (2) mDisabledSelectedContent
1266 // (1) mDisabledBackgroundContent
1268 RemoveButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1269 RemoveButtonImage( mUnselectedContent );
1270 RemoveButtonImage( mDecoration[ SELECTED_DECORATION ] );
1271 RemoveButtonImage( mSelectedContent );
1272 RemoveButtonImage( mBackgroundContent );
1273 RemoveButtonImage( mSelectedBackgroundContent );
1274 RemoveButtonImage( mDisabledContent );
1276 if( mDisabledBackgroundContent )
1278 PrepareAddButtonImage( mDisabledBackgroundContent );
1282 PrepareAddButtonImage( mBackgroundContent );
1283 PrepareAddButtonImage( mSelectedBackgroundContent );
1286 PrepareAddButtonImage( mDisabledSelectedContent ? mDisabledSelectedContent : mSelectedContent );
1288 PrepareAddButtonImage( mDecoration[ SELECTED_DECORATION ] );
1295 void Button::StartTransitionAnimation()
1297 if( mTransitionAnimation )
1299 mTransitionAnimation.Play();
1307 void Button::StopTransitionAnimation()
1309 if( mTransitionAnimation )
1311 mTransitionAnimation.Clear();
1312 mTransitionAnimation.Reset();
1316 Dali::Animation Button::GetTransitionAnimation()
1318 if( !mTransitionAnimation )
1320 mTransitionAnimation = Dali::Animation::New( GetAnimationTime() );
1321 mTransitionAnimation.FinishedSignal().Connect( this, &Button::TransitionAnimationFinished );
1324 return mTransitionAnimation;
1327 void Button::TransitionAnimationFinished( Dali::Animation& source )
1329 StopTransitionAnimation();
1333 void Button::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
1335 Toolkit::Button button = Toolkit::Button::DownCast( Dali::BaseHandle( object ) );
1341 case Toolkit::Button::Property::DISABLED:
1343 GetImplementation( button ).SetDisabled( value.Get< bool >() );
1347 case Toolkit::Button::Property::AUTO_REPEATING:
1349 GetImplementation( button ).SetAutoRepeating( value.Get< bool >() );
1353 case Toolkit::Button::Property::INITIAL_AUTO_REPEATING_DELAY:
1355 GetImplementation( button ).SetInitialAutoRepeatingDelay( value.Get< float >() );
1359 case Toolkit::Button::Property::NEXT_AUTO_REPEATING_DELAY:
1361 GetImplementation( button ).SetNextAutoRepeatingDelay( value.Get< float >() );
1365 case Toolkit::Button::Property::TOGGLABLE:
1367 GetImplementation( button ).SetTogglableButton( value.Get< bool >() );
1371 case Toolkit::Button::Property::SELECTED:
1373 GetImplementation( button ).SetSelected( value.Get< bool >() );
1377 case Toolkit::Button::Property::UNSELECTED_STATE_IMAGE:
1379 GetImplementation( button ).SetUnselectedImage( value.Get< std::string >() );
1383 case Toolkit::Button::Property::SELECTED_STATE_IMAGE:
1385 GetImplementation( button ).SetSelectedImage( value.Get< std::string >() );
1389 case Toolkit::Button::Property::DISABLED_STATE_IMAGE:
1391 GetImplementation( button ).SetDisabledImage( value.Get< std::string >() );
1395 case Toolkit::Button::Property::UNSELECTED_COLOR:
1397 GetImplementation( button ).SetColor( value.Get< Vector4 >(), UnselectedState );
1401 case Toolkit::Button::Property::SELECTED_COLOR:
1403 GetImplementation( button ).SetColor( value.Get< Vector4 >(), SelectedState );
1407 case Toolkit::Button::Property::LABEL_TEXT:
1409 GetImplementation( button ).SetLabelText( value.Get< std::string >() );
1413 case Toolkit::Button::Property::LABEL:
1415 // Get a Property::Map from the property if possible.
1416 Property::Map setPropertyMap;
1417 if( value.Get( setPropertyMap ) )
1419 GetImplementation( button ).ModifyLabel( setPropertyMap );
1427 Property::Value Button::GetProperty( BaseObject* object, Property::Index propertyIndex )
1429 Property::Value value;
1431 Toolkit::Button button = Toolkit::Button::DownCast( Dali::BaseHandle( object ) );
1435 switch ( propertyIndex )
1437 case Toolkit::Button::Property::DISABLED:
1439 value = GetImplementation( button ).mDisabled;
1443 case Toolkit::Button::Property::AUTO_REPEATING:
1445 value = GetImplementation( button ).mAutoRepeating;
1449 case Toolkit::Button::Property::INITIAL_AUTO_REPEATING_DELAY:
1451 value = GetImplementation( button ).mInitialAutoRepeatingDelay;
1455 case Toolkit::Button::Property::NEXT_AUTO_REPEATING_DELAY:
1457 value = GetImplementation( button ).mNextAutoRepeatingDelay;
1461 case Toolkit::Button::Property::TOGGLABLE:
1463 value = GetImplementation( button ).mTogglableButton;
1467 case Toolkit::Button::Property::SELECTED:
1469 value = GetImplementation( button ).mSelected;
1473 case Toolkit::Button::Property::UNSELECTED_STATE_IMAGE:
1475 value = GetImplementation( button ).GetUnselectedImageFilename();
1479 case Toolkit::Button::Property::SELECTED_STATE_IMAGE:
1481 value = GetImplementation( button ).GetSelectedImageFilename();
1485 case Toolkit::Button::Property::DISABLED_STATE_IMAGE:
1487 value = GetImplementation( button ).GetDisabledImageFilename();
1491 case Toolkit::Button::Property::UNSELECTED_COLOR:
1493 value = GetImplementation( button ).GetUnselectedColor();
1497 case Toolkit::Button::Property::SELECTED_COLOR:
1499 value = GetImplementation( button ).GetSelectedColor();
1503 case Toolkit::Button::Property::LABEL_TEXT:
1505 value = GetImplementation( button ).GetLabelText();
1509 case Toolkit::Button::Property::LABEL:
1511 Property::Map emptyMap;
1523 void Button::SetLabel( Actor label )
1525 if( mLabel != label )
1527 if( mLabel && mLabel.GetParent() )
1529 mLabel.GetParent().Remove( mLabel );
1533 mLabel.SetPosition( 0.0f, 0.0f );
1535 // label should be the top of the button
1536 Self().Add( mLabel );
1545 void Button::SetButtonImage( Actor image )
1549 StopTransitionAnimation();
1551 SetupContent( mUnselectedContent, image );
1553 OnUnselectedImageSet();
1558 void Button::SetSelectedImage( Actor image )
1562 StopTransitionAnimation();
1564 SetupContent( mSelectedContent, image );
1566 OnSelectedImageSet();
1571 void Button::SetBackgroundImage( Actor image )
1575 StopTransitionAnimation();
1577 SetupContent( mBackgroundContent, image );
1579 OnBackgroundImageSet();
1584 void Button::SetSelectedBackgroundImage( Actor image )
1588 StopTransitionAnimation();
1590 SetupContent( mSelectedBackgroundContent, image );
1592 OnSelectedBackgroundImageSet();
1597 void Button::SetDisabledImage( Actor image )
1601 StopTransitionAnimation();
1603 SetupContent( mDisabledContent, image );
1605 OnDisabledImageSet();
1610 void Button::SetDisabledSelectedImage( Actor image )
1614 StopTransitionAnimation();
1616 SetupContent( mDisabledSelectedContent, image );
1618 OnDisabledSelectedImageSet();
1623 void Button::SetDisabledBackgroundImage( Actor image )
1627 StopTransitionAnimation();
1629 SetupContent( mDisabledBackgroundContent, image );
1631 OnDisabledBackgroundImageSet();
1636 Actor Button::GetButtonImage() const
1638 return mUnselectedContent;
1641 Actor Button::GetSelectedImage() const
1643 return mSelectedContent;
1647 } // namespace Internal
1649 } // namespace Toolkit