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/controls/renderer-factory/renderer-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 = mSelectedContent;
539 bool imageFileExists = false;
541 if ( selectedState == SelectedState || selectedState == DisabledSelectedState )
543 mSelectedColor = color;
544 imageFileExists = !GetSelectedImageFilename().empty();
548 mUnselectedColor = color;
549 contentActor = mUnselectedContent;
550 imageFileExists = !GetUnselectedImageFilename().empty();
553 if( contentActor && imageFileExists )
555 // If there is existing unselected content, change the color on it directly.
556 contentActor.SetColor( color );
560 // If there is no existing content, create a new actor to use for flat color.
561 Actor placementActor = Actor::New();
562 Toolkit::RendererFactory rendererFactory = Toolkit::RendererFactory::Get();
563 Toolkit::ControlRenderer colorRenderer;
566 map["rendererType"] = "color";
567 map["mixColor"] = color;
569 colorRenderer = rendererFactory.CreateControlRenderer( map );
570 colorRenderer.SetOnStage( placementActor );
571 SetupContent( contentActor, placementActor );
572 contentActor.SetResizePolicy( ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS );
576 const Vector4 Button::GetSelectedColor() const
578 return mSelectedColor;
581 void Button::SetUnselectedImage( const std::string& filename )
583 Toolkit::ImageView newContent;
584 if( !filename.empty() )
586 newContent = Toolkit::ImageView::New( filename );
590 newContent = Toolkit::ImageView::New();
595 SetupContent( mUnselectedContent, newContent );
597 mUnselectedContent.SetColor( mUnselectedColor );
599 OnUnselectedImageSet();
604 Actor& Button::GetUnselectedImage()
606 return mUnselectedContent;
609 void Button::SetSelectedImage( const std::string& filename )
611 Toolkit::ImageView newContent;
612 if( !filename.empty() )
614 newContent = Toolkit::ImageView::New( filename );
618 newContent = Toolkit::ImageView::New();
623 SetupContent( mSelectedContent, newContent );
625 mSelectedContent.SetColor( mSelectedColor );
627 OnSelectedImageSet();
632 Actor& Button::GetSelectedImage()
634 return mSelectedContent;
637 void Button::SetBackgroundImage( const std::string& filename )
639 SetupContent( mBackgroundContent, Toolkit::ImageView::New( filename ) );
641 OnBackgroundImageSet();
645 Actor& Button::GetBackgroundImage()
647 return mBackgroundContent;
650 void Button::SetSelectedBackgroundImage( const std::string& filename )
652 SetupContent( mSelectedBackgroundContent, Toolkit::ImageView::New( filename ) );
654 OnSelectedBackgroundImageSet();
658 Actor& Button::GetSelectedBackgroundImage()
660 return mSelectedBackgroundContent;
663 void Button::SetDisabledImage( const std::string& filename )
665 SetupContent( mDisabledContent, Toolkit::ImageView::New( filename ) );
667 OnDisabledImageSet();
671 Actor& Button::GetDisabledImage()
673 return mDisabledContent;
676 void Button::SetDisabledSelectedImage( const std::string& filename )
678 SetupContent( mDisabledSelectedContent, Toolkit::ImageView::New( filename ) );
680 OnDisabledSelectedImageSet();
684 Actor& Button::GetDisabledSelectedImage()
686 return mDisabledSelectedContent;
689 void Button::SetDisabledBackgroundImage( const std::string& filename )
691 SetupContent( mDisabledBackgroundContent, Toolkit::ImageView::New( filename ) );
693 OnDisabledBackgroundImageSet();
697 Actor& Button::GetDisabledBackgroundImage()
699 return mDisabledBackgroundContent;
702 std::string Button::GetUnselectedImageFilename() const
704 if( mUnselectedContent )
706 ResourceImage image = ResourceImage::DownCast( mUnselectedContent );
709 return image.GetUrl();
712 return std::string();
715 std::string Button::GetSelectedImageFilename() const
717 if( mSelectedContent )
719 ResourceImage image = ResourceImage::DownCast( mSelectedContent );
722 return image.GetUrl();
725 return std::string();
728 std::string Button::GetDisabledImageFilename() const
730 if( mDisabledContent )
732 ResourceImage image = ResourceImage::DownCast( mDisabledContent );
735 return image.GetUrl();
738 return std::string();
741 bool Button::DoAction( BaseObject* object, const std::string& actionName, const Property::Map& attributes )
745 Dali::BaseHandle handle( object );
747 Toolkit::Button button = Toolkit::Button::DownCast( handle );
749 DALI_ASSERT_ALWAYS( button );
751 if( 0 == strcmp( actionName.c_str(), ACTION_BUTTON_CLICK ) )
753 ret = GetImplementation( button ).DoClickAction( attributes );
759 bool Button::DoClickAction( const Property::Map& attributes )
761 // Prevents the button signals from doing a recursive loop by sending an action
762 // and re-emitting the signals.
763 if( !mClickActionPerforming )
765 mClickActionPerforming = true;
769 mClickActionPerforming = false;
777 void Button::OnButtonDown()
779 if( !mTogglableButton )
785 SetUpTimer( mInitialAutoRepeatingDelay );
789 // The pressed signal should be emitted regardless of toggle mode.
790 Toolkit::Button handle( GetOwner() );
791 mPressedSignal.Emit( handle );
794 void Button::OnButtonUp()
796 if( ButtonDown == mState )
798 if( mTogglableButton )
800 SetSelected( !mSelected );
808 mAutoRepeatingTimer.Reset();
812 // The clicked and released signals should be emitted regardless of toggle mode.
813 Toolkit::Button handle( GetOwner() );
814 mReleasedSignal.Emit( handle );
815 mClickedSignal.Emit( handle );
819 void Button::OnTouchPointLeave()
821 if( ButtonDown == mState )
823 if( !mTogglableButton )
829 mAutoRepeatingTimer.Reset();
833 // The released signal should be emitted regardless of toggle mode.
834 Toolkit::Button handle( GetOwner() );
835 mReleasedSignal.Emit( handle );
839 void Button::OnTouchPointInterrupted()
844 Toolkit::Button::ButtonSignalType& Button::PressedSignal()
846 return mPressedSignal;
849 Toolkit::Button::ButtonSignalType& Button::ReleasedSignal()
851 return mReleasedSignal;
854 Toolkit::Button::ButtonSignalType& Button::ClickedSignal()
856 return mClickedSignal;
859 Toolkit::Button::ButtonSignalType& Button::StateChangedSignal()
861 return mStateChangedSignal;
864 bool Button::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
866 Dali::BaseHandle handle( object );
868 bool connected( true );
869 Toolkit::Button button = Toolkit::Button::DownCast( handle );
871 if( 0 == strcmp( signalName.c_str(), SIGNAL_PRESSED ) )
873 button.PressedSignal().Connect( tracker, functor );
875 else if( 0 == strcmp( signalName.c_str(), SIGNAL_RELEASED ) )
877 button.ReleasedSignal().Connect( tracker, functor );
879 else if( 0 == strcmp( signalName.c_str(), SIGNAL_CLICKED ) )
881 button.ClickedSignal().Connect( tracker, functor );
883 else if( 0 == strcmp( signalName.c_str(), SIGNAL_STATE_CHANGED ) )
885 button.StateChangedSignal().Connect( tracker, functor );
889 // signalName does not match any signal
896 void Button::OnInitialize()
900 mTapDetector = TapGestureDetector::New();
901 mTapDetector.Attach( self );
902 mTapDetector.DetectedSignal().Connect(this, &Button::OnTap);
904 self.SetKeyboardFocusable( true );
906 self.TouchSignal().Connect( this, &Button::OnTouch );
909 bool Button::OnAccessibilityActivated()
911 return OnKeyboardEnter();
914 bool Button::OnKeyboardEnter()
916 // When the enter key is pressed, or button is activated, the click action is performed.
917 Property::Map attributes;
918 bool ret = DoClickAction( attributes );
923 void Button::OnStageDisconnection()
925 if( ButtonDown == mState )
927 if( !mTogglableButton )
933 mAutoRepeatingTimer.Reset();
940 Control::OnStageDisconnection();
943 bool Button::OnTouch( Actor actor, const TouchData& touch )
945 // Only events are processed when the button is not disabled and the touch event has only
947 if( ( !mDisabled ) && ( 1 == touch.GetPointCount() ) )
949 switch( touch.GetState( 0 ) )
951 case PointState::DOWN:
953 OnButtonDown(); // Notification for derived classes.
955 // Sets the button state to ButtonDown.
961 OnButtonUp(); // Notification for derived classes.
963 // Sets the button state to ButtonUp.
967 case PointState::INTERRUPTED:
969 OnTouchPointInterrupted(); // Notification for derived classes.
971 // Sets the button state to the default (ButtonUp).
975 case PointState::LEAVE:
977 OnTouchPointLeave(); // Notification for derived classes.
979 // Sets the button state to the default (ButtonUp).
983 case PointState::MOTION:
984 case PointState::STATIONARY: // FALLTHROUGH
991 else if( 1 < touch.GetPointCount() )
993 OnTouchPointLeave(); // Notification for derived classes.
995 // Sets the button state to the default (ButtonUp).
1002 void Button::OnTap(Actor actor, const TapGesture& tap)
1007 void Button::SetUpTimer( float delay )
1009 mAutoRepeatingTimer = Dali::Timer::New( static_cast<unsigned int>( 1000.f * delay ) );
1010 mAutoRepeatingTimer.TickSignal().Connect( this, &Button::AutoRepeatingSlot );
1011 mAutoRepeatingTimer.Start();
1014 bool Button::AutoRepeatingSlot()
1016 bool consumed = false;
1019 // Restart the autorepeat timer.
1020 SetUpTimer( mNextAutoRepeatingDelay );
1024 Toolkit::Button handle( GetOwner() );
1027 consumed = mReleasedSignal.Emit( handle );
1028 consumed |= mClickedSignal.Emit( handle );
1029 consumed |= mPressedSignal.Emit( handle );
1035 void Button::Pressed()
1037 if( mPaintState == UnselectedState )
1039 StopTransitionAnimation();
1041 // Notifies the derived class the button has been pressed.
1045 //(4) mSelectedContent (Inserted)
1046 //(3) mUnselectedContent
1047 //(2) mSelectedBackgroundContent (Inserted)
1048 //(1) mBackgroundContent
1050 AddButtonImage( mBackgroundContent );
1051 TransitionButtonImage( mSelectedBackgroundContent );
1052 AddButtonImage( mUnselectedContent );
1053 TransitionButtonImage( mSelectedContent );
1055 AddButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1056 TransitionButtonImage( mDecoration[ SELECTED_DECORATION ] );
1059 TransitionOut( mDecoration[ UNSELECTED_DECORATION ] );
1060 TransitionOut( mUnselectedContent );
1061 TransitionOut( mDisabledContent );
1062 TransitionOut( mDisabledSelectedContent );
1063 TransitionOut( mDisabledBackgroundContent );
1065 mPaintState = SelectedState;
1067 StartTransitionAnimation();
1071 void Button::Released()
1073 if( mPaintState == SelectedState )
1075 StopTransitionAnimation();
1077 // Notifies the derived class the button has been released.
1081 //(3) mUnselectedContent (Inserted)
1082 //(2) mSelectedContent
1083 //(1) mBackgroundContent
1085 AddButtonImage( mBackgroundContent );
1086 AddButtonImage( mSelectedContent );
1087 TransitionButtonImage( mUnselectedContent );
1089 AddButtonImage( mDecoration[ SELECTED_DECORATION ] );
1090 TransitionButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1093 TransitionOut( mDecoration[ SELECTED_DECORATION ] );
1094 TransitionOut( mSelectedContent );
1095 TransitionOut( mSelectedBackgroundContent );
1096 TransitionOut( mDisabledContent );
1097 TransitionOut( mDisabledSelectedContent );
1098 TransitionOut( mDisabledBackgroundContent );
1100 mPaintState = UnselectedState;
1102 StartTransitionAnimation();
1106 Button::ButtonState Button::GetState()
1111 Button::PaintState Button::GetPaintState()
1116 void Button::PrepareAddButtonImage( Actor& actor )
1120 Self().Add( actor );
1121 PrepareForTranstionOut( actor );
1125 void Button::TransitionButtonImage( Actor& actor )
1129 if( !actor.GetParent() )
1131 Self().Add( actor );
1134 OnTransitionIn( actor );
1138 void Button::AddButtonImage( Actor& actor )
1142 Self().Add( actor );
1146 void Button::ReAddLabel()
1151 Self().Add( mLabel );
1155 void Button::RemoveButtonImage( Actor& actor )
1159 if( actor.GetParent() )
1161 Self().Remove( actor );
1163 PrepareForTranstionIn( actor );
1167 unsigned int Button::FindChildIndex( Actor& actor )
1169 Actor self = Self();
1170 unsigned int childrenNum = self.GetChildCount();
1172 for( unsigned int i = 0; i < childrenNum; i++ )
1174 Actor child = self.GetChildAt( i );
1175 if( child == actor )
1184 void Button::TransitionOut( Actor actor )
1186 OnTransitionOut( actor );
1189 void Button::ResetImageLayers()
1191 // Ensure that all layers are in the correct order and state according to the paint state
1193 switch( mPaintState )
1195 case UnselectedState:
1198 //(2) mUnselectedContent
1199 //(1) mBackgroundContent
1201 RemoveButtonImage( mDecoration[ SELECTED_DECORATION ] );
1202 RemoveButtonImage( mSelectedContent );
1203 RemoveButtonImage( mSelectedBackgroundContent );
1204 RemoveButtonImage( mDisabledContent );
1205 RemoveButtonImage( mDisabledSelectedContent );
1206 RemoveButtonImage( mDisabledBackgroundContent );
1208 PrepareAddButtonImage( mBackgroundContent );
1209 PrepareAddButtonImage( mUnselectedContent );
1211 PrepareAddButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1218 //(3) mSelectedContent
1219 //(2) mSelectedBackgroundContent
1220 //(1) mBackgroundContent
1222 RemoveButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1223 RemoveButtonImage( mUnselectedContent );
1224 RemoveButtonImage( mDisabledContent );
1225 RemoveButtonImage( mDisabledSelectedContent );
1226 RemoveButtonImage( mDisabledBackgroundContent );
1228 PrepareAddButtonImage( mBackgroundContent );
1229 PrepareAddButtonImage( mSelectedBackgroundContent );
1230 PrepareAddButtonImage( mSelectedContent );
1232 PrepareAddButtonImage( mDecoration[ SELECTED_DECORATION ] );
1236 case DisabledUnselectedState:
1239 //(2) mDisabledContent
1240 //(1) mDisabledBackgroundContent
1242 RemoveButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1243 RemoveButtonImage( mUnselectedContent );
1244 RemoveButtonImage( mBackgroundContent );
1245 RemoveButtonImage( mDecoration[ SELECTED_DECORATION ] );
1246 RemoveButtonImage( mSelectedContent );
1247 RemoveButtonImage( mDisabledSelectedContent );
1248 RemoveButtonImage( mSelectedBackgroundContent );
1250 PrepareAddButtonImage( mDisabledBackgroundContent ? mDisabledBackgroundContent : mBackgroundContent );
1251 PrepareAddButtonImage( mDisabledContent ? mDisabledContent : mUnselectedContent );
1253 PrepareAddButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1257 case DisabledSelectedState:
1260 // (2) mDisabledSelectedContent
1261 // (1) mDisabledBackgroundContent
1263 RemoveButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1264 RemoveButtonImage( mUnselectedContent );
1265 RemoveButtonImage( mDecoration[ SELECTED_DECORATION ] );
1266 RemoveButtonImage( mSelectedContent );
1267 RemoveButtonImage( mBackgroundContent );
1268 RemoveButtonImage( mSelectedBackgroundContent );
1269 RemoveButtonImage( mDisabledContent );
1271 if( mDisabledBackgroundContent )
1273 PrepareAddButtonImage( mDisabledBackgroundContent );
1277 PrepareAddButtonImage( mBackgroundContent );
1278 PrepareAddButtonImage( mSelectedBackgroundContent );
1281 PrepareAddButtonImage( mDisabledSelectedContent ? mDisabledSelectedContent : mSelectedContent );
1283 PrepareAddButtonImage( mDecoration[ SELECTED_DECORATION ] );
1290 void Button::StartTransitionAnimation()
1292 if( mTransitionAnimation )
1294 mTransitionAnimation.Play();
1302 void Button::StopTransitionAnimation()
1304 if( mTransitionAnimation )
1306 mTransitionAnimation.Clear();
1307 mTransitionAnimation.Reset();
1311 Dali::Animation Button::GetTransitionAnimation()
1313 if( !mTransitionAnimation )
1315 mTransitionAnimation = Dali::Animation::New( GetAnimationTime() );
1316 mTransitionAnimation.FinishedSignal().Connect( this, &Button::TransitionAnimationFinished );
1319 return mTransitionAnimation;
1322 void Button::TransitionAnimationFinished( Dali::Animation& source )
1324 StopTransitionAnimation();
1328 void Button::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
1330 Toolkit::Button button = Toolkit::Button::DownCast( Dali::BaseHandle( object ) );
1336 case Toolkit::Button::Property::DISABLED:
1338 GetImplementation( button ).SetDisabled( value.Get< bool >() );
1342 case Toolkit::Button::Property::AUTO_REPEATING:
1344 GetImplementation( button ).SetAutoRepeating( value.Get< bool >() );
1348 case Toolkit::Button::Property::INITIAL_AUTO_REPEATING_DELAY:
1350 GetImplementation( button ).SetInitialAutoRepeatingDelay( value.Get< float >() );
1354 case Toolkit::Button::Property::NEXT_AUTO_REPEATING_DELAY:
1356 GetImplementation( button ).SetNextAutoRepeatingDelay( value.Get< float >() );
1360 case Toolkit::Button::Property::TOGGLABLE:
1362 GetImplementation( button ).SetTogglableButton( value.Get< bool >() );
1366 case Toolkit::Button::Property::SELECTED:
1368 GetImplementation( button ).SetSelected( value.Get< bool >() );
1372 case Toolkit::Button::Property::UNSELECTED_STATE_IMAGE:
1374 GetImplementation( button ).SetUnselectedImage( value.Get< std::string >() );
1378 case Toolkit::Button::Property::SELECTED_STATE_IMAGE:
1380 GetImplementation( button ).SetSelectedImage( value.Get< std::string >() );
1384 case Toolkit::Button::Property::DISABLED_STATE_IMAGE:
1386 GetImplementation( button ).SetDisabledImage( value.Get< std::string >() );
1390 case Toolkit::Button::Property::UNSELECTED_COLOR:
1392 GetImplementation( button ).SetColor( value.Get< Vector4 >(), UnselectedState );
1396 case Toolkit::Button::Property::SELECTED_COLOR:
1398 GetImplementation( button ).SetColor( value.Get< Vector4 >(), SelectedState );
1402 case Toolkit::Button::Property::LABEL_TEXT:
1404 GetImplementation( button ).SetLabelText( value.Get< std::string >() );
1408 case Toolkit::Button::Property::LABEL:
1410 // Get a Property::Map from the property if possible.
1411 Property::Map setPropertyMap;
1412 if( value.Get( setPropertyMap ) )
1414 GetImplementation( button ).ModifyLabel( setPropertyMap );
1422 Property::Value Button::GetProperty( BaseObject* object, Property::Index propertyIndex )
1424 Property::Value value;
1426 Toolkit::Button button = Toolkit::Button::DownCast( Dali::BaseHandle( object ) );
1430 switch ( propertyIndex )
1432 case Toolkit::Button::Property::DISABLED:
1434 value = GetImplementation( button ).mDisabled;
1438 case Toolkit::Button::Property::AUTO_REPEATING:
1440 value = GetImplementation( button ).mAutoRepeating;
1444 case Toolkit::Button::Property::INITIAL_AUTO_REPEATING_DELAY:
1446 value = GetImplementation( button ).mInitialAutoRepeatingDelay;
1450 case Toolkit::Button::Property::NEXT_AUTO_REPEATING_DELAY:
1452 value = GetImplementation( button ).mNextAutoRepeatingDelay;
1456 case Toolkit::Button::Property::TOGGLABLE:
1458 value = GetImplementation( button ).mTogglableButton;
1462 case Toolkit::Button::Property::SELECTED:
1464 value = GetImplementation( button ).mSelected;
1468 case Toolkit::Button::Property::UNSELECTED_STATE_IMAGE:
1470 value = GetImplementation( button ).GetUnselectedImageFilename();
1474 case Toolkit::Button::Property::SELECTED_STATE_IMAGE:
1476 value = GetImplementation( button ).GetSelectedImageFilename();
1480 case Toolkit::Button::Property::DISABLED_STATE_IMAGE:
1482 value = GetImplementation( button ).GetDisabledImageFilename();
1486 case Toolkit::Button::Property::UNSELECTED_COLOR:
1488 value = GetImplementation( button ).GetUnselectedColor();
1492 case Toolkit::Button::Property::SELECTED_COLOR:
1494 value = GetImplementation( button ).GetSelectedColor();
1498 case Toolkit::Button::Property::LABEL_TEXT:
1500 value = GetImplementation( button ).GetLabelText();
1504 case Toolkit::Button::Property::LABEL:
1506 Property::Map emptyMap;
1518 void Button::SetLabel( Actor label )
1520 if( mLabel != label )
1522 if( mLabel && mLabel.GetParent() )
1524 mLabel.GetParent().Remove( mLabel );
1528 mLabel.SetPosition( 0.0f, 0.0f );
1530 // label should be the top of the button
1531 Self().Add( mLabel );
1540 void Button::SetButtonImage( Actor image )
1544 StopTransitionAnimation();
1546 SetupContent( mUnselectedContent, image );
1548 OnUnselectedImageSet();
1553 void Button::SetSelectedImage( Actor image )
1557 StopTransitionAnimation();
1559 SetupContent( mSelectedContent, image );
1561 OnSelectedImageSet();
1566 void Button::SetBackgroundImage( Actor image )
1570 StopTransitionAnimation();
1572 SetupContent( mBackgroundContent, image );
1574 OnBackgroundImageSet();
1579 void Button::SetSelectedBackgroundImage( Actor image )
1583 StopTransitionAnimation();
1585 SetupContent( mSelectedBackgroundContent, image );
1587 OnSelectedBackgroundImageSet();
1592 void Button::SetDisabledImage( Actor image )
1596 StopTransitionAnimation();
1598 SetupContent( mDisabledContent, image );
1600 OnDisabledImageSet();
1605 void Button::SetDisabledSelectedImage( Actor image )
1609 StopTransitionAnimation();
1611 SetupContent( mDisabledSelectedContent, image );
1613 OnDisabledSelectedImageSet();
1618 void Button::SetDisabledBackgroundImage( Actor image )
1622 StopTransitionAnimation();
1624 SetupContent( mDisabledBackgroundContent, image );
1626 OnDisabledBackgroundImageSet();
1631 Actor Button::GetButtonImage() const
1633 return mUnselectedContent;
1636 Actor Button::GetSelectedImage() const
1638 return mSelectedContent;
1642 } // namespace Internal
1644 } // namespace Toolkit