2 * Copyright (c) 2016 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 <dali-toolkit/public-api/controls/control-impl.h>
22 #include <cstring> // for strcmp
25 #include <dali/public-api/animation/constraint.h>
26 #include <dali/public-api/animation/constraints.h>
27 #include <dali/public-api/object/type-registry.h>
28 #include <dali/public-api/object/type-registry-helper.h>
29 #include <dali/public-api/rendering/renderer.h>
30 #include <dali/public-api/size-negotiation/relayout-container.h>
31 #include <dali/devel-api/common/owner-container.h>
32 #include <dali/devel-api/object/handle-devel.h>
33 #include <dali/devel-api/scripting/scripting.h>
34 #include <dali/integration-api/debug.h>
37 #include <dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h>
38 #include <dali-toolkit/public-api/controls/control.h>
39 #include <dali-toolkit/public-api/styling/style-manager.h>
40 #include <dali-toolkit/public-api/visuals/color-visual-properties.h>
41 #include <dali-toolkit/devel-api/controls/control-depth-index-ranges.h>
42 #include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
43 #include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
44 #include <dali-toolkit/devel-api/focus-manager/keyinput-focus-manager.h>
45 #include <dali-toolkit/internal/styling/style-manager-impl.h>
46 #include <dali-toolkit/internal/visuals/color/color-visual.h>
47 #include <dali-toolkit/internal/visuals/transition-data-impl.h>
48 #include <dali-toolkit/devel-api/align-enums.h>
59 #if defined(DEBUG_ENABLED)
60 Debug::Filter* gLogFilter = Debug::Filter::New( Debug::General, false, "LOG_CONTROL_VISUALS");
64 * Struct used to store Visual within the control, index is a unique key for each visual.
66 struct RegisteredVisual
68 Property::Index index;
69 Toolkit::Visual::Base visual;
72 RegisteredVisual( Property::Index aIndex, Toolkit::Visual::Base &aVisual, bool aEnabled) :
73 index(aIndex), visual(aVisual), enabled(aEnabled) {}
78 Handle handle; ///< a handle to the target object
79 Property::Index index; ///< The index of a property provided by the referenced object
83 index( Property::INVALID_INDEX )
87 HandleIndex( Handle& handle, Property::Index index )
95 typedef Dali::OwnerContainer< RegisteredVisual* > RegisteredVisualContainer;
98 * Finds visual in given array, returning true if found along with the iterator for that visual as a out parameter
100 bool FindVisual( Property::Index targetIndex, RegisteredVisualContainer& visuals, RegisteredVisualContainer::Iterator& iter )
102 for ( iter = visuals.Begin(); iter != visuals.End(); iter++ )
104 if ( (*iter)->index == targetIndex )
112 HandleIndex GetVisualProperty(
113 Internal::Control& controlImpl,
114 RegisteredVisualContainer& visuals,
115 const std::string& visualName,
116 Property::Key propertyKey )
118 #if defined(DEBUG_ENABLED)
119 std::ostringstream oss;
120 oss << "Control::GetHandleIndex(" << visualName << ", " << propertyKey << ")" << std::endl;
121 DALI_LOG_INFO( gLogFilter, Debug::General, oss.str().c_str() );
124 // Find visualName in the control
125 RegisteredVisualContainer::Iterator iter;
126 for ( iter = visuals.Begin(); iter != visuals.End(); iter++ )
128 if ( (*iter)->visual.GetName() == visualName )
134 // Does it's renderer have an associated property?
135 if( iter != visuals.End() )
137 Actor self = controlImpl.Self();
138 Property::Index index = DevelHandle::GetPropertyIndex( self, propertyKey );
139 if( index != Property::INVALID_INDEX )
141 // It's an actor property:
142 return HandleIndex( self, index );
146 // Check if it is a renderer property:
147 if( self.GetRendererCount() > 0 )
149 // @todo Need to use correct renderer index
150 Renderer renderer = self.GetRendererAt(0);
151 Property::Index index = DevelHandle::GetPropertyIndex( renderer, propertyKey );
152 if( index != Property::INVALID_INDEX )
154 // It's a renderer property:
155 return HandleIndex( renderer, index );
160 std::ostringstream oss;
162 DALI_LOG_WARNING( "Control::GetHandleIndex(%s, %s) No renderers\n", visualName.c_str(), oss.str().c_str() );
167 return HandleIndex( handle, Property::INVALID_INDEX );
170 void SetDefaultTransform( Property::Map& propertyMap )
174 .Add( Toolkit::DevelVisual::Transform::Property::OFFSET, Vector2(0.0f, 0.0f) )
175 .Add( Toolkit::DevelVisual::Transform::Property::SIZE, Vector2(1.0f, 1.0f) )
176 .Add( Toolkit::DevelVisual::Transform::Property::ORIGIN, Toolkit::Align::CENTER )
177 .Add( Toolkit::DevelVisual::Transform::Property::ANCHOR_POINT, Toolkit::Align::CENTER )
178 .Add( Toolkit::DevelVisual::Transform::Property::OFFSET_SIZE_MODE, Vector4::ZERO );
182 * Creates control through type registry
186 return Internal::Control::New();
190 * Performs actions as requested using the action name.
191 * @param[in] object The object on which to perform the action.
192 * @param[in] actionName The action to perform.
193 * @param[in] attributes The attributes with which to perfrom this action.
194 * @return true if action has been accepted by this control
196 const char* ACTION_ACCESSIBILITY_ACTIVATED = "accessibilityActivated";
197 static bool DoAction( BaseObject* object, const std::string& actionName, const Property::Map& attributes )
201 if( object && ( 0 == strcmp( actionName.c_str(), ACTION_ACCESSIBILITY_ACTIVATED ) ) )
203 Toolkit::Control control = Toolkit::Control::DownCast( BaseHandle( object ) );
206 // if cast succeeds there is an implementation so no need to check
207 ret = Internal::GetImplementation( control ).OnAccessibilityActivated();
215 * Connects a callback function with the object's signals.
216 * @param[in] object The object providing the signal.
217 * @param[in] tracker Used to disconnect the signal.
218 * @param[in] signalName The signal to connect to.
219 * @param[in] functor A newly allocated FunctorDelegate.
220 * @return True if the signal was connected.
221 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
223 const char* SIGNAL_KEY_EVENT = "keyEvent";
224 const char* SIGNAL_KEY_INPUT_FOCUS_GAINED = "keyInputFocusGained";
225 const char* SIGNAL_KEY_INPUT_FOCUS_LOST = "keyInputFocusLost";
226 const char* SIGNAL_TAPPED = "tapped";
227 const char* SIGNAL_PANNED = "panned";
228 const char* SIGNAL_PINCHED = "pinched";
229 const char* SIGNAL_LONG_PRESSED = "longPressed";
230 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
232 Dali::BaseHandle handle( object );
234 bool connected( false );
235 Toolkit::Control control = Toolkit::Control::DownCast( handle );
238 Internal::Control& controlImpl( Internal::GetImplementation( control ) );
241 if ( 0 == strcmp( signalName.c_str(), SIGNAL_KEY_EVENT ) )
243 controlImpl.KeyEventSignal().Connect( tracker, functor );
245 else if( 0 == strcmp( signalName.c_str(), SIGNAL_KEY_INPUT_FOCUS_GAINED ) )
247 controlImpl.KeyInputFocusGainedSignal().Connect( tracker, functor );
249 else if( 0 == strcmp( signalName.c_str(), SIGNAL_KEY_INPUT_FOCUS_LOST ) )
251 controlImpl.KeyInputFocusLostSignal().Connect( tracker, functor );
253 else if( 0 == strcmp( signalName.c_str(), SIGNAL_TAPPED ) )
255 controlImpl.EnableGestureDetection( Gesture::Tap );
256 controlImpl.GetTapGestureDetector().DetectedSignal().Connect( tracker, functor );
258 else if( 0 == strcmp( signalName.c_str(), SIGNAL_PANNED ) )
260 controlImpl.EnableGestureDetection( Gesture::Pan );
261 controlImpl.GetPanGestureDetector().DetectedSignal().Connect( tracker, functor );
263 else if( 0 == strcmp( signalName.c_str(), SIGNAL_PINCHED ) )
265 controlImpl.EnableGestureDetection( Gesture::Pinch );
266 controlImpl.GetPinchGestureDetector().DetectedSignal().Connect( tracker, functor );
268 else if( 0 == strcmp( signalName.c_str(), SIGNAL_LONG_PRESSED ) )
270 controlImpl.EnableGestureDetection( Gesture::LongPress );
271 controlImpl.GetLongPressGestureDetector().DetectedSignal().Connect( tracker, functor );
277 // Setup signals and actions using the type-registry.
278 DALI_TYPE_REGISTRATION_BEGIN( Control, CustomActor, Create );
280 // Note: Properties are registered separately below.
282 SignalConnectorType registerSignal1( typeRegistration, SIGNAL_KEY_EVENT, &DoConnectSignal );
283 SignalConnectorType registerSignal2( typeRegistration, SIGNAL_KEY_INPUT_FOCUS_GAINED, &DoConnectSignal );
284 SignalConnectorType registerSignal3( typeRegistration, SIGNAL_KEY_INPUT_FOCUS_LOST, &DoConnectSignal );
285 SignalConnectorType registerSignal4( typeRegistration, SIGNAL_TAPPED, &DoConnectSignal );
286 SignalConnectorType registerSignal5( typeRegistration, SIGNAL_PANNED, &DoConnectSignal );
287 SignalConnectorType registerSignal6( typeRegistration, SIGNAL_PINCHED, &DoConnectSignal );
288 SignalConnectorType registerSignal7( typeRegistration, SIGNAL_LONG_PRESSED, &DoConnectSignal );
290 TypeAction registerAction( typeRegistration, ACTION_ACCESSIBILITY_ACTIVATED, &DoAction );
292 DALI_TYPE_REGISTRATION_END()
294 } // unnamed namespace
299 class Control::Impl : public ConnectionTracker
303 // Construction & Destruction
304 Impl(Control& controlImpl)
305 : mControlImpl( controlImpl ),
307 mBackgroundColor(Color::TRANSPARENT),
308 mStartingPinchScale( NULL ),
310 mPinchGestureDetector(),
311 mPanGestureDetector(),
312 mTapGestureDetector(),
313 mLongPressGestureDetector(),
314 mFlags( Control::ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) ),
315 mIsKeyboardNavigationSupported( false ),
316 mIsKeyboardFocusGroup( false )
322 // All gesture detectors will be destroyed so no need to disconnect.
323 delete mStartingPinchScale;
326 // Gesture Detection Methods
328 void PinchDetected(Actor actor, const PinchGesture& pinch)
330 mControlImpl.OnPinch(pinch);
333 void PanDetected(Actor actor, const PanGesture& pan)
335 mControlImpl.OnPan(pan);
338 void TapDetected(Actor actor, const TapGesture& tap)
340 mControlImpl.OnTap(tap);
343 void LongPressDetected(Actor actor, const LongPressGesture& longPress)
345 mControlImpl.OnLongPress(longPress);
351 * Called when a property of an object of this type is set.
352 * @param[in] object The object whose property is set.
353 * @param[in] index The property index.
354 * @param[in] value The new property value.
356 static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
358 Toolkit::Control control = Toolkit::Control::DownCast( BaseHandle( object ) );
362 Control& controlImpl( GetImplementation( control ) );
366 case Toolkit::Control::Property::STYLE_NAME:
368 controlImpl.SetStyleName( value.Get< std::string >() );
372 case Toolkit::Control::Property::BACKGROUND_COLOR:
374 DALI_LOG_WARNING( "BACKGROUND_COLOR property is deprecated. Use BACKGROUND property instead\n" );
375 controlImpl.SetBackgroundColor( value.Get< Vector4 >() );
379 case Toolkit::Control::Property::BACKGROUND_IMAGE:
381 DALI_LOG_WARNING( "BACKGROUND_IMAGE property is deprecated. Use BACKGROUND property instead\n" );
382 Image image = Scripting::NewImage( value );
385 controlImpl.SetBackgroundImage( image );
389 // An empty image means the background is no longer required
390 controlImpl.ClearBackground();
395 case Toolkit::Control::Property::KEY_INPUT_FOCUS:
397 if ( value.Get< bool >() )
399 controlImpl.SetKeyInputFocus();
403 controlImpl.ClearKeyInputFocus();
408 case Toolkit::Control::Property::BACKGROUND:
410 const Property::Map* map = value.GetMap();
411 if( map && !map->Empty() )
413 controlImpl.SetBackground( *map );
417 // The background is an empty property map, so we should clear the background
418 controlImpl.ClearBackground();
427 * Called to retrieve a property of an object of this type.
428 * @param[in] object The object whose property is to be retrieved.
429 * @param[in] index The property index.
430 * @return The current value of the property.
432 static Property::Value GetProperty( BaseObject* object, Property::Index index )
434 Property::Value value;
436 Toolkit::Control control = Toolkit::Control::DownCast( BaseHandle( object ) );
440 Control& controlImpl( GetImplementation( control ) );
444 case Toolkit::Control::Property::STYLE_NAME:
446 value = controlImpl.GetStyleName();
450 case Toolkit::Control::Property::BACKGROUND_COLOR:
452 DALI_LOG_WARNING( "BACKGROUND_COLOR property is deprecated. Use BACKGROUND property instead\n" );
453 value = controlImpl.GetBackgroundColor();
457 case Toolkit::Control::Property::BACKGROUND_IMAGE:
459 DALI_LOG_WARNING( "BACKGROUND_IMAGE property is deprecated. Use BACKGROUND property instead\n" );
461 Toolkit::Visual::Base visual = controlImpl.GetVisual( Toolkit::Control::Property::BACKGROUND );
464 visual.CreatePropertyMap( map );
470 case Toolkit::Control::Property::KEY_INPUT_FOCUS:
472 value = controlImpl.HasKeyInputFocus();
476 case Toolkit::Control::Property::BACKGROUND:
479 Toolkit::Visual::Base visual = controlImpl.GetVisual( Toolkit::Control::Property::BACKGROUND );
482 visual.CreatePropertyMap( map );
497 Control& mControlImpl;
498 RegisteredVisualContainer mVisuals; // Stores visuals needed by the control, non trivial type so std::vector used.
499 std::string mStyleName;
500 Vector4 mBackgroundColor; ///< The color of the background visual
501 Vector3* mStartingPinchScale; ///< The scale when a pinch gesture starts, TODO: consider removing this
502 Toolkit::Control::KeyEventSignalType mKeyEventSignal;
503 Toolkit::Control::KeyInputFocusSignalType mKeyInputFocusGainedSignal;
504 Toolkit::Control::KeyInputFocusSignalType mKeyInputFocusLostSignal;
507 PinchGestureDetector mPinchGestureDetector;
508 PanGestureDetector mPanGestureDetector;
509 TapGestureDetector mTapGestureDetector;
510 LongPressGestureDetector mLongPressGestureDetector;
512 ControlBehaviour mFlags : CONTROL_BEHAVIOUR_FLAG_COUNT; ///< Flags passed in from constructor.
513 bool mIsKeyboardNavigationSupported :1; ///< Stores whether keyboard navigation is supported by the control.
514 bool mIsKeyboardFocusGroup :1; ///< Stores whether the control is a focus group.
516 // Properties - these need to be members of Internal::Control::Impl as they need to function within this class.
517 static const PropertyRegistration PROPERTY_1;
518 static const PropertyRegistration PROPERTY_2;
519 static const PropertyRegistration PROPERTY_3;
520 static const PropertyRegistration PROPERTY_4;
521 static const PropertyRegistration PROPERTY_5;
524 // Properties registered without macro to use specific member variables.
525 const PropertyRegistration Control::Impl::PROPERTY_1( typeRegistration, "styleName", Toolkit::Control::Property::STYLE_NAME, Property::STRING, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
526 const PropertyRegistration Control::Impl::PROPERTY_2( typeRegistration, "backgroundColor", Toolkit::Control::Property::BACKGROUND_COLOR, Property::VECTOR4, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
527 const PropertyRegistration Control::Impl::PROPERTY_3( typeRegistration, "backgroundImage", Toolkit::Control::Property::BACKGROUND_IMAGE, Property::MAP, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
528 const PropertyRegistration Control::Impl::PROPERTY_4( typeRegistration, "keyInputFocus", Toolkit::Control::Property::KEY_INPUT_FOCUS, Property::BOOLEAN, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
529 const PropertyRegistration Control::Impl::PROPERTY_5( typeRegistration, "background", Toolkit::Control::Property::BACKGROUND, Property::MAP, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
531 Toolkit::Control Control::New()
533 // Create the implementation, temporarily owned on stack
534 IntrusivePtr<Control> controlImpl = new Control( ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) );
536 // Pass ownership to handle
537 Toolkit::Control handle( *controlImpl );
539 // Second-phase init of the implementation
540 // This can only be done after the CustomActor connection has been made...
541 controlImpl->Initialize();
546 void Control::SetStyleName( const std::string& styleName )
548 if( styleName != mImpl->mStyleName )
550 mImpl->mStyleName = styleName;
552 // Apply new style, if stylemanager is available
553 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
556 GetImpl( styleManager ).ApplyThemeStyle( Toolkit::Control( GetOwner() ) );
561 const std::string& Control::GetStyleName() const
563 return mImpl->mStyleName;
566 void Control::SetBackgroundColor( const Vector4& color )
568 mImpl->mBackgroundColor = color;
570 map[ Toolkit::DevelVisual::Property::TYPE ] = Toolkit::Visual::COLOR;
571 map[ Toolkit::ColorVisual::Property::MIX_COLOR ] = color;
573 SetBackground( map );
576 Vector4 Control::GetBackgroundColor() const
578 return mImpl->mBackgroundColor;
581 void Control::SetBackground( const Property::Map& map )
583 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( map );
586 RegisterVisual( Toolkit::Control::Property::BACKGROUND, visual );
587 visual.SetDepthIndex( DepthIndex::BACKGROUND );
589 // Trigger a size negotiation request that may be needed by the new visual to relayout its contents.
594 void Control::SetBackgroundImage( Image image )
596 DALI_LOG_WARNING( "SetBackgroundImage is for the depreciated Property::BACKGROUND_IMAGE use SetBackground( const Property::Map& map )\n" );
597 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( image );
600 RegisterVisual( Toolkit::Control::Property::BACKGROUND, visual );
601 visual.SetDepthIndex( DepthIndex::BACKGROUND );
605 void Control::ClearBackground()
607 UnregisterVisual( Toolkit::Control::Property::BACKGROUND );
608 mImpl->mBackgroundColor = Color::TRANSPARENT;
610 // Trigger a size negotiation request that may be needed when unregistering a visual.
614 void Control::EnableGestureDetection(Gesture::Type type)
616 if ( (type & Gesture::Pinch) && !mImpl->mPinchGestureDetector )
618 mImpl->mPinchGestureDetector = PinchGestureDetector::New();
619 mImpl->mPinchGestureDetector.DetectedSignal().Connect(mImpl, &Impl::PinchDetected);
620 mImpl->mPinchGestureDetector.Attach(Self());
623 if ( (type & Gesture::Pan) && !mImpl->mPanGestureDetector )
625 mImpl->mPanGestureDetector = PanGestureDetector::New();
626 mImpl->mPanGestureDetector.DetectedSignal().Connect(mImpl, &Impl::PanDetected);
627 mImpl->mPanGestureDetector.Attach(Self());
630 if ( (type & Gesture::Tap) && !mImpl->mTapGestureDetector )
632 mImpl->mTapGestureDetector = TapGestureDetector::New();
633 mImpl->mTapGestureDetector.DetectedSignal().Connect(mImpl, &Impl::TapDetected);
634 mImpl->mTapGestureDetector.Attach(Self());
637 if ( (type & Gesture::LongPress) && !mImpl->mLongPressGestureDetector )
639 mImpl->mLongPressGestureDetector = LongPressGestureDetector::New();
640 mImpl->mLongPressGestureDetector.DetectedSignal().Connect(mImpl, &Impl::LongPressDetected);
641 mImpl->mLongPressGestureDetector.Attach(Self());
645 void Control::DisableGestureDetection(Gesture::Type type)
647 if ( (type & Gesture::Pinch) && mImpl->mPinchGestureDetector )
649 mImpl->mPinchGestureDetector.Detach(Self());
650 mImpl->mPinchGestureDetector.Reset();
653 if ( (type & Gesture::Pan) && mImpl->mPanGestureDetector )
655 mImpl->mPanGestureDetector.Detach(Self());
656 mImpl->mPanGestureDetector.Reset();
659 if ( (type & Gesture::Tap) && mImpl->mTapGestureDetector )
661 mImpl->mTapGestureDetector.Detach(Self());
662 mImpl->mTapGestureDetector.Reset();
665 if ( (type & Gesture::LongPress) && mImpl->mLongPressGestureDetector)
667 mImpl->mLongPressGestureDetector.Detach(Self());
668 mImpl->mLongPressGestureDetector.Reset();
672 PinchGestureDetector Control::GetPinchGestureDetector() const
674 return mImpl->mPinchGestureDetector;
677 PanGestureDetector Control::GetPanGestureDetector() const
679 return mImpl->mPanGestureDetector;
682 TapGestureDetector Control::GetTapGestureDetector() const
684 return mImpl->mTapGestureDetector;
687 LongPressGestureDetector Control::GetLongPressGestureDetector() const
689 return mImpl->mLongPressGestureDetector;
692 void Control::SetKeyboardNavigationSupport(bool isSupported)
694 mImpl->mIsKeyboardNavigationSupported = isSupported;
697 bool Control::IsKeyboardNavigationSupported()
699 return mImpl->mIsKeyboardNavigationSupported;
702 void Control::SetKeyInputFocus()
704 if( Self().OnStage() )
706 Toolkit::KeyInputFocusManager::Get().SetFocus(Toolkit::Control::DownCast(Self()));
710 bool Control::HasKeyInputFocus()
713 if( Self().OnStage() )
715 result = Toolkit::KeyInputFocusManager::Get().IsKeyboardListener(Toolkit::Control::DownCast(Self()));
720 void Control::ClearKeyInputFocus()
722 if( Self().OnStage() )
724 Toolkit::KeyInputFocusManager::Get().RemoveFocus(Toolkit::Control::DownCast(Self()));
728 void Control::SetAsKeyboardFocusGroup(bool isFocusGroup)
730 mImpl->mIsKeyboardFocusGroup = isFocusGroup;
732 // The following line will be removed when the deprecated API in KeyboardFocusManager is deleted
733 Toolkit::KeyboardFocusManager::Get().SetAsFocusGroup(Self(), isFocusGroup);
736 bool Control::IsKeyboardFocusGroup()
738 return Toolkit::KeyboardFocusManager::Get().IsFocusGroup(Self());
741 void Control::AccessibilityActivate()
743 // Inform deriving classes
744 OnAccessibilityActivated();
747 void Control::KeyboardEnter()
749 // Inform deriving classes
753 void Control::RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual )
755 RegisterVisual( index, visual, true );
758 void Control::RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, bool enabled )
760 bool visualReplaced ( false );
763 if( !mImpl->mVisuals.Empty() )
765 RegisteredVisualContainer::Iterator iter;
766 // Check if visual (index) is already registered. Replace if so.
767 if ( FindVisual( index, mImpl->mVisuals, iter ) )
769 if( (*iter)->visual && self.OnStage() )
771 Toolkit::GetImplementation((*iter)->visual).SetOffStage( self );
773 (*iter)->visual = visual;
774 visualReplaced = true;
778 if( !visualReplaced ) // New registration entry
780 mImpl->mVisuals.PushBack( new RegisteredVisual( index, visual, enabled ) );
783 if( visual && self.OnStage() && enabled )
785 Toolkit::GetImplementation(visual).SetOnStage( self );
789 void Control::UnregisterVisual( Property::Index index )
791 RegisteredVisualContainer::Iterator iter;
792 if ( FindVisual( index, mImpl->mVisuals, iter ) )
794 Actor self( Self() );
795 Toolkit::GetImplementation((*iter)->visual).SetOffStage( self );
796 (*iter)->visual.Reset();
797 mImpl->mVisuals.Erase( iter );
801 Toolkit::Visual::Base Control::GetVisual( Property::Index index ) const
803 RegisteredVisualContainer::Iterator iter;
804 if ( FindVisual( index, mImpl->mVisuals, iter ) )
806 return (*iter)->visual;
809 return Toolkit::Visual::Base();
812 void Control::EnableVisual( Property::Index index, bool enable )
814 RegisteredVisualContainer::Iterator iter;
815 if ( FindVisual( index, mImpl->mVisuals, iter ) )
817 if ( (*iter)->enabled == enable )
819 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::EnableVisual Visual Already enabled set (%s) \n", enable?"enabled":"disabled");
823 (*iter)->enabled = enable;
824 Actor parentActor = Self();
825 if ( Self().OnStage() ) // If control not on Stage then Visual will be added when StageConnection is called.
829 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::EnableVisual Setting Visual(%d) on stage \n", index );
830 Toolkit::GetImplementation((*iter)->visual).SetOnStage( parentActor );
834 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::EnableVisual Setting Visual(%d) off stage \n", index );
835 Toolkit::GetImplementation((*iter)->visual).SetOffStage( parentActor ); // No need to call if control not staged.
841 bool Control::IsVisualEnabled( Property::Index index ) const
843 RegisteredVisualContainer::Iterator iter;
844 if ( FindVisual( index, mImpl->mVisuals, iter ) )
846 return (*iter)->enabled;
851 Dali::Animation Control::CreateTransition( const Toolkit::TransitionData& handle )
853 Dali::Animation transition;
854 const Internal::TransitionData& transitionData = Toolkit::GetImplementation( handle );
856 if( transitionData.Count() > 0 )
858 // Setup a Transition from TransitionData.
859 TransitionData::Iterator end = transitionData.End();
860 for( TransitionData::Iterator iter = transitionData.Begin() ;
861 iter != end; ++iter )
863 TransitionData::Animator* animator = (*iter);
864 HandleIndex handleIndex;
866 // Attempt to find the object name as a child actor
867 Actor child = Self().FindChildByName( animator->objectName );
870 Property::Index propertyIndex = DevelHandle::GetPropertyIndex( child, animator->propertyKey );
871 handleIndex = HandleIndex( child, propertyIndex );
875 handleIndex = GetVisualProperty( *this, mImpl->mVisuals,
876 animator->objectName,
877 animator->propertyKey );
880 if( handleIndex.handle && handleIndex.index != Property::INVALID_INDEX )
882 if( animator->animate == false )
884 if( animator->targetValue.GetType() != Property::NONE )
886 handleIndex.handle.SetProperty( handleIndex.index, animator->targetValue );
891 if( animator->initialValue.GetType() != Property::NONE )
893 handleIndex.handle.SetProperty( handleIndex.index, animator->initialValue );
898 // Create an animation with a default .1 second duration - the animators
899 // will automatically force it to the 'right' duration.
900 transition = Dali::Animation::New( 0.1f );
903 transition.AnimateTo( Property( handleIndex.handle, handleIndex.index ),
904 animator->targetValue,
905 animator->alphaFunction,
906 TimePeriod( animator->timePeriodDelay,
907 animator->timePeriodDuration ) );
916 bool Control::OnAccessibilityActivated()
918 return false; // Accessibility activation is not handled by default
921 bool Control::OnKeyboardEnter()
923 return false; // Keyboard enter is not handled by default
926 bool Control::OnAccessibilityPan(PanGesture gesture)
928 return false; // Accessibility pan gesture is not handled by default
931 bool Control::OnAccessibilityTouch(const TouchEvent& touchEvent)
933 return false; // Accessibility touch event is not handled by default
936 bool Control::OnAccessibilityValueChange(bool isIncrease)
938 return false; // Accessibility value change action is not handled by default
941 bool Control::OnAccessibilityZoom()
943 return false; // Accessibility zoom action is not handled by default
946 Actor Control::GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled)
951 void Control::OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor)
955 Toolkit::Control::KeyEventSignalType& Control::KeyEventSignal()
957 return mImpl->mKeyEventSignal;
960 Toolkit::Control::KeyInputFocusSignalType& Control::KeyInputFocusGainedSignal()
962 return mImpl->mKeyInputFocusGainedSignal;
965 Toolkit::Control::KeyInputFocusSignalType& Control::KeyInputFocusLostSignal()
967 return mImpl->mKeyInputFocusLostSignal;
970 bool Control::EmitKeyEventSignal( const KeyEvent& event )
972 // Guard against destruction during signal emission
973 Dali::Toolkit::Control handle( GetOwner() );
975 bool consumed = false;
977 // signals are allocated dynamically when someone connects
978 if ( !mImpl->mKeyEventSignal.Empty() )
980 consumed = mImpl->mKeyEventSignal.Emit( handle, event );
985 // Notification for derived classes
986 consumed = OnKeyEvent(event);
992 Control::Control( ControlBehaviour behaviourFlags )
993 : CustomActorImpl( static_cast< ActorFlags >( behaviourFlags ) ),
994 mImpl(new Impl(*this))
996 mImpl->mFlags = behaviourFlags;
1004 void Control::Initialize()
1006 // Call deriving classes so initialised before styling is applied to them.
1009 if( (mImpl->mFlags & REQUIRES_STYLE_CHANGE_SIGNALS) ||
1010 !(mImpl->mFlags & DISABLE_STYLE_CHANGE_SIGNALS) )
1012 Toolkit::StyleManager styleManager = StyleManager::Get();
1014 // if stylemanager is available
1017 StyleManager& styleManagerImpl = GetImpl( styleManager );
1019 // Register for style changes
1020 styleManagerImpl.ControlStyleChangeSignal().Connect( this, &Control::OnStyleChange );
1022 // Apply the current style
1023 styleManagerImpl.ApplyThemeStyleAtInit( Toolkit::Control( GetOwner() ) );
1027 if( mImpl->mFlags & REQUIRES_KEYBOARD_NAVIGATION_SUPPORT )
1029 SetKeyboardNavigationSupport( true );
1033 void Control::OnInitialize()
1037 void Control::OnControlChildAdd( Actor& child )
1041 void Control::OnControlChildRemove( Actor& child )
1045 void Control::OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change )
1047 // By default the control is only interested in theme (not font) changes
1048 if( styleManager && change == StyleChange::THEME_CHANGE )
1050 GetImpl( styleManager ).ApplyThemeStyle( Toolkit::Control( GetOwner() ) );
1055 void Control::OnPinch(const PinchGesture& pinch)
1057 if( !( mImpl->mStartingPinchScale ) )
1060 mImpl->mStartingPinchScale = new Vector3;
1063 if( pinch.state == Gesture::Started )
1065 *( mImpl->mStartingPinchScale ) = Self().GetCurrentScale();
1068 Self().SetScale( *( mImpl->mStartingPinchScale ) * pinch.scale );
1071 void Control::OnPan( const PanGesture& pan )
1075 void Control::OnTap(const TapGesture& tap)
1079 void Control::OnLongPress( const LongPressGesture& longPress )
1083 void Control::EmitKeyInputFocusSignal( bool focusGained )
1085 Dali::Toolkit::Control handle( GetOwner() );
1089 // signals are allocated dynamically when someone connects
1090 if ( !mImpl->mKeyInputFocusGainedSignal.Empty() )
1092 mImpl->mKeyInputFocusGainedSignal.Emit( handle );
1097 // signals are allocated dynamically when someone connects
1098 if ( !mImpl->mKeyInputFocusLostSignal.Empty() )
1100 mImpl->mKeyInputFocusLostSignal.Emit( handle );
1105 void Control::OnStageConnection( int depth )
1107 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::OnStageConnection number of registered visuals(%d)\n", mImpl->mVisuals.Size() );
1109 for(RegisteredVisualContainer::Iterator iter = mImpl->mVisuals.Begin(); iter!= mImpl->mVisuals.End(); iter++)
1111 // Check whether the visual is empty and enabled
1112 if( (*iter)->visual && (*iter)->enabled )
1114 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::OnStageConnection Setting visual(%d) on stage\n", (*iter)->index );
1115 Actor self( Self() );
1116 Toolkit::GetImplementation((*iter)->visual).SetOnStage( self );
1121 void Control::OnStageDisconnection()
1123 for(RegisteredVisualContainer::Iterator iter = mImpl->mVisuals.Begin(); iter!= mImpl->mVisuals.End(); iter++)
1125 // Check whether the visual is empty
1126 if( (*iter)->visual )
1128 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::OnStageDisconnection Setting visual(%d) off stage\n", (*iter)->index );
1129 Actor self( Self() );
1130 Toolkit::GetImplementation((*iter)->visual).SetOffStage( self );
1135 void Control::OnKeyInputFocusGained()
1137 EmitKeyInputFocusSignal( true );
1140 void Control::OnKeyInputFocusLost()
1142 EmitKeyInputFocusSignal( false );
1145 void Control::OnChildAdd(Actor& child)
1147 // Notify derived classes.
1148 OnControlChildAdd( child );
1151 void Control::OnChildRemove(Actor& child)
1153 // Notify derived classes.
1154 OnControlChildRemove( child );
1157 void Control::OnSizeSet(const Vector3& targetSize)
1159 Toolkit::Visual::Base visual = GetVisual( Toolkit::Control::Property::BACKGROUND );
1162 Vector2 size( targetSize );
1163 Property::Map transformMap;
1164 SetDefaultTransform( transformMap );
1165 visual.SetTransformAndSize( transformMap, size );
1169 void Control::OnSizeAnimation(Animation& animation, const Vector3& targetSize)
1171 // @todo size negotiate background to new size, animate as well?
1174 bool Control::OnTouchEvent(const TouchEvent& event)
1176 return false; // Do not consume
1179 bool Control::OnHoverEvent(const HoverEvent& event)
1181 return false; // Do not consume
1184 bool Control::OnKeyEvent(const KeyEvent& event)
1186 return false; // Do not consume
1189 bool Control::OnWheelEvent(const WheelEvent& event)
1191 return false; // Do not consume
1194 void Control::OnRelayout( const Vector2& size, RelayoutContainer& container )
1196 for( unsigned int i = 0, numChildren = Self().GetChildCount(); i < numChildren; ++i )
1198 container.Add( Self().GetChildAt( i ), size );
1201 Toolkit::Visual::Base visual = GetVisual( Toolkit::Control::Property::BACKGROUND );
1204 Vector2 controlSize( size );
1205 Property::Map transformMap;
1206 SetDefaultTransform( transformMap );
1207 visual.SetTransformAndSize( transformMap, controlSize );
1211 void Control::OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension )
1215 Vector3 Control::GetNaturalSize()
1217 Toolkit::Visual::Base visual = GetVisual( Toolkit::Control::Property::BACKGROUND );
1220 Vector2 naturalSize;
1221 visual.GetNaturalSize( naturalSize );
1222 return Vector3( naturalSize );
1224 return Vector3::ZERO;
1227 float Control::CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension )
1229 return CalculateChildSizeBase( child, dimension );
1232 float Control::GetHeightForWidth( float width )
1234 return GetHeightForWidthBase( width );
1237 float Control::GetWidthForHeight( float height )
1239 return GetWidthForHeightBase( height );
1242 bool Control::RelayoutDependentOnChildren( Dimension::Type dimension )
1244 return RelayoutDependentOnChildrenBase( dimension );
1247 void Control::OnCalculateRelayoutSize( Dimension::Type dimension )
1251 void Control::OnLayoutNegotiated( float size, Dimension::Type dimension )
1255 void Control::SignalConnected( SlotObserver* slotObserver, CallbackBase* callback )
1257 mImpl->SignalConnected( slotObserver, callback );
1260 void Control::SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback )
1262 mImpl->SignalDisconnected( slotObserver, callback );
1265 Control& GetImplementation( Dali::Toolkit::Control& handle )
1267 CustomActorImpl& customInterface = handle.GetImplementation();
1268 // downcast to control
1269 Control& impl = dynamic_cast< Internal::Control& >( customInterface );
1273 const Control& GetImplementation( const Dali::Toolkit::Control& handle )
1275 const CustomActorImpl& customInterface = handle.GetImplementation();
1276 // downcast to control
1277 const Control& impl = dynamic_cast< const Internal::Control& >( customInterface );
1281 } // namespace Internal
1283 } // namespace Toolkit