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, "margin", Toolkit::Control::Property::MARGIN, Property::EXTENTS, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
306 const PropertyRegistration Control::Impl::PROPERTY_7( typeRegistration, "padding", Toolkit::Control::Property::PADDING, Property::EXTENTS, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
307 const PropertyRegistration Control::Impl::PROPERTY_8( typeRegistration, "tooltip", Toolkit::DevelControl::Property::TOOLTIP, Property::MAP, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
308 const PropertyRegistration Control::Impl::PROPERTY_9( typeRegistration, "state", Toolkit::DevelControl::Property::STATE, Property::STRING, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
309 const PropertyRegistration Control::Impl::PROPERTY_10( typeRegistration, "subState", Toolkit::DevelControl::Property::SUB_STATE, Property::STRING, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
310 const PropertyRegistration Control::Impl::PROPERTY_11( typeRegistration, "leftFocusableActorId", Toolkit::DevelControl::Property::LEFT_FOCUSABLE_ACTOR_ID, Property::INTEGER, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
311 const PropertyRegistration Control::Impl::PROPERTY_12( typeRegistration, "rightFocusableActorId", Toolkit::DevelControl::Property::RIGHT_FOCUSABLE_ACTOR_ID,Property::INTEGER, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
312 const PropertyRegistration Control::Impl::PROPERTY_13( typeRegistration, "upFocusableActorId", Toolkit::DevelControl::Property::UP_FOCUSABLE_ACTOR_ID, Property::INTEGER, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
313 const PropertyRegistration Control::Impl::PROPERTY_14( typeRegistration, "downFocusableActorId", Toolkit::DevelControl::Property::DOWN_FOCUSABLE_ACTOR_ID, Property::INTEGER, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
316 Control::Impl::Impl( Control& controlImpl )
317 : mControlImpl( controlImpl ),
318 mState( Toolkit::DevelControl::NORMAL ),
320 mLeftFocusableActorId( -1 ),
321 mRightFocusableActorId( -1 ),
322 mUpFocusableActorId( -1 ),
323 mDownFocusableActorId( -1 ),
325 mBackgroundColor(Color::TRANSPARENT),
326 mStartingPinchScale( NULL ),
327 mMargin( 0, 0, 0, 0 ),
328 mPadding( 0, 0, 0, 0 ),
330 mPinchGestureDetector(),
331 mPanGestureDetector(),
332 mTapGestureDetector(),
333 mLongPressGestureDetector(),
334 mFlags( Control::ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) ),
335 mIsKeyboardNavigationSupported( false ),
336 mIsKeyboardFocusGroup( false )
341 Control::Impl::~Impl()
343 // All gesture detectors will be destroyed so no need to disconnect.
344 delete mStartingPinchScale;
347 Control::Impl& Control::Impl::Get( Internal::Control& internalControl )
349 return *internalControl.mImpl;
352 const Control::Impl& Control::Impl::Get( const Internal::Control& internalControl )
354 return *internalControl.mImpl;
357 // Gesture Detection Methods
358 void Control::Impl::PinchDetected(Actor actor, const PinchGesture& pinch)
360 mControlImpl.OnPinch(pinch);
363 void Control::Impl::PanDetected(Actor actor, const PanGesture& pan)
365 mControlImpl.OnPan(pan);
368 void Control::Impl::TapDetected(Actor actor, const TapGesture& tap)
370 mControlImpl.OnTap(tap);
373 void Control::Impl::LongPressDetected(Actor actor, const LongPressGesture& longPress)
375 mControlImpl.OnLongPress(longPress);
378 void Control::Impl::RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual )
380 RegisterVisual( index, visual, VisualState::ENABLED, DepthIndexValue::NOT_SET );
383 void Control::Impl::RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, int depthIndex )
385 RegisterVisual( index, visual, VisualState::ENABLED, DepthIndexValue::SET, depthIndex );
388 void Control::Impl::RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, bool enabled )
390 RegisterVisual( index, visual, ( enabled ? VisualState::ENABLED : VisualState::DISABLED ), DepthIndexValue::NOT_SET );
393 void Control::Impl::RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, bool enabled, int depthIndex )
395 RegisterVisual( index, visual, ( enabled ? VisualState::ENABLED : VisualState::DISABLED ), DepthIndexValue::SET, depthIndex );
398 void Control::Impl::RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, VisualState::Type enabled, DepthIndexValue::Type depthIndexValueSet, int depthIndex )
400 DALI_LOG_INFO( gLogFilter, Debug::Concise, "RegisterVisual:%d \n", index );
402 bool visualReplaced ( false );
403 Actor self = mControlImpl.Self();
405 // Set the depth index, if not set by caller this will be either the current visual depth, max depth of all visuals
407 int requiredDepthIndex = visual.GetDepthIndex();
409 if( depthIndexValueSet == DepthIndexValue::SET )
411 requiredDepthIndex = depthIndex;
414 // Visual replacement, existing visual should only be removed from stage when replacement ready.
415 if( !mVisuals.Empty() )
417 RegisteredVisualContainer::Iterator registeredVisualsiter;
418 // Check if visual (index) is already registered, this is the current visual.
419 if( FindVisual( index, mVisuals, registeredVisualsiter ) )
421 Toolkit::Visual::Base& currentRegisteredVisual = (*registeredVisualsiter)->visual;
422 if( currentRegisteredVisual )
424 // Store current visual depth index as may need to set the replacement visual to same depth
425 const int currentDepthIndex = (*registeredVisualsiter)->visual.GetDepthIndex();
427 // No longer required to know if the replaced visual's resources are ready
428 StopObservingVisual( currentRegisteredVisual );
430 // If control staged and visual enabled then visuals will be swapped once ready
431 if( self.OnStage() && enabled )
433 // Check if visual is currently in the process of being replaced ( is in removal container )
434 RegisteredVisualContainer::Iterator visualQueuedForRemoval;
435 if ( FindVisual( index, mRemoveVisuals, visualQueuedForRemoval ) )
437 // Visual with same index is already in removal container so current visual pending
438 // Only the the last requested visual will be displayed so remove current visual which is staged but not ready.
439 Toolkit::GetImplementation( currentRegisteredVisual ).SetOffStage( self );
440 mVisuals.Erase( registeredVisualsiter );
444 // current visual not already in removal container so add now.
445 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "RegisterVisual Move current registered visual to removal Queue: %d \n", index );
446 MoveVisual( registeredVisualsiter, mVisuals, mRemoveVisuals );
451 // Control not staged or visual disabled so can just erase from registered visuals and new visual will be added later.
452 mVisuals.Erase( registeredVisualsiter );
455 // 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
456 if( ( depthIndexValueSet == DepthIndexValue::NOT_SET ) &&
457 ( visual.GetDepthIndex() == 0 ) )
459 requiredDepthIndex = currentDepthIndex;
463 visualReplaced = true;
467 // If not set, set the name of the visual to the same name as the control's property.
468 // ( If the control has been type registered )
469 if( visual.GetName().empty() )
473 std::string visualName = self.GetPropertyName( index );
474 if( !visualName.empty() )
476 DALI_LOG_INFO( gLogFilter, Debug::Concise, "Setting visual name for property %d to %s\n",
477 index, visualName.c_str() );
478 visual.SetName( visualName );
481 catch( Dali::DaliException e )
483 DALI_LOG_WARNING( "Attempting to register visual without a registered property, index: %d\n", index );
487 if( !visualReplaced ) // New registration entry
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 Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
526 // Put on stage if enabled and the control is already on the stage
527 if( ( enabled == VisualState::ENABLED ) && self.OnStage() )
529 visualImpl.SetOnStage( self );
531 else if( visualImpl.IsResourceReady() ) // When not being staged, check if visual already 'ResourceReady' before it was Registered. ( Resource may have been loaded already )
533 ResourceReady( visualImpl );
538 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::RegisterVisual() Registered %s(%d), enabled:%s\n", visual.GetName().c_str(), index, enabled?"true":"false" );
541 void Control::Impl::UnregisterVisual( Property::Index index )
543 RegisteredVisualContainer::Iterator iter;
544 if ( FindVisual( index, mVisuals, iter ) )
546 // stop observing visual
547 StopObservingVisual( (*iter)->visual );
549 Actor self( mControlImpl.Self() );
550 Toolkit::GetImplementation((*iter)->visual).SetOffStage( self );
551 (*iter)->visual.Reset();
552 mVisuals.Erase( iter );
555 if( FindVisual( index, mRemoveVisuals, iter ) )
557 Actor self( mControlImpl.Self() );
558 Toolkit::GetImplementation( (*iter)->visual ).SetOffStage( self );
559 (*iter)->pending = false;
560 (*iter)->visual.Reset();
561 mRemoveVisuals.Erase( iter );
565 Toolkit::Visual::Base Control::Impl::GetVisual( Property::Index index ) const
567 RegisteredVisualContainer::Iterator iter;
568 if ( FindVisual( index, mVisuals, iter ) )
570 return (*iter)->visual;
573 return Toolkit::Visual::Base();
576 void Control::Impl::EnableVisual( Property::Index index, bool enable )
578 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::EnableVisual Visual (%d)\n", index);
580 RegisteredVisualContainer::Iterator iter;
581 if ( FindVisual( index, mVisuals, iter ) )
583 if ( (*iter)->enabled == enable )
585 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::EnableVisual Visual %s(%d) already %s\n", (*iter)->visual.GetName().c_str(), index, enable?"enabled":"disabled");
589 (*iter)->enabled = enable;
590 Actor parentActor = mControlImpl.Self();
591 if ( mControlImpl.Self().OnStage() ) // If control not on Stage then Visual will be added when StageConnection is called.
595 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::EnableVisual Setting %s(%d) on stage \n", (*iter)->visual.GetName().c_str(), index );
596 Toolkit::GetImplementation((*iter)->visual).SetOnStage( parentActor );
600 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::EnableVisual Setting %s(%d) off stage \n", (*iter)->visual.GetName().c_str(), index );
601 Toolkit::GetImplementation((*iter)->visual).SetOffStage( parentActor ); // No need to call if control not staged.
607 bool Control::Impl::IsVisualEnabled( Property::Index index ) const
609 RegisteredVisualContainer::Iterator iter;
610 if ( FindVisual( index, mVisuals, iter ) )
612 return (*iter)->enabled;
617 void Control::Impl::StopObservingVisual( Toolkit::Visual::Base& visual )
619 Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
621 // Stop observing the visual
622 visualImpl.RemoveResourceObserver( *this );
625 void Control::Impl::StartObservingVisual( Toolkit::Visual::Base& visual)
627 Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
629 // start observing the visual for resource ready
630 visualImpl.AddResourceObserver( *this );
633 // Called by a Visual when it's resource is ready
634 void Control::Impl::ResourceReady( Visual::Base& object)
636 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "ResourceReady replacements pending[%d]\n", mRemoveVisuals.Count() );
638 Actor self = mControlImpl.Self();
640 // A resource is ready, find resource in the registered visuals container and get its index
641 for( auto registeredIter = mVisuals.Begin(), end = mVisuals.End(); registeredIter != end; ++registeredIter )
643 Internal::Visual::Base& registeredVisualImpl = Toolkit::GetImplementation( (*registeredIter)->visual );
645 if( &object == ®isteredVisualImpl )
647 RegisteredVisualContainer::Iterator visualToRemoveIter;
648 // Find visual with the same index in the removal container
649 // Set if off stage as it's replacement is now ready.
650 // Remove if from removal list as now removed from stage.
651 // Set Pending flag on the ready visual to false as now ready.
652 if( FindVisual( (*registeredIter)->index, mRemoveVisuals, visualToRemoveIter ) )
654 (*registeredIter)->pending = false;
655 Toolkit::GetImplementation( (*visualToRemoveIter)->visual ).SetOffStage( self );
656 mRemoveVisuals.Erase( visualToRemoveIter );
662 // A visual is ready so control may need relayouting if staged
663 if ( self.OnStage() )
665 mControlImpl.RelayoutRequest();
668 // Emit signal if all enabled visuals registered by the control are ready.
669 if( IsResourceReady() )
671 Dali::Toolkit::Control handle( mControlImpl.GetOwner() );
672 mResourceReadySignal.Emit( handle );
676 bool Control::Impl::IsResourceReady() const
678 // Iterate through and check all the enabled visuals are ready
679 for( auto visualIter = mVisuals.Begin();
680 visualIter != mVisuals.End(); ++visualIter )
682 const Toolkit::Visual::Base visual = (*visualIter)->visual;
683 const Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
685 // one of the enabled visuals is not ready
686 if( !visualImpl.IsResourceReady() && (*visualIter)->enabled )
694 Toolkit::Visual::ResourceStatus Control::Impl::GetVisualResourceStatus( Property::Index index ) const
696 RegisteredVisualContainer::Iterator iter;
697 if ( FindVisual( index, mVisuals, iter ) )
699 const Toolkit::Visual::Base visual = (*iter)->visual;
700 const Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
701 return visualImpl.GetResourceStatus( );
704 return Toolkit::Visual::ResourceStatus::PREPARING;
707 Dali::Animation Control::Impl::CreateTransition( const Toolkit::TransitionData& handle )
709 Dali::Animation transition;
710 const Internal::TransitionData& transitionData = Toolkit::GetImplementation( handle );
712 if( transitionData.Count() > 0 )
714 // Setup a Transition from TransitionData.
715 TransitionData::Iterator end = transitionData.End();
716 for( TransitionData::Iterator iter = transitionData.Begin() ;
717 iter != end; ++iter )
719 TransitionData::Animator* animator = (*iter);
721 Toolkit::Visual::Base visual = GetVisualByName( mVisuals, animator->objectName );
725 #if defined(DEBUG_ENABLED)
726 Dali::TypeInfo typeInfo;
727 ControlWrapper* controlWrapperImpl = dynamic_cast<ControlWrapper*>(&mControlImpl);
728 if( controlWrapperImpl )
730 typeInfo = controlWrapperImpl->GetTypeInfo();
733 DALI_LOG_INFO( gLogFilter, Debug::Concise, "CreateTransition: Found %s visual for %s\n",
734 visual.GetName().c_str(), typeInfo?typeInfo.GetName().c_str():"Unknown" );
736 Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
737 visualImpl.AnimateProperty( transition, *animator );
741 DALI_LOG_INFO( gLogFilter, Debug::Concise, "CreateTransition: Could not find visual. Trying actors");
742 // Otherwise, try any actor children of control (Including the control)
743 Actor child = mControlImpl.Self().FindChildByName( animator->objectName );
746 Property::Index propertyIndex = DevelHandle::GetPropertyIndex( child, animator->propertyKey );
747 if( propertyIndex != Property::INVALID_INDEX )
749 if( animator->animate == false )
751 if( animator->targetValue.GetType() != Property::NONE )
753 child.SetProperty( propertyIndex, animator->targetValue );
756 else // animate the property
758 if( animator->initialValue.GetType() != Property::NONE )
760 child.SetProperty( propertyIndex, animator->initialValue );
765 transition = Dali::Animation::New( 0.1f );
768 transition.AnimateTo( Property( child, propertyIndex ),
769 animator->targetValue,
770 animator->alphaFunction,
771 TimePeriod( animator->timePeriodDelay,
772 animator->timePeriodDuration ) );
783 void Control::Impl::DoAction( Dali::Property::Index visualIndex, Dali::Property::Index actionId, const Dali::Property::Value attributes )
785 RegisteredVisualContainer::Iterator iter;
786 if ( FindVisual( visualIndex, mVisuals, iter ) )
788 Toolkit::GetImplementation((*iter)->visual).DoAction( actionId, attributes );
792 void Control::Impl::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
794 Toolkit::Control control = Toolkit::Control::DownCast( BaseHandle( object ) );
798 Control& controlImpl( GetImplementation( control ) );
802 case Toolkit::Control::Property::STYLE_NAME:
804 controlImpl.SetStyleName( value.Get< std::string >() );
808 case Toolkit::DevelControl::Property::STATE:
810 bool withTransitions=true;
811 const Property::Value* valuePtr=&value;
812 Property::Map* map = value.GetMap();
815 Property::Value* value2 = map->Find("withTransitions");
818 withTransitions = value2->Get<bool>();
821 valuePtr = map->Find("state");
826 Toolkit::DevelControl::State state( controlImpl.mImpl->mState );
827 if( Scripting::GetEnumerationProperty< Toolkit::DevelControl::State >( *valuePtr, ControlStateTable, ControlStateTableCount, state ) )
829 controlImpl.mImpl->SetState( state, withTransitions );
835 case Toolkit::DevelControl::Property::SUB_STATE:
837 std::string subState;
838 if( value.Get( subState ) )
840 controlImpl.mImpl->SetSubState( subState );
845 case Toolkit::DevelControl::Property::LEFT_FOCUSABLE_ACTOR_ID:
848 if( value.Get( focusId ) )
850 controlImpl.mImpl->mLeftFocusableActorId = focusId;
855 case Toolkit::DevelControl::Property::RIGHT_FOCUSABLE_ACTOR_ID:
858 if( value.Get( focusId ) )
860 controlImpl.mImpl->mRightFocusableActorId = focusId;
865 case Toolkit::DevelControl::Property::UP_FOCUSABLE_ACTOR_ID:
868 if( value.Get( focusId ) )
870 controlImpl.mImpl->mUpFocusableActorId = focusId;
875 case Toolkit::DevelControl::Property::DOWN_FOCUSABLE_ACTOR_ID:
878 if( value.Get( focusId ) )
880 controlImpl.mImpl->mDownFocusableActorId = focusId;
885 case Toolkit::Control::Property::BACKGROUND_COLOR:
887 DALI_LOG_WARNING( "BACKGROUND_COLOR property is deprecated. Use BACKGROUND property instead\n" );
888 controlImpl.SetBackgroundColor( value.Get< Vector4 >() );
892 case Toolkit::Control::Property::BACKGROUND_IMAGE:
894 DALI_LOG_WARNING( "BACKGROUND_IMAGE property is deprecated. Use BACKGROUND property instead\n" );
895 Image image = Scripting::NewImage( value );
898 controlImpl.SetBackgroundImage( image );
902 // An empty image means the background is no longer required
903 controlImpl.ClearBackground();
908 case Toolkit::Control::Property::KEY_INPUT_FOCUS:
910 if ( value.Get< bool >() )
912 controlImpl.SetKeyInputFocus();
916 controlImpl.ClearKeyInputFocus();
921 case Toolkit::Control::Property::BACKGROUND:
925 const Property::Map* map = value.GetMap();
926 if( map && !map->Empty() )
928 controlImpl.SetBackground( *map );
930 else if( value.Get( url ) )
932 // don't know the size to load
933 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( url, ImageDimensions() );
936 controlImpl.mImpl->RegisterVisual( Toolkit::Control::Property::BACKGROUND, visual, DepthIndex::BACKGROUND );
939 else if( value.Get( color ) )
941 controlImpl.SetBackgroundColor(color);
945 // The background is an empty property map, so we should clear the background
946 controlImpl.ClearBackground();
951 case Toolkit::Control::Property::MARGIN:
954 if( value.Get( margin ) )
956 controlImpl.mImpl->SetMargin( margin );
961 case Toolkit::Control::Property::PADDING:
964 if( value.Get( padding ) )
966 controlImpl.mImpl->SetPadding( padding );
971 case Toolkit::DevelControl::Property::TOOLTIP:
973 TooltipPtr& tooltipPtr = controlImpl.mImpl->mTooltip;
976 tooltipPtr = Tooltip::New( control );
978 tooltipPtr->SetProperties( value );
986 Property::Value Control::Impl::GetProperty( BaseObject* object, Property::Index index )
988 Property::Value value;
990 Toolkit::Control control = Toolkit::Control::DownCast( BaseHandle( object ) );
994 Control& controlImpl( GetImplementation( control ) );
998 case Toolkit::Control::Property::STYLE_NAME:
1000 value = controlImpl.GetStyleName();
1004 case Toolkit::DevelControl::Property::STATE:
1006 value = controlImpl.mImpl->mState;
1010 case Toolkit::DevelControl::Property::SUB_STATE:
1012 value = controlImpl.mImpl->mSubStateName;
1016 case Toolkit::DevelControl::Property::LEFT_FOCUSABLE_ACTOR_ID:
1018 value = controlImpl.mImpl->mLeftFocusableActorId;
1022 case Toolkit::DevelControl::Property::RIGHT_FOCUSABLE_ACTOR_ID:
1024 value = controlImpl.mImpl->mRightFocusableActorId;
1028 case Toolkit::DevelControl::Property::UP_FOCUSABLE_ACTOR_ID:
1030 value = controlImpl.mImpl->mUpFocusableActorId;
1034 case Toolkit::DevelControl::Property::DOWN_FOCUSABLE_ACTOR_ID:
1036 value = controlImpl.mImpl->mDownFocusableActorId;
1040 case Toolkit::Control::Property::BACKGROUND_COLOR:
1042 DALI_LOG_WARNING( "BACKGROUND_COLOR property is deprecated. Use BACKGROUND property instead\n" );
1043 value = controlImpl.GetBackgroundColor();
1047 case Toolkit::Control::Property::BACKGROUND_IMAGE:
1049 DALI_LOG_WARNING( "BACKGROUND_IMAGE property is deprecated. Use BACKGROUND property instead\n" );
1051 Toolkit::Visual::Base visual = controlImpl.mImpl->GetVisual( Toolkit::Control::Property::BACKGROUND );
1054 visual.CreatePropertyMap( map );
1060 case Toolkit::Control::Property::KEY_INPUT_FOCUS:
1062 value = controlImpl.HasKeyInputFocus();
1066 case Toolkit::Control::Property::BACKGROUND:
1069 Toolkit::Visual::Base visual = controlImpl.mImpl->GetVisual( Toolkit::Control::Property::BACKGROUND );
1072 visual.CreatePropertyMap( map );
1079 case Toolkit::Control::Property::MARGIN:
1081 value = controlImpl.mImpl->GetMargin();
1085 case Toolkit::Control::Property::PADDING:
1087 value = controlImpl.mImpl->GetPadding();
1091 case Toolkit::DevelControl::Property::TOOLTIP:
1094 if( controlImpl.mImpl->mTooltip )
1096 controlImpl.mImpl->mTooltip->CreatePropertyMap( map );
1108 void Control::Impl::CopyInstancedProperties( RegisteredVisualContainer& visuals, Dictionary<Property::Map>& instancedProperties )
1110 for(RegisteredVisualContainer::Iterator iter = visuals.Begin(); iter!= visuals.End(); iter++)
1112 if( (*iter)->visual )
1114 Property::Map instanceMap;
1115 Toolkit::GetImplementation((*iter)->visual).CreateInstancePropertyMap(instanceMap);
1116 instancedProperties.Add( (*iter)->visual.GetName(), instanceMap );
1122 void Control::Impl::RemoveVisual( RegisteredVisualContainer& visuals, const std::string& visualName )
1124 Actor self( mControlImpl.Self() );
1126 for ( RegisteredVisualContainer::Iterator visualIter = visuals.Begin();
1127 visualIter != visuals.End(); ++visualIter )
1129 Toolkit::Visual::Base visual = (*visualIter)->visual;
1130 if( visual && visual.GetName() == visualName )
1132 Toolkit::GetImplementation(visual).SetOffStage( self );
1133 (*visualIter)->visual.Reset();
1134 visuals.Erase( visualIter );
1140 void Control::Impl::RemoveVisuals( RegisteredVisualContainer& visuals, DictionaryKeys& removeVisuals )
1142 Actor self( mControlImpl.Self() );
1143 for( DictionaryKeys::iterator iter = removeVisuals.begin(); iter != removeVisuals.end(); ++iter )
1145 const std::string visualName = *iter;
1146 RemoveVisual( visuals, visualName );
1150 void Control::Impl::RecreateChangedVisuals( Dictionary<Property::Map>& stateVisualsToChange,
1151 Dictionary<Property::Map>& instancedProperties )
1153 Dali::CustomActor handle( mControlImpl.GetOwner() );
1154 for( Dictionary<Property::Map>::iterator iter = stateVisualsToChange.Begin();
1155 iter != stateVisualsToChange.End(); ++iter )
1157 const std::string& visualName = (*iter).key;
1158 const Property::Map& toMap = (*iter).entry;
1160 // is it a candidate for re-creation?
1161 bool recreate = false;
1163 Toolkit::Visual::Base visual = GetVisualByName( mVisuals, visualName );
1166 Property::Map fromMap;
1167 visual.CreatePropertyMap( fromMap );
1169 Toolkit::Visual::Type fromType = GetVisualTypeFromMap( fromMap );
1170 Toolkit::Visual::Type toType = GetVisualTypeFromMap( toMap );
1172 if( fromType != toType )
1178 if( fromType == Toolkit::Visual::IMAGE || fromType == Toolkit::Visual::N_PATCH
1179 || fromType == Toolkit::Visual::SVG || fromType == Toolkit::Visual::ANIMATED_IMAGE )
1181 Property::Value* fromUrl = fromMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
1182 Property::Value* toUrl = toMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
1184 if( fromUrl && toUrl )
1186 std::string fromUrlString;
1187 std::string toUrlString;
1188 fromUrl->Get(fromUrlString);
1189 toUrl->Get(toUrlString);
1191 if( fromUrlString != toUrlString )
1199 const Property::Map* instancedMap = instancedProperties.FindConst( visualName );
1200 if( recreate || instancedMap )
1202 RemoveVisual( mVisuals, visualName );
1203 Style::ApplyVisual( handle, visualName, toMap, instancedMap );
1207 // @todo check to see if we can apply toMap without recreating the visual
1208 // e.g. by setting only animatable properties
1209 // For now, recreate all visuals, but merge in instance data.
1210 RemoveVisual( mVisuals, visualName );
1211 Style::ApplyVisual( handle, visualName, toMap, instancedMap );
1217 void Control::Impl::ReplaceStateVisualsAndProperties( const StylePtr oldState, const StylePtr newState, const std::string& subState )
1219 // Collect all old visual names
1220 DictionaryKeys stateVisualsToRemove;
1223 oldState->visuals.GetKeys( stateVisualsToRemove );
1224 if( ! subState.empty() )
1226 const StylePtr* oldSubState = oldState->subStates.FindConst(subState);
1229 DictionaryKeys subStateVisualsToRemove;
1230 (*oldSubState)->visuals.GetKeys( subStateVisualsToRemove );
1231 Merge( stateVisualsToRemove, subStateVisualsToRemove );
1236 // Collect all new visual properties
1237 Dictionary<Property::Map> stateVisualsToAdd;
1240 stateVisualsToAdd = newState->visuals;
1241 if( ! subState.empty() )
1243 const StylePtr* newSubState = newState->subStates.FindConst(subState);
1246 stateVisualsToAdd.Merge( (*newSubState)->visuals );
1251 // If a name is in both add/remove, move it to change list.
1252 Dictionary<Property::Map> stateVisualsToChange;
1253 FindChangableVisuals( stateVisualsToAdd, stateVisualsToChange, stateVisualsToRemove);
1255 // Copy instanced properties (e.g. text label) of current visuals
1256 Dictionary<Property::Map> instancedProperties;
1257 CopyInstancedProperties( mVisuals, instancedProperties );
1259 // For each visual in remove list, remove from mVisuals
1260 RemoveVisuals( mVisuals, stateVisualsToRemove );
1262 // For each visual in add list, create and add to mVisuals
1263 Dali::CustomActor handle( mControlImpl.GetOwner() );
1264 Style::ApplyVisuals( handle, stateVisualsToAdd, instancedProperties );
1266 // For each visual in change list, if it requires a new visual,
1267 // remove old visual, create and add to mVisuals
1268 RecreateChangedVisuals( stateVisualsToChange, instancedProperties );
1271 void Control::Impl::SetState( DevelControl::State newState, bool withTransitions )
1273 DevelControl::State oldState = mState;
1274 Dali::CustomActor handle( mControlImpl.GetOwner() );
1275 DALI_LOG_INFO(gLogFilter, Debug::Concise, "Control::Impl::SetState: %s\n",
1276 (mState == DevelControl::NORMAL ? "NORMAL" :(
1277 mState == DevelControl::FOCUSED ?"FOCUSED" : (
1278 mState == DevelControl::DISABLED?"DISABLED":"NONE" ))));
1280 if( mState != newState )
1282 // If mState was Disabled, and new state is Focused, should probably
1283 // store that fact, e.g. in another property that FocusManager can access.
1286 // Trigger state change and transitions
1287 // Apply new style, if stylemanager is available
1288 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
1291 const StylePtr stylePtr = GetImpl( styleManager ).GetRecordedStyle( Toolkit::Control( mControlImpl.GetOwner() ) );
1295 std::string oldStateName = Scripting::GetEnumerationName< Toolkit::DevelControl::State >( oldState, ControlStateTable, ControlStateTableCount );
1296 std::string newStateName = Scripting::GetEnumerationName< Toolkit::DevelControl::State >( newState, ControlStateTable, ControlStateTableCount );
1298 const StylePtr* newStateStyle = stylePtr->subStates.Find( newStateName );
1299 const StylePtr* oldStateStyle = stylePtr->subStates.Find( oldStateName );
1300 if( oldStateStyle && newStateStyle )
1302 // Only change if both state styles exist
1303 ReplaceStateVisualsAndProperties( *oldStateStyle, *newStateStyle, mSubStateName );
1310 void Control::Impl::SetSubState( const std::string& subStateName, bool withTransitions )
1312 if( mSubStateName != subStateName )
1314 // Get existing sub-state visuals, and unregister them
1315 Dali::CustomActor handle( mControlImpl.GetOwner() );
1317 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
1320 const StylePtr stylePtr = GetImpl( styleManager ).GetRecordedStyle( Toolkit::Control( mControlImpl.GetOwner() ) );
1324 std::string stateName = Scripting::GetEnumerationName< Toolkit::DevelControl::State >( mState, ControlStateTable, ControlStateTableCount );
1326 const StylePtr* state = stylePtr->subStates.Find( stateName );
1329 StylePtr stateStyle(*state);
1331 const StylePtr* newStateStyle = stateStyle->subStates.Find( subStateName );
1332 const StylePtr* oldStateStyle = stateStyle->subStates.Find( mSubStateName );
1333 if( oldStateStyle && newStateStyle )
1336 ReplaceStateVisualsAndProperties( *oldStateStyle, *newStateStyle, empty );
1342 mSubStateName = subStateName;
1346 void Control::Impl::OnStageDisconnection()
1348 Actor self = mControlImpl.Self();
1350 // Any visuals set for replacement but not yet ready should still be registered.
1351 // Reason: If a request was made to register a new visual but the control removed from stage before visual was ready
1352 // then when this control appears back on stage it should use that new visual.
1354 // Iterate through all registered visuals and set off stage
1355 SetVisualsOffStage( mVisuals, self );
1357 // Visuals pending replacement can now be taken out of the removal list and set off stage
1358 // Iterate through all replacement visuals and add to a move queue then set off stage
1359 for( auto removalIter = mRemoveVisuals.Begin(), end = mRemoveVisuals.End(); removalIter != end; removalIter++ )
1361 Toolkit::GetImplementation((*removalIter)->visual).SetOffStage( self );
1364 for( auto replacedIter = mVisuals.Begin(), end = mVisuals.End(); replacedIter != end; replacedIter++ )
1366 (*replacedIter)->pending = false;
1369 mRemoveVisuals.Clear();
1372 void Control::Impl::SetMargin( Extents margin )
1374 mControlImpl.mImpl->mMargin = margin;
1377 Extents Control::Impl::GetMargin() const
1379 return mControlImpl.mImpl->mMargin;
1382 void Control::Impl::SetPadding( Extents padding )
1384 mControlImpl.mImpl->mPadding = padding;
1387 Extents Control::Impl::GetPadding() const
1389 return mControlImpl.mImpl->mPadding;
1392 } // namespace Internal
1394 } // namespace Toolkit