2 * Copyright (c) 2017 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 "control-data-impl.h"
22 #include <dali/public-api/common/dali-common.h>
23 #include <dali/integration-api/debug.h>
24 #include <dali/devel-api/object/handle-devel.h>
25 #include <dali/devel-api/scripting/enum-helper.h>
26 #include <dali/devel-api/scripting/scripting.h>
27 #include <dali/integration-api/debug.h>
28 #include <dali/public-api/object/type-registry-helper.h>
33 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
34 #include <dali-toolkit/devel-api/controls/control-depth-index-ranges.h>
35 #include <dali-toolkit/internal/styling/style-manager-impl.h>
36 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
37 #include <dali-toolkit/public-api/visuals/visual-properties.h>
38 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
39 #include <dali-toolkit/devel-api/controls/control-devel.h>
40 #include <dali-toolkit/devel-api/controls/control-wrapper-impl.h>
51 extern const Dali::Scripting::StringEnum ControlStateTable[];
52 extern const unsigned int ControlStateTableCount;
55 // Not static or anonymous - shared with other translation units
56 const Scripting::StringEnum ControlStateTable[] = {
57 { "NORMAL", Toolkit::DevelControl::NORMAL },
58 { "FOCUSED", Toolkit::DevelControl::FOCUSED },
59 { "DISABLED", Toolkit::DevelControl::DISABLED },
61 const unsigned int ControlStateTableCount = sizeof( ControlStateTable ) / sizeof( ControlStateTable[0] );
68 #if defined(DEBUG_ENABLED)
69 Debug::Filter* gLogFilter = Debug::Filter::New( Debug::NoLogging, false, "LOG_CONTROL_VISUALS");
74 void Remove( Dictionary<T>& keyValues, const std::string& name )
76 keyValues.Remove(name);
79 void Remove( DictionaryKeys& keys, const std::string& name )
81 DictionaryKeys::iterator iter = std::find( keys.begin(), keys.end(), name );
82 if( iter != keys.end())
88 Toolkit::Visual::Type GetVisualTypeFromMap( const Property::Map& map )
90 Property::Value* typeValue = map.Find( Toolkit::Visual::Property::TYPE, VISUAL_TYPE );
91 Toolkit::Visual::Type type = Toolkit::Visual::IMAGE;
94 Scripting::GetEnumerationProperty( *typeValue, VISUAL_TYPE_TABLE, VISUAL_TYPE_TABLE_COUNT, type );
100 * Finds visual in given array, returning true if found along with the iterator for that visual as a out parameter
102 bool FindVisual( Property::Index targetIndex, const RegisteredVisualContainer& visuals, RegisteredVisualContainer::Iterator& iter )
104 for ( iter = visuals.Begin(); iter != visuals.End(); iter++ )
106 if ( (*iter)->index == targetIndex )
114 void FindChangableVisuals( Dictionary<Property::Map>& stateVisualsToAdd,
115 Dictionary<Property::Map>& stateVisualsToChange,
116 DictionaryKeys& stateVisualsToRemove)
118 DictionaryKeys copyOfStateVisualsToRemove = stateVisualsToRemove;
120 for( DictionaryKeys::iterator iter = copyOfStateVisualsToRemove.begin();
121 iter != copyOfStateVisualsToRemove.end(); ++iter )
123 const std::string& visualName = (*iter);
124 Property::Map* toMap = stateVisualsToAdd.Find( visualName );
127 stateVisualsToChange.Add( visualName, *toMap );
128 stateVisualsToAdd.Remove( visualName );
129 Remove( stateVisualsToRemove, visualName );
134 Toolkit::Visual::Base GetVisualByName(
135 const RegisteredVisualContainer& visuals,
136 const std::string& visualName )
138 Toolkit::Visual::Base visualHandle;
140 RegisteredVisualContainer::Iterator iter;
141 for ( iter = visuals.Begin(); iter != visuals.End(); iter++ )
143 Toolkit::Visual::Base visual = (*iter)->visual;
144 if( visual && visual.GetName() == visualName )
146 visualHandle = visual;
154 * Move visual from source to destination container
156 void MoveVisual( RegisteredVisualContainer::Iterator sourceIter, RegisteredVisualContainer& source, RegisteredVisualContainer& destination )
158 Toolkit::Visual::Base visual = (*sourceIter)->visual;
161 RegisteredVisual* rv = source.Release( sourceIter );
162 destination.PushBack( rv );
167 * Performs actions as requested using the action name.
168 * @param[in] object The object on which to perform the action.
169 * @param[in] actionName The action to perform.
170 * @param[in] attributes The attributes with which to perfrom this action.
171 * @return true if action has been accepted by this control
173 const char* ACTION_ACCESSIBILITY_ACTIVATED = "accessibilityActivated";
174 static bool DoAction( BaseObject* object, const std::string& actionName, const Property::Map& attributes )
178 if( object && ( 0 == strcmp( actionName.c_str(), ACTION_ACCESSIBILITY_ACTIVATED ) ) )
180 Toolkit::Control control = Toolkit::Control::DownCast( BaseHandle( object ) );
183 // if cast succeeds there is an implementation so no need to check
184 ret = Internal::GetImplementation( control ).OnAccessibilityActivated();
192 * Connects a callback function with the object's signals.
193 * @param[in] object The object providing the signal.
194 * @param[in] tracker Used to disconnect the signal.
195 * @param[in] signalName The signal to connect to.
196 * @param[in] functor A newly allocated FunctorDelegate.
197 * @return True if the signal was connected.
198 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
200 const char* SIGNAL_KEY_EVENT = "keyEvent";
201 const char* SIGNAL_KEY_INPUT_FOCUS_GAINED = "keyInputFocusGained";
202 const char* SIGNAL_KEY_INPUT_FOCUS_LOST = "keyInputFocusLost";
203 const char* SIGNAL_TAPPED = "tapped";
204 const char* SIGNAL_PANNED = "panned";
205 const char* SIGNAL_PINCHED = "pinched";
206 const char* SIGNAL_LONG_PRESSED = "longPressed";
207 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
209 Dali::BaseHandle handle( object );
211 bool connected( false );
212 Toolkit::Control control = Toolkit::Control::DownCast( handle );
215 Internal::Control& controlImpl( Internal::GetImplementation( control ) );
218 if ( 0 == strcmp( signalName.c_str(), SIGNAL_KEY_EVENT ) )
220 controlImpl.KeyEventSignal().Connect( tracker, functor );
222 else if( 0 == strcmp( signalName.c_str(), SIGNAL_KEY_INPUT_FOCUS_GAINED ) )
224 controlImpl.KeyInputFocusGainedSignal().Connect( tracker, functor );
226 else if( 0 == strcmp( signalName.c_str(), SIGNAL_KEY_INPUT_FOCUS_LOST ) )
228 controlImpl.KeyInputFocusLostSignal().Connect( tracker, functor );
230 else if( 0 == strcmp( signalName.c_str(), SIGNAL_TAPPED ) )
232 controlImpl.EnableGestureDetection( Gesture::Tap );
233 controlImpl.GetTapGestureDetector().DetectedSignal().Connect( tracker, functor );
235 else if( 0 == strcmp( signalName.c_str(), SIGNAL_PANNED ) )
237 controlImpl.EnableGestureDetection( Gesture::Pan );
238 controlImpl.GetPanGestureDetector().DetectedSignal().Connect( tracker, functor );
240 else if( 0 == strcmp( signalName.c_str(), SIGNAL_PINCHED ) )
242 controlImpl.EnableGestureDetection( Gesture::Pinch );
243 controlImpl.GetPinchGestureDetector().DetectedSignal().Connect( tracker, functor );
245 else if( 0 == strcmp( signalName.c_str(), SIGNAL_LONG_PRESSED ) )
247 controlImpl.EnableGestureDetection( Gesture::LongPress );
248 controlImpl.GetLongPressGestureDetector().DetectedSignal().Connect( tracker, functor );
255 * Creates control through type registry
259 return Internal::Control::New();
261 // Setup signals and actions using the type-registry.
262 DALI_TYPE_REGISTRATION_BEGIN( Control, CustomActor, Create );
264 // Note: Properties are registered separately below.
266 SignalConnectorType registerSignal1( typeRegistration, SIGNAL_KEY_EVENT, &DoConnectSignal );
267 SignalConnectorType registerSignal2( typeRegistration, SIGNAL_KEY_INPUT_FOCUS_GAINED, &DoConnectSignal );
268 SignalConnectorType registerSignal3( typeRegistration, SIGNAL_KEY_INPUT_FOCUS_LOST, &DoConnectSignal );
269 SignalConnectorType registerSignal4( typeRegistration, SIGNAL_TAPPED, &DoConnectSignal );
270 SignalConnectorType registerSignal5( typeRegistration, SIGNAL_PANNED, &DoConnectSignal );
271 SignalConnectorType registerSignal6( typeRegistration, SIGNAL_PINCHED, &DoConnectSignal );
272 SignalConnectorType registerSignal7( typeRegistration, SIGNAL_LONG_PRESSED, &DoConnectSignal );
274 TypeAction registerAction( typeRegistration, ACTION_ACCESSIBILITY_ACTIVATED, &DoAction );
276 DALI_TYPE_REGISTRATION_END()
279 * @brief Iterate through given container and setOffStage any visual found
281 * @param[in] container Container of visuals
282 * @param[in] parent Parent actor to remove visuals from
284 void SetVisualsOffStage( const RegisteredVisualContainer& container, Actor parent )
286 for( auto iter = container.Begin(), end = container.End() ; iter!= end; iter++)
288 if( (*iter)->visual )
290 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::SetOffStage Setting visual(%d) off stage\n", (*iter)->index );
291 Toolkit::GetImplementation((*iter)->visual).SetOffStage( parent );
296 } // unnamed namespace
299 // Properties registered without macro to use specific member variables.
300 const PropertyRegistration Control::Impl::PROPERTY_1( typeRegistration, "styleName", Toolkit::Control::Property::STYLE_NAME, Property::STRING, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
301 const PropertyRegistration Control::Impl::PROPERTY_2( typeRegistration, "backgroundColor", Toolkit::Control::Property::BACKGROUND_COLOR, Property::VECTOR4, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
302 const PropertyRegistration Control::Impl::PROPERTY_3( typeRegistration, "backgroundImage", Toolkit::Control::Property::BACKGROUND_IMAGE, Property::MAP, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
303 const PropertyRegistration Control::Impl::PROPERTY_4( typeRegistration, "keyInputFocus", Toolkit::Control::Property::KEY_INPUT_FOCUS, Property::BOOLEAN, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
304 const PropertyRegistration Control::Impl::PROPERTY_5( typeRegistration, "background", Toolkit::Control::Property::BACKGROUND, Property::MAP, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
305 const PropertyRegistration Control::Impl::PROPERTY_6( typeRegistration, "tooltip", Toolkit::DevelControl::Property::TOOLTIP, Property::MAP, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
306 const PropertyRegistration Control::Impl::PROPERTY_7( typeRegistration, "state", Toolkit::DevelControl::Property::STATE, Property::STRING, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
307 const PropertyRegistration Control::Impl::PROPERTY_8( typeRegistration, "subState", Toolkit::DevelControl::Property::SUB_STATE, Property::STRING, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
308 const PropertyRegistration Control::Impl::PROPERTY_9( typeRegistration, "leftFocusableActorId", Toolkit::DevelControl::Property::LEFT_FOCUSABLE_ACTOR_ID, Property::INTEGER, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
309 const PropertyRegistration Control::Impl::PROPERTY_10( typeRegistration, "rightFocusableActorId", Toolkit::DevelControl::Property::RIGHT_FOCUSABLE_ACTOR_ID,Property::INTEGER, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
310 const PropertyRegistration Control::Impl::PROPERTY_11( typeRegistration, "upFocusableActorId", Toolkit::DevelControl::Property::UP_FOCUSABLE_ACTOR_ID, Property::INTEGER, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
311 const PropertyRegistration Control::Impl::PROPERTY_12( typeRegistration, "downFocusableActorId", Toolkit::DevelControl::Property::DOWN_FOCUSABLE_ACTOR_ID, Property::INTEGER, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
315 Control::Impl::Impl( Control& controlImpl )
316 : mControlImpl( controlImpl ),
317 mState( Toolkit::DevelControl::NORMAL ),
319 mLeftFocusableActorId( -1 ),
320 mRightFocusableActorId( -1 ),
321 mUpFocusableActorId( -1 ),
322 mDownFocusableActorId( -1 ),
324 mBackgroundColor(Color::TRANSPARENT),
325 mStartingPinchScale( NULL ),
327 mPinchGestureDetector(),
328 mPanGestureDetector(),
329 mTapGestureDetector(),
330 mLongPressGestureDetector(),
331 mFlags( Control::ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) ),
332 mIsKeyboardNavigationSupported( false ),
333 mIsKeyboardFocusGroup( false )
338 Control::Impl::~Impl()
340 // All gesture detectors will be destroyed so no need to disconnect.
341 delete mStartingPinchScale;
344 Control::Impl& Control::Impl::Get( Internal::Control& internalControl )
346 return *internalControl.mImpl;
349 const Control::Impl& Control::Impl::Get( const Internal::Control& internalControl )
351 return *internalControl.mImpl;
354 // Gesture Detection Methods
355 void Control::Impl::PinchDetected(Actor actor, const PinchGesture& pinch)
357 mControlImpl.OnPinch(pinch);
360 void Control::Impl::PanDetected(Actor actor, const PanGesture& pan)
362 mControlImpl.OnPan(pan);
365 void Control::Impl::TapDetected(Actor actor, const TapGesture& tap)
367 mControlImpl.OnTap(tap);
370 void Control::Impl::LongPressDetected(Actor actor, const LongPressGesture& longPress)
372 mControlImpl.OnLongPress(longPress);
375 void Control::Impl::RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual )
377 RegisterVisual( index, visual, VisualState::ENABLED, DepthIndexValue::NOT_SET );
380 void Control::Impl::RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, int depthIndex )
382 RegisterVisual( index, visual, VisualState::ENABLED, DepthIndexValue::SET, depthIndex );
385 void Control::Impl::RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, bool enabled )
387 RegisterVisual( index, visual, ( enabled ? VisualState::ENABLED : VisualState::DISABLED ), DepthIndexValue::NOT_SET );
390 void Control::Impl::RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, bool enabled, int depthIndex )
392 RegisterVisual( index, visual, ( enabled ? VisualState::ENABLED : VisualState::DISABLED ), DepthIndexValue::SET, depthIndex );
395 void Control::Impl::RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, VisualState::Type enabled, DepthIndexValue::Type depthIndexValueSet, int depthIndex )
397 DALI_LOG_INFO( gLogFilter, Debug::Concise, "RegisterVisual:%d \n", index );
399 bool visualReplaced ( false );
400 Actor self = mControlImpl.Self();
402 // Set the depth index, if not set by caller this will be either the current visual depth, max depth of all visuals
404 int requiredDepthIndex = visual.GetDepthIndex();
406 if( depthIndexValueSet == DepthIndexValue::SET )
408 requiredDepthIndex = depthIndex;
411 // Visual replacement, existing visual should only be removed from stage when replacement ready.
412 if( !mVisuals.Empty() )
414 RegisteredVisualContainer::Iterator registeredVisualsiter;
415 // Check if visual (index) is already registered, this is the current visual.
416 if( FindVisual( index, mVisuals, registeredVisualsiter ) )
418 Toolkit::Visual::Base& currentRegisteredVisual = (*registeredVisualsiter)->visual;
419 if( currentRegisteredVisual )
421 // Store current visual depth index as may need to set the replacement visual to same depth
422 const int currentDepthIndex = (*registeredVisualsiter)->visual.GetDepthIndex();
424 // No longer required to know if the replaced visual's resources are ready
425 StopObservingVisual( currentRegisteredVisual );
427 // If control staged and visual enabled then visuals will be swapped once ready
428 if( self.OnStage() && enabled )
430 // Check if visual is currently in the process of being replaced ( is in removal container )
431 RegisteredVisualContainer::Iterator visualQueuedForRemoval;
432 if ( FindVisual( index, mRemoveVisuals, visualQueuedForRemoval ) )
434 // Visual with same index is already in removal container so current visual pending
435 // Only the the last requested visual will be displayed so remove current visual which is staged but not ready.
436 Toolkit::GetImplementation( currentRegisteredVisual ).SetOffStage( self );
437 mVisuals.Erase( registeredVisualsiter );
441 // current visual not already in removal container so add now.
442 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "RegisterVisual Move current registered visual to removal Queue: %d \n", index );
443 MoveVisual( registeredVisualsiter, mVisuals, mRemoveVisuals );
448 // Control not staged or visual disabled so can just erase from registered visuals and new visual will be added later.
449 mVisuals.Erase( registeredVisualsiter );
452 // If we've not set the depth-index value and the new visual does not have a depth index applied to it, then use the previously set depth-index for this index
453 if( ( depthIndexValueSet == DepthIndexValue::NOT_SET ) &&
454 ( visual.GetDepthIndex() == 0 ) )
456 requiredDepthIndex = currentDepthIndex;
460 visualReplaced = true;
464 // If not set, set the name of the visual to the same name as the control's property.
465 // ( If the control has been type registered )
466 if( visual.GetName().empty() )
470 std::string visualName = self.GetPropertyName( index );
471 if( !visualName.empty() )
473 DALI_LOG_INFO( gLogFilter, Debug::Concise, "Setting visual name for property %d to %s\n",
474 index, visualName.c_str() );
475 visual.SetName( visualName );
478 catch( Dali::DaliException e )
480 DALI_LOG_WARNING( "Attempting to register visual without a registered property, index: %d\n", index );
484 if( !visualReplaced ) // New registration entry
486 // monitor when the visual resources are ready
487 StartObservingVisual( visual );
489 // If we've not set the depth-index value, we have more than one visual and the visual does not have a depth index, then set it to be the highest
490 if( ( depthIndexValueSet == DepthIndexValue::NOT_SET ) &&
491 ( mVisuals.Size() > 0 ) &&
492 ( visual.GetDepthIndex() == 0 ) )
494 int maxDepthIndex = std::numeric_limits< int >::min();
496 RegisteredVisualContainer::ConstIterator iter;
497 const RegisteredVisualContainer::ConstIterator endIter = mVisuals.End();
498 for ( iter = mVisuals.Begin(); iter != endIter; iter++ )
500 const int visualDepthIndex = (*iter)->visual.GetDepthIndex();
501 if ( visualDepthIndex > maxDepthIndex )
503 maxDepthIndex = visualDepthIndex;
506 ++maxDepthIndex; // Add one to the current maximum depth index so that our added visual appears on top
507 requiredDepthIndex = std::max( 0, maxDepthIndex ); // Start at zero if maxDepth index belongs to a background
513 // Set determined depth index
514 visual.SetDepthIndex( requiredDepthIndex );
516 // Monitor when the visual resources are ready
517 StartObservingVisual( visual );
519 DALI_LOG_INFO( gLogFilter, Debug::Concise, "New Visual registration index[%d] depth[%d]\n", index, requiredDepthIndex );
520 RegisteredVisual* newRegisteredVisual = new RegisteredVisual( index, visual,
521 ( enabled == VisualState::ENABLED ? true : false ),
522 ( visualReplaced && enabled ) ) ;
523 mVisuals.PushBack( newRegisteredVisual );
525 // Put on stage if enabled and the control is already on the stage
526 // Visual must be set on stage for the renderer to be created and the ResourceReady triggered.
527 if( ( enabled == VisualState::ENABLED ) && self.OnStage() )
529 Toolkit::GetImplementation(visual).SetOnStage( self );
533 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::RegisterVisual() Registered %s(%d), enabled:%s\n", visual.GetName().c_str(), index, enabled?"true":"false" );
536 void Control::Impl::UnregisterVisual( Property::Index index )
538 RegisteredVisualContainer::Iterator iter;
539 if ( FindVisual( index, mVisuals, iter ) )
541 // stop observing visual
542 StopObservingVisual( (*iter)->visual );
544 Actor self( mControlImpl.Self() );
545 Toolkit::GetImplementation((*iter)->visual).SetOffStage( self );
546 (*iter)->visual.Reset();
547 mVisuals.Erase( iter );
551 Toolkit::Visual::Base Control::Impl::GetVisual( Property::Index index ) const
553 RegisteredVisualContainer::Iterator iter;
554 if ( FindVisual( index, mVisuals, iter ) )
556 return (*iter)->visual;
559 return Toolkit::Visual::Base();
562 void Control::Impl::EnableVisual( Property::Index index, bool enable )
564 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::EnableVisual Visual (%d)\n", index);
566 RegisteredVisualContainer::Iterator iter;
567 if ( FindVisual( index, mVisuals, iter ) )
569 if ( (*iter)->enabled == enable )
571 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::EnableVisual Visual %s(%d) already %s\n", (*iter)->visual.GetName().c_str(), index, enable?"enabled":"disabled");
575 (*iter)->enabled = enable;
576 Actor parentActor = mControlImpl.Self();
577 if ( mControlImpl.Self().OnStage() ) // If control not on Stage then Visual will be added when StageConnection is called.
581 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::EnableVisual Setting %s(%d) on stage \n", (*iter)->visual.GetName().c_str(), index );
582 Toolkit::GetImplementation((*iter)->visual).SetOnStage( parentActor );
586 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::EnableVisual Setting %s(%d) off stage \n", (*iter)->visual.GetName().c_str(), index );
587 Toolkit::GetImplementation((*iter)->visual).SetOffStage( parentActor ); // No need to call if control not staged.
593 bool Control::Impl::IsVisualEnabled( Property::Index index ) const
595 RegisteredVisualContainer::Iterator iter;
596 if ( FindVisual( index, mVisuals, iter ) )
598 return (*iter)->enabled;
603 void Control::Impl::StopObservingVisual( Toolkit::Visual::Base& visual )
605 Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
607 // Stop observing the visual
608 visualImpl.RemoveResourceObserver( *this );
611 void Control::Impl::StartObservingVisual( Toolkit::Visual::Base& visual)
613 Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
615 // start observing the visual for resource ready
616 visualImpl.AddResourceObserver( *this );
619 // Called by a Visual when it's resource is ready
620 void Control::Impl::ResourceReady( Visual::Base& object)
622 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "ResourceReady replacements pending[%d]\n", mRemoveVisuals.Count() );
624 Actor self = mControlImpl.Self();
626 // A resource is ready, find resource in the registered visuals container and get its index
627 for( auto registeredIter = mVisuals.Begin(), end = mVisuals.End(); registeredIter != end; ++registeredIter )
629 Internal::Visual::Base& registeredVisualImpl = Toolkit::GetImplementation( (*registeredIter)->visual );
631 if( &object == ®isteredVisualImpl )
633 RegisteredVisualContainer::Iterator visualToRemoveIter;
634 // Find visual with the same index in the removal container
635 // Set if off stage as it's replacement is now ready.
636 // Remove if from removal list as now removed from stage.
637 // Set Pending flag on the ready visual to false as now ready.
638 if( FindVisual( (*registeredIter)->index, mRemoveVisuals, visualToRemoveIter ) )
640 (*registeredIter)->pending = false;
641 Toolkit::GetImplementation( (*visualToRemoveIter)->visual ).SetOffStage( self );
642 mRemoveVisuals.Erase( visualToRemoveIter );
648 // A visual is ready so control may need relayouting
649 mControlImpl.RelayoutRequest();
651 // Emit signal if all enabled visuals registered by the control are ready.
652 if( IsResourceReady() )
654 Dali::Toolkit::Control handle( mControlImpl.GetOwner() );
655 mResourceReadySignal.Emit( handle );
659 bool Control::Impl::IsResourceReady() const
661 // Iterate through and check all the enabled visuals are ready
662 for( auto visualIter = mVisuals.Begin();
663 visualIter != mVisuals.End(); ++visualIter )
665 const Toolkit::Visual::Base visual = (*visualIter)->visual;
666 const Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
668 // one of the enabled visuals is not ready
669 if( !visualImpl.IsResourceReady() && (*visualIter)->enabled )
678 Dali::Animation Control::Impl::CreateTransition( const Toolkit::TransitionData& handle )
680 Dali::Animation transition;
681 const Internal::TransitionData& transitionData = Toolkit::GetImplementation( handle );
683 if( transitionData.Count() > 0 )
685 // Setup a Transition from TransitionData.
686 TransitionData::Iterator end = transitionData.End();
687 for( TransitionData::Iterator iter = transitionData.Begin() ;
688 iter != end; ++iter )
690 TransitionData::Animator* animator = (*iter);
692 Toolkit::Visual::Base visual = GetVisualByName( mVisuals, animator->objectName );
696 #if defined(DEBUG_ENABLED)
697 Dali::TypeInfo typeInfo;
698 ControlWrapper* controlWrapperImpl = dynamic_cast<ControlWrapper*>(&mControlImpl);
699 if( controlWrapperImpl )
701 typeInfo = controlWrapperImpl->GetTypeInfo();
704 DALI_LOG_INFO( gLogFilter, Debug::Concise, "CreateTransition: Found %s visual for %s\n",
705 visual.GetName().c_str(), typeInfo?typeInfo.GetName().c_str():"Unknown" );
707 Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
708 visualImpl.AnimateProperty( transition, *animator );
712 DALI_LOG_INFO( gLogFilter, Debug::Concise, "CreateTransition: Could not find visual. Trying actors");
713 // Otherwise, try any actor children of control (Including the control)
714 Actor child = mControlImpl.Self().FindChildByName( animator->objectName );
717 Property::Index propertyIndex = DevelHandle::GetPropertyIndex( child, animator->propertyKey );
718 if( propertyIndex != Property::INVALID_INDEX )
720 if( animator->animate == false )
722 if( animator->targetValue.GetType() != Property::NONE )
724 child.SetProperty( propertyIndex, animator->targetValue );
727 else // animate the property
729 if( animator->initialValue.GetType() != Property::NONE )
731 child.SetProperty( propertyIndex, animator->initialValue );
736 transition = Dali::Animation::New( 0.1f );
739 transition.AnimateTo( Property( child, propertyIndex ),
740 animator->targetValue,
741 animator->alphaFunction,
742 TimePeriod( animator->timePeriodDelay,
743 animator->timePeriodDuration ) );
754 void Control::Impl::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
756 Toolkit::Control control = Toolkit::Control::DownCast( BaseHandle( object ) );
760 Control& controlImpl( GetImplementation( control ) );
764 case Toolkit::Control::Property::STYLE_NAME:
766 controlImpl.SetStyleName( value.Get< std::string >() );
770 case Toolkit::DevelControl::Property::STATE:
772 bool withTransitions=true;
773 const Property::Value* valuePtr=&value;
774 Property::Map* map = value.GetMap();
777 Property::Value* value2 = map->Find("withTransitions");
780 withTransitions = value2->Get<bool>();
783 valuePtr = map->Find("state");
788 Toolkit::DevelControl::State state( controlImpl.mImpl->mState );
789 if( Scripting::GetEnumerationProperty< Toolkit::DevelControl::State >( *valuePtr, ControlStateTable, ControlStateTableCount, state ) )
791 controlImpl.mImpl->SetState( state, withTransitions );
797 case Toolkit::DevelControl::Property::SUB_STATE:
799 std::string subState;
800 if( value.Get( subState ) )
802 controlImpl.mImpl->SetSubState( subState );
807 case Toolkit::DevelControl::Property::LEFT_FOCUSABLE_ACTOR_ID:
810 if( value.Get( focusId ) )
812 controlImpl.mImpl->mLeftFocusableActorId = focusId;
817 case Toolkit::DevelControl::Property::RIGHT_FOCUSABLE_ACTOR_ID:
820 if( value.Get( focusId ) )
822 controlImpl.mImpl->mRightFocusableActorId = focusId;
827 case Toolkit::DevelControl::Property::UP_FOCUSABLE_ACTOR_ID:
830 if( value.Get( focusId ) )
832 controlImpl.mImpl->mUpFocusableActorId = focusId;
837 case Toolkit::DevelControl::Property::DOWN_FOCUSABLE_ACTOR_ID:
840 if( value.Get( focusId ) )
842 controlImpl.mImpl->mDownFocusableActorId = focusId;
847 case Toolkit::Control::Property::BACKGROUND_COLOR:
849 DALI_LOG_WARNING( "BACKGROUND_COLOR property is deprecated. Use BACKGROUND property instead\n" );
850 controlImpl.SetBackgroundColor( value.Get< Vector4 >() );
854 case Toolkit::Control::Property::BACKGROUND_IMAGE:
856 DALI_LOG_WARNING( "BACKGROUND_IMAGE property is deprecated. Use BACKGROUND property instead\n" );
857 Image image = Scripting::NewImage( value );
860 controlImpl.SetBackgroundImage( image );
864 // An empty image means the background is no longer required
865 controlImpl.ClearBackground();
870 case Toolkit::Control::Property::KEY_INPUT_FOCUS:
872 if ( value.Get< bool >() )
874 controlImpl.SetKeyInputFocus();
878 controlImpl.ClearKeyInputFocus();
883 case Toolkit::Control::Property::BACKGROUND:
887 const Property::Map* map = value.GetMap();
888 if( map && !map->Empty() )
890 controlImpl.SetBackground( *map );
892 else if( value.Get( url ) )
894 // don't know the size to load
895 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( url, ImageDimensions() );
898 controlImpl.mImpl->RegisterVisual( Toolkit::Control::Property::BACKGROUND, visual, DepthIndex::BACKGROUND );
901 else if( value.Get( color ) )
903 controlImpl.SetBackgroundColor(color);
907 // The background is an empty property map, so we should clear the background
908 controlImpl.ClearBackground();
913 case Toolkit::DevelControl::Property::TOOLTIP:
915 TooltipPtr& tooltipPtr = controlImpl.mImpl->mTooltip;
918 tooltipPtr = Tooltip::New( control );
920 tooltipPtr->SetProperties( value );
926 Property::Value Control::Impl::GetProperty( BaseObject* object, Property::Index index )
928 Property::Value value;
930 Toolkit::Control control = Toolkit::Control::DownCast( BaseHandle( object ) );
934 Control& controlImpl( GetImplementation( control ) );
938 case Toolkit::Control::Property::STYLE_NAME:
940 value = controlImpl.GetStyleName();
944 case Toolkit::DevelControl::Property::STATE:
946 value = controlImpl.mImpl->mState;
950 case Toolkit::DevelControl::Property::SUB_STATE:
952 value = controlImpl.mImpl->mSubStateName;
956 case Toolkit::DevelControl::Property::LEFT_FOCUSABLE_ACTOR_ID:
958 value = controlImpl.mImpl->mLeftFocusableActorId;
962 case Toolkit::DevelControl::Property::RIGHT_FOCUSABLE_ACTOR_ID:
964 value = controlImpl.mImpl->mRightFocusableActorId;
968 case Toolkit::DevelControl::Property::UP_FOCUSABLE_ACTOR_ID:
970 value = controlImpl.mImpl->mUpFocusableActorId;
974 case Toolkit::DevelControl::Property::DOWN_FOCUSABLE_ACTOR_ID:
976 value = controlImpl.mImpl->mDownFocusableActorId;
980 case Toolkit::Control::Property::BACKGROUND_COLOR:
982 DALI_LOG_WARNING( "BACKGROUND_COLOR property is deprecated. Use BACKGROUND property instead\n" );
983 value = controlImpl.GetBackgroundColor();
987 case Toolkit::Control::Property::BACKGROUND_IMAGE:
989 DALI_LOG_WARNING( "BACKGROUND_IMAGE property is deprecated. Use BACKGROUND property instead\n" );
991 Toolkit::Visual::Base visual = controlImpl.mImpl->GetVisual( Toolkit::Control::Property::BACKGROUND );
994 visual.CreatePropertyMap( map );
1000 case Toolkit::Control::Property::KEY_INPUT_FOCUS:
1002 value = controlImpl.HasKeyInputFocus();
1006 case Toolkit::Control::Property::BACKGROUND:
1009 Toolkit::Visual::Base visual = controlImpl.mImpl->GetVisual( Toolkit::Control::Property::BACKGROUND );
1012 visual.CreatePropertyMap( map );
1019 case Toolkit::DevelControl::Property::TOOLTIP:
1022 if( controlImpl.mImpl->mTooltip )
1024 controlImpl.mImpl->mTooltip->CreatePropertyMap( map );
1037 void Control::Impl::CopyInstancedProperties( RegisteredVisualContainer& visuals, Dictionary<Property::Map>& instancedProperties )
1039 for(RegisteredVisualContainer::Iterator iter = visuals.Begin(); iter!= visuals.End(); iter++)
1041 if( (*iter)->visual )
1043 Property::Map instanceMap;
1044 Toolkit::GetImplementation((*iter)->visual).CreateInstancePropertyMap(instanceMap);
1045 instancedProperties.Add( (*iter)->visual.GetName(), instanceMap );
1051 void Control::Impl::RemoveVisual( RegisteredVisualContainer& visuals, const std::string& visualName )
1053 Actor self( mControlImpl.Self() );
1055 for ( RegisteredVisualContainer::Iterator visualIter = visuals.Begin();
1056 visualIter != visuals.End(); ++visualIter )
1058 Toolkit::Visual::Base visual = (*visualIter)->visual;
1059 if( visual && visual.GetName() == visualName )
1061 Toolkit::GetImplementation(visual).SetOffStage( self );
1062 (*visualIter)->visual.Reset();
1063 visuals.Erase( visualIter );
1069 void Control::Impl::RemoveVisuals( RegisteredVisualContainer& visuals, DictionaryKeys& removeVisuals )
1071 Actor self( mControlImpl.Self() );
1072 for( DictionaryKeys::iterator iter = removeVisuals.begin(); iter != removeVisuals.end(); ++iter )
1074 const std::string visualName = *iter;
1075 RemoveVisual( visuals, visualName );
1079 void Control::Impl::RecreateChangedVisuals( Dictionary<Property::Map>& stateVisualsToChange,
1080 Dictionary<Property::Map>& instancedProperties )
1082 Dali::CustomActor handle( mControlImpl.GetOwner() );
1083 for( Dictionary<Property::Map>::iterator iter = stateVisualsToChange.Begin();
1084 iter != stateVisualsToChange.End(); ++iter )
1086 const std::string& visualName = (*iter).key;
1087 const Property::Map& toMap = (*iter).entry;
1089 // is it a candidate for re-creation?
1090 bool recreate = false;
1092 Toolkit::Visual::Base visual = GetVisualByName( mVisuals, visualName );
1095 Property::Map fromMap;
1096 visual.CreatePropertyMap( fromMap );
1098 Toolkit::Visual::Type fromType = GetVisualTypeFromMap( fromMap );
1099 Toolkit::Visual::Type toType = GetVisualTypeFromMap( toMap );
1101 if( fromType != toType )
1107 if( fromType == Toolkit::Visual::IMAGE || fromType == Toolkit::Visual::N_PATCH
1108 || fromType == Toolkit::Visual::SVG || fromType == Toolkit::Visual::ANIMATED_IMAGE )
1110 Property::Value* fromUrl = fromMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
1111 Property::Value* toUrl = toMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
1113 if( fromUrl && toUrl )
1115 std::string fromUrlString;
1116 std::string toUrlString;
1117 fromUrl->Get(fromUrlString);
1118 toUrl->Get(toUrlString);
1120 if( fromUrlString != toUrlString )
1128 const Property::Map* instancedMap = instancedProperties.FindConst( visualName );
1129 if( recreate || instancedMap )
1131 RemoveVisual( mVisuals, visualName );
1132 Style::ApplyVisual( handle, visualName, toMap, instancedMap );
1136 // @todo check to see if we can apply toMap without recreating the visual
1137 // e.g. by setting only animatable properties
1138 // For now, recreate all visuals, but merge in instance data.
1139 RemoveVisual( mVisuals, visualName );
1140 Style::ApplyVisual( handle, visualName, toMap, instancedMap );
1146 void Control::Impl::ReplaceStateVisualsAndProperties( const StylePtr oldState, const StylePtr newState, const std::string& subState )
1148 // Collect all old visual names
1149 DictionaryKeys stateVisualsToRemove;
1152 oldState->visuals.GetKeys( stateVisualsToRemove );
1153 if( ! subState.empty() )
1155 const StylePtr* oldSubState = oldState->subStates.FindConst(subState);
1158 DictionaryKeys subStateVisualsToRemove;
1159 (*oldSubState)->visuals.GetKeys( subStateVisualsToRemove );
1160 Merge( stateVisualsToRemove, subStateVisualsToRemove );
1165 // Collect all new visual properties
1166 Dictionary<Property::Map> stateVisualsToAdd;
1169 stateVisualsToAdd = newState->visuals;
1170 if( ! subState.empty() )
1172 const StylePtr* newSubState = newState->subStates.FindConst(subState);
1175 stateVisualsToAdd.Merge( (*newSubState)->visuals );
1180 // If a name is in both add/remove, move it to change list.
1181 Dictionary<Property::Map> stateVisualsToChange;
1182 FindChangableVisuals( stateVisualsToAdd, stateVisualsToChange, stateVisualsToRemove);
1184 // Copy instanced properties (e.g. text label) of current visuals
1185 Dictionary<Property::Map> instancedProperties;
1186 CopyInstancedProperties( mVisuals, instancedProperties );
1188 // For each visual in remove list, remove from mVisuals
1189 RemoveVisuals( mVisuals, stateVisualsToRemove );
1191 // For each visual in add list, create and add to mVisuals
1192 Dali::CustomActor handle( mControlImpl.GetOwner() );
1193 Style::ApplyVisuals( handle, stateVisualsToAdd, instancedProperties );
1195 // For each visual in change list, if it requires a new visual,
1196 // remove old visual, create and add to mVisuals
1197 RecreateChangedVisuals( stateVisualsToChange, instancedProperties );
1200 void Control::Impl::SetState( DevelControl::State newState, bool withTransitions )
1202 DevelControl::State oldState = mState;
1203 Dali::CustomActor handle( mControlImpl.GetOwner() );
1204 DALI_LOG_INFO(gLogFilter, Debug::Concise, "Control::Impl::SetState: %s\n",
1205 (mState == DevelControl::NORMAL ? "NORMAL" :(
1206 mState == DevelControl::FOCUSED ?"FOCUSED" : (
1207 mState == DevelControl::DISABLED?"DISABLED":"NONE" ))));
1209 if( mState != newState )
1211 // If mState was Disabled, and new state is Focused, should probably
1212 // store that fact, e.g. in another property that FocusManager can access.
1215 // Trigger state change and transitions
1216 // Apply new style, if stylemanager is available
1217 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
1220 const StylePtr stylePtr = GetImpl( styleManager ).GetRecordedStyle( Toolkit::Control( mControlImpl.GetOwner() ) );
1224 std::string oldStateName = Scripting::GetEnumerationName< Toolkit::DevelControl::State >( oldState, ControlStateTable, ControlStateTableCount );
1225 std::string newStateName = Scripting::GetEnumerationName< Toolkit::DevelControl::State >( newState, ControlStateTable, ControlStateTableCount );
1227 const StylePtr* newStateStyle = stylePtr->subStates.Find( newStateName );
1228 const StylePtr* oldStateStyle = stylePtr->subStates.Find( oldStateName );
1229 if( oldStateStyle && newStateStyle )
1231 // Only change if both state styles exist
1232 ReplaceStateVisualsAndProperties( *oldStateStyle, *newStateStyle, mSubStateName );
1239 void Control::Impl::SetSubState( const std::string& subStateName, bool withTransitions )
1241 if( mSubStateName != subStateName )
1243 // Get existing sub-state visuals, and unregister them
1244 Dali::CustomActor handle( mControlImpl.GetOwner() );
1246 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
1249 const StylePtr stylePtr = GetImpl( styleManager ).GetRecordedStyle( Toolkit::Control( mControlImpl.GetOwner() ) );
1253 std::string stateName = Scripting::GetEnumerationName< Toolkit::DevelControl::State >( mState, ControlStateTable, ControlStateTableCount );
1255 const StylePtr* state = stylePtr->subStates.Find( stateName );
1258 StylePtr stateStyle(*state);
1260 const StylePtr* newStateStyle = stateStyle->subStates.Find( subStateName );
1261 const StylePtr* oldStateStyle = stateStyle->subStates.Find( mSubStateName );
1262 if( oldStateStyle && newStateStyle )
1265 ReplaceStateVisualsAndProperties( *oldStateStyle, *newStateStyle, empty );
1271 mSubStateName = subStateName;
1275 void Control::Impl::OnStageDisconnection()
1277 Actor self = mControlImpl.Self();
1279 // Any visuals set for replacement but not yet ready should still be registered.
1280 // Reason: If a request was made to register a new visual but the control removed from stage before visual was ready
1281 // then when this control appears back on stage it should use that new visual.
1283 // Iterate through all registered visuals and set off stage
1284 SetVisualsOffStage( mVisuals, self );
1286 // Visuals pending replacement can now be taken out of the removal list and set off stage
1287 // Iterate through all replacement visuals and add to a move queue then set off stage
1288 for( auto removalIter = mRemoveVisuals.Begin(), end = mRemoveVisuals.End(); removalIter != end; removalIter++ )
1290 Toolkit::GetImplementation((*removalIter)->visual).SetOffStage( self );
1293 for( auto replacedIter = mVisuals.Begin(), end = mVisuals.End(); replacedIter != end; replacedIter++ )
1295 (*replacedIter)->pending = false;
1298 mRemoveVisuals.Clear();
1301 } // namespace Internal
1303 } // namespace Toolkit