2 * Copyright (c) 2018 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-toolkit/public-api/dali-toolkit-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/public-api/visuals/image-visual-properties.h>
35 #include <dali-toolkit/public-api/visuals/visual-properties.h>
36 #include <dali-toolkit/devel-api/controls/control-depth-index-ranges.h>
37 #include <dali-toolkit/devel-api/controls/control-devel.h>
38 #include <dali-toolkit/devel-api/controls/control-wrapper-impl.h>
39 #include <dali-toolkit/internal/styling/style-manager-impl.h>
40 #include <dali-toolkit/internal/visuals/visual-string-constants.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 ),
321 mLeftFocusableActorId( -1 ),
322 mRightFocusableActorId( -1 ),
323 mUpFocusableActorId( -1 ),
324 mDownFocusableActorId( -1 ),
326 mBackgroundColor(Color::TRANSPARENT),
327 mStartingPinchScale( NULL ),
328 mMargin( 0, 0, 0, 0 ),
329 mPadding( 0, 0, 0, 0 ),
331 mKeyInputFocusGainedSignal(),
332 mKeyInputFocusLostSignal(),
333 mResourceReadySignal(),
334 mPinchGestureDetector(),
335 mPanGestureDetector(),
336 mTapGestureDetector(),
337 mLongPressGestureDetector(),
339 mInputMethodContext(),
340 mFlags( Control::ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) ),
341 mIsKeyboardNavigationSupported( false ),
342 mIsKeyboardFocusGroup( false )
346 Control::Impl::~Impl()
348 // All gesture detectors will be destroyed so no need to disconnect.
349 delete mStartingPinchScale;
352 Control::Impl& Control::Impl::Get( Internal::Control& internalControl )
354 return *internalControl.mImpl;
357 const Control::Impl& Control::Impl::Get( const Internal::Control& internalControl )
359 return *internalControl.mImpl;
362 // Gesture Detection Methods
363 void Control::Impl::PinchDetected(Actor actor, const PinchGesture& pinch)
365 mControlImpl.OnPinch(pinch);
368 void Control::Impl::PanDetected(Actor actor, const PanGesture& pan)
370 mControlImpl.OnPan(pan);
373 void Control::Impl::TapDetected(Actor actor, const TapGesture& tap)
375 mControlImpl.OnTap(tap);
378 void Control::Impl::LongPressDetected(Actor actor, const LongPressGesture& longPress)
380 mControlImpl.OnLongPress(longPress);
383 void Control::Impl::RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual )
385 RegisterVisual( index, visual, VisualState::ENABLED, DepthIndexValue::NOT_SET );
388 void Control::Impl::RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, int depthIndex )
390 RegisterVisual( index, visual, VisualState::ENABLED, DepthIndexValue::SET, depthIndex );
393 void Control::Impl::RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, bool enabled )
395 RegisterVisual( index, visual, ( enabled ? VisualState::ENABLED : VisualState::DISABLED ), DepthIndexValue::NOT_SET );
398 void Control::Impl::RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, bool enabled, int depthIndex )
400 RegisterVisual( index, visual, ( enabled ? VisualState::ENABLED : VisualState::DISABLED ), DepthIndexValue::SET, depthIndex );
403 void Control::Impl::RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, VisualState::Type enabled, DepthIndexValue::Type depthIndexValueSet, int depthIndex )
405 DALI_LOG_INFO( gLogFilter, Debug::Concise, "RegisterVisual:%d \n", index );
407 bool visualReplaced ( false );
408 Actor self = mControlImpl.Self();
410 // Set the depth index, if not set by caller this will be either the current visual depth, max depth of all visuals
412 int requiredDepthIndex = visual.GetDepthIndex();
414 if( depthIndexValueSet == DepthIndexValue::SET )
416 requiredDepthIndex = depthIndex;
419 // Visual replacement, existing visual should only be removed from stage when replacement ready.
420 if( !mVisuals.Empty() )
422 RegisteredVisualContainer::Iterator registeredVisualsiter;
423 // Check if visual (index) is already registered, this is the current visual.
424 if( FindVisual( index, mVisuals, registeredVisualsiter ) )
426 Toolkit::Visual::Base& currentRegisteredVisual = (*registeredVisualsiter)->visual;
427 if( currentRegisteredVisual )
429 // Store current visual depth index as may need to set the replacement visual to same depth
430 const int currentDepthIndex = (*registeredVisualsiter)->visual.GetDepthIndex();
432 // No longer required to know if the replaced visual's resources are ready
433 StopObservingVisual( currentRegisteredVisual );
435 // If control staged and visual enabled then visuals will be swapped once ready
436 if( self.OnStage() && enabled )
438 // Check if visual is currently in the process of being replaced ( is in removal container )
439 RegisteredVisualContainer::Iterator visualQueuedForRemoval;
440 if ( FindVisual( index, mRemoveVisuals, visualQueuedForRemoval ) )
442 // Visual with same index is already in removal container so current visual pending
443 // Only the the last requested visual will be displayed so remove current visual which is staged but not ready.
444 Toolkit::GetImplementation( currentRegisteredVisual ).SetOffStage( self );
445 mVisuals.Erase( registeredVisualsiter );
449 // current visual not already in removal container so add now.
450 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "RegisterVisual Move current registered visual to removal Queue: %d \n", index );
451 MoveVisual( registeredVisualsiter, mVisuals, mRemoveVisuals );
456 // Control not staged or visual disabled so can just erase from registered visuals and new visual will be added later.
457 mVisuals.Erase( registeredVisualsiter );
460 // 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
461 if( ( depthIndexValueSet == DepthIndexValue::NOT_SET ) &&
462 ( visual.GetDepthIndex() == 0 ) )
464 requiredDepthIndex = currentDepthIndex;
468 visualReplaced = true;
472 // If not set, set the name of the visual to the same name as the control's property.
473 // ( If the control has been type registered )
474 if( visual.GetName().empty() )
478 std::string visualName = self.GetPropertyName( index );
479 if( !visualName.empty() )
481 DALI_LOG_INFO( gLogFilter, Debug::Concise, "Setting visual name for property %d to %s\n",
482 index, visualName.c_str() );
483 visual.SetName( visualName );
486 catch( Dali::DaliException e )
488 DALI_LOG_WARNING( "Attempting to register visual without a registered property, index: %d\n", index );
492 if( !visualReplaced ) // New registration entry
494 // 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
495 if( ( depthIndexValueSet == DepthIndexValue::NOT_SET ) &&
496 ( mVisuals.Size() > 0 ) &&
497 ( visual.GetDepthIndex() == 0 ) )
499 int maxDepthIndex = std::numeric_limits< int >::min();
501 RegisteredVisualContainer::ConstIterator iter;
502 const RegisteredVisualContainer::ConstIterator endIter = mVisuals.End();
503 for ( iter = mVisuals.Begin(); iter != endIter; iter++ )
505 const int visualDepthIndex = (*iter)->visual.GetDepthIndex();
506 if ( visualDepthIndex > maxDepthIndex )
508 maxDepthIndex = visualDepthIndex;
511 ++maxDepthIndex; // Add one to the current maximum depth index so that our added visual appears on top
512 requiredDepthIndex = std::max( 0, maxDepthIndex ); // Start at zero if maxDepth index belongs to a background
518 // Set determined depth index
519 visual.SetDepthIndex( requiredDepthIndex );
521 // Monitor when the visual resources are ready
522 StartObservingVisual( visual );
524 DALI_LOG_INFO( gLogFilter, Debug::Concise, "New Visual registration index[%d] depth[%d]\n", index, requiredDepthIndex );
525 RegisteredVisual* newRegisteredVisual = new RegisteredVisual( index, visual,
526 ( enabled == VisualState::ENABLED ? true : false ),
527 ( visualReplaced && enabled ) ) ;
528 mVisuals.PushBack( newRegisteredVisual );
530 Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
531 // Put on stage if enabled and the control is already on the stage
532 if( ( enabled == VisualState::ENABLED ) && self.OnStage() )
534 visualImpl.SetOnStage( self );
536 else if( visualImpl.IsResourceReady() ) // When not being staged, check if visual already 'ResourceReady' before it was Registered. ( Resource may have been loaded already )
538 ResourceReady( visualImpl );
543 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::RegisterVisual() Registered %s(%d), enabled:%s\n", visual.GetName().c_str(), index, enabled?"true":"false" );
546 void Control::Impl::UnregisterVisual( Property::Index index )
548 RegisteredVisualContainer::Iterator iter;
549 if ( FindVisual( index, mVisuals, iter ) )
551 // stop observing visual
552 StopObservingVisual( (*iter)->visual );
554 Actor self( mControlImpl.Self() );
555 Toolkit::GetImplementation((*iter)->visual).SetOffStage( self );
556 (*iter)->visual.Reset();
557 mVisuals.Erase( iter );
560 if( FindVisual( index, mRemoveVisuals, iter ) )
562 Actor self( mControlImpl.Self() );
563 Toolkit::GetImplementation( (*iter)->visual ).SetOffStage( self );
564 (*iter)->pending = false;
565 (*iter)->visual.Reset();
566 mRemoveVisuals.Erase( iter );
570 Toolkit::Visual::Base Control::Impl::GetVisual( Property::Index index ) const
572 RegisteredVisualContainer::Iterator iter;
573 if ( FindVisual( index, mVisuals, iter ) )
575 return (*iter)->visual;
578 return Toolkit::Visual::Base();
581 void Control::Impl::EnableVisual( Property::Index index, bool enable )
583 DALI_LOG_INFO( gLogFilter, Debug::General, "Control::EnableVisual(%d, %s)\n", index, enable?"T":"F");
585 RegisteredVisualContainer::Iterator iter;
586 if ( FindVisual( index, mVisuals, iter ) )
588 if ( (*iter)->enabled == enable )
590 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::EnableVisual Visual %s(%d) already %s\n", (*iter)->visual.GetName().c_str(), index, enable?"enabled":"disabled");
594 (*iter)->enabled = enable;
595 Actor parentActor = mControlImpl.Self();
596 if ( mControlImpl.Self().OnStage() ) // If control not on Stage then Visual will be added when StageConnection is called.
600 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::EnableVisual Setting %s(%d) on stage \n", (*iter)->visual.GetName().c_str(), index );
601 Toolkit::GetImplementation((*iter)->visual).SetOnStage( parentActor );
605 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::EnableVisual Setting %s(%d) off stage \n", (*iter)->visual.GetName().c_str(), index );
606 Toolkit::GetImplementation((*iter)->visual).SetOffStage( parentActor ); // No need to call if control not staged.
612 DALI_LOG_WARNING( "Control::EnableVisual(%d, %s) FAILED - NO SUCH VISUAL\n", index, enable?"T":"F" );
616 bool Control::Impl::IsVisualEnabled( Property::Index index ) const
618 RegisteredVisualContainer::Iterator iter;
619 if ( FindVisual( index, mVisuals, iter ) )
621 return (*iter)->enabled;
626 void Control::Impl::StopObservingVisual( Toolkit::Visual::Base& visual )
628 Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
630 // Stop observing the visual
631 visualImpl.RemoveResourceObserver( *this );
634 void Control::Impl::StartObservingVisual( Toolkit::Visual::Base& visual)
636 Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
638 // start observing the visual for resource ready
639 visualImpl.AddResourceObserver( *this );
642 // Called by a Visual when it's resource is ready
643 void Control::Impl::ResourceReady( Visual::Base& object)
645 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::Impl::ResourceReady() replacements pending[%d]\n", mRemoveVisuals.Count() );
647 Actor self = mControlImpl.Self();
649 // A resource is ready, find resource in the registered visuals container and get its index
650 for( auto registeredIter = mVisuals.Begin(), end = mVisuals.End(); registeredIter != end; ++registeredIter )
652 Internal::Visual::Base& registeredVisualImpl = Toolkit::GetImplementation( (*registeredIter)->visual );
654 if( &object == ®isteredVisualImpl )
656 RegisteredVisualContainer::Iterator visualToRemoveIter;
657 // Find visual with the same index in the removal container
658 // Set if off stage as it's replacement is now ready.
659 // Remove if from removal list as now removed from stage.
660 // Set Pending flag on the ready visual to false as now ready.
661 if( FindVisual( (*registeredIter)->index, mRemoveVisuals, visualToRemoveIter ) )
663 (*registeredIter)->pending = false;
664 Toolkit::GetImplementation( (*visualToRemoveIter)->visual ).SetOffStage( self );
665 mRemoveVisuals.Erase( visualToRemoveIter );
671 // A visual is ready so control may need relayouting if staged
672 if ( self.OnStage() )
674 mControlImpl.RelayoutRequest();
677 // Emit signal if all enabled visuals registered by the control are ready.
678 if( IsResourceReady() )
680 Dali::Toolkit::Control handle( mControlImpl.GetOwner() );
681 mResourceReadySignal.Emit( handle );
685 bool Control::Impl::IsResourceReady() const
687 // Iterate through and check all the enabled visuals are ready
688 for( auto visualIter = mVisuals.Begin();
689 visualIter != mVisuals.End(); ++visualIter )
691 const Toolkit::Visual::Base visual = (*visualIter)->visual;
692 const Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
694 // one of the enabled visuals is not ready
695 if( !visualImpl.IsResourceReady() && (*visualIter)->enabled )
703 Toolkit::Visual::ResourceStatus Control::Impl::GetVisualResourceStatus( Property::Index index ) const
705 RegisteredVisualContainer::Iterator iter;
706 if ( FindVisual( index, mVisuals, iter ) )
708 const Toolkit::Visual::Base visual = (*iter)->visual;
709 const Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
710 return visualImpl.GetResourceStatus( );
713 return Toolkit::Visual::ResourceStatus::PREPARING;
718 void Control::Impl::AddTransitions( Dali::Animation& animation,
719 const Toolkit::TransitionData& handle,
720 bool createAnimation )
722 // Setup a Transition from TransitionData.
723 const Internal::TransitionData& transitionData = Toolkit::GetImplementation( handle );
724 TransitionData::Iterator end = transitionData.End();
725 for( TransitionData::Iterator iter = transitionData.Begin() ;
726 iter != end; ++iter )
728 TransitionData::Animator* animator = (*iter);
730 Toolkit::Visual::Base visual = GetVisualByName( mVisuals, animator->objectName );
734 #if defined(DEBUG_ENABLED)
735 Dali::TypeInfo typeInfo;
736 ControlWrapper* controlWrapperImpl = dynamic_cast<ControlWrapper*>(&mControlImpl);
737 if( controlWrapperImpl )
739 typeInfo = controlWrapperImpl->GetTypeInfo();
742 DALI_LOG_INFO( gLogFilter, Debug::Concise, "CreateTransition: Found %s visual for %s\n",
743 visual.GetName().c_str(), typeInfo?typeInfo.GetName().c_str():"Unknown" );
745 Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
746 visualImpl.AnimateProperty( animation, *animator );
750 DALI_LOG_INFO( gLogFilter, Debug::Concise, "CreateTransition: Could not find visual. Trying actors");
751 // Otherwise, try any actor children of control (Including the control)
752 Actor child = mControlImpl.Self().FindChildByName( animator->objectName );
755 Property::Index propertyIndex = DevelHandle::GetPropertyIndex( child, animator->propertyKey );
756 if( propertyIndex != Property::INVALID_INDEX )
758 if( animator->animate == false )
760 if( animator->targetValue.GetType() != Property::NONE )
762 child.SetProperty( propertyIndex, animator->targetValue );
765 else // animate the property
767 if( animator->initialValue.GetType() != Property::NONE )
769 child.SetProperty( propertyIndex, animator->initialValue );
772 if( createAnimation && !animation )
774 animation = Dali::Animation::New( 0.1f );
777 animation.AnimateTo( Property( child, propertyIndex ),
778 animator->targetValue,
779 animator->alphaFunction,
780 TimePeriod( animator->timePeriodDelay,
781 animator->timePeriodDuration ) );
789 Dali::Animation Control::Impl::CreateTransition( const Toolkit::TransitionData& transitionData )
791 Dali::Animation transition;
793 if( transitionData.Count() > 0 )
795 AddTransitions( transition, transitionData, true );
802 void Control::Impl::DoAction( Dali::Property::Index visualIndex, Dali::Property::Index actionId, const Dali::Property::Value attributes )
804 RegisteredVisualContainer::Iterator iter;
805 if ( FindVisual( visualIndex, mVisuals, iter ) )
807 Toolkit::GetImplementation((*iter)->visual).DoAction( actionId, attributes );
811 void Control::Impl::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
813 Toolkit::Control control = Toolkit::Control::DownCast( BaseHandle( object ) );
817 Control& controlImpl( GetImplementation( control ) );
821 case Toolkit::Control::Property::STYLE_NAME:
823 controlImpl.SetStyleName( value.Get< std::string >() );
827 case Toolkit::DevelControl::Property::STATE:
829 bool withTransitions=true;
830 const Property::Value* valuePtr=&value;
831 Property::Map* map = value.GetMap();
834 Property::Value* value2 = map->Find("withTransitions");
837 withTransitions = value2->Get<bool>();
840 valuePtr = map->Find("state");
845 Toolkit::DevelControl::State state( controlImpl.mImpl->mState );
846 if( Scripting::GetEnumerationProperty< Toolkit::DevelControl::State >( *valuePtr, ControlStateTable, ControlStateTableCount, state ) )
848 controlImpl.mImpl->SetState( state, withTransitions );
854 case Toolkit::DevelControl::Property::SUB_STATE:
856 std::string subState;
857 if( value.Get( subState ) )
859 controlImpl.mImpl->SetSubState( subState );
864 case Toolkit::DevelControl::Property::LEFT_FOCUSABLE_ACTOR_ID:
867 if( value.Get( focusId ) )
869 controlImpl.mImpl->mLeftFocusableActorId = focusId;
874 case Toolkit::DevelControl::Property::RIGHT_FOCUSABLE_ACTOR_ID:
877 if( value.Get( focusId ) )
879 controlImpl.mImpl->mRightFocusableActorId = focusId;
884 case Toolkit::DevelControl::Property::UP_FOCUSABLE_ACTOR_ID:
887 if( value.Get( focusId ) )
889 controlImpl.mImpl->mUpFocusableActorId = focusId;
894 case Toolkit::DevelControl::Property::DOWN_FOCUSABLE_ACTOR_ID:
897 if( value.Get( focusId ) )
899 controlImpl.mImpl->mDownFocusableActorId = focusId;
904 case Toolkit::Control::Property::BACKGROUND_COLOR:
906 DALI_LOG_WARNING( "BACKGROUND_COLOR property is deprecated. Use BACKGROUND property instead\n" );
907 controlImpl.SetBackgroundColor( value.Get< Vector4 >() );
911 case Toolkit::Control::Property::BACKGROUND_IMAGE:
913 DALI_LOG_WARNING( "BACKGROUND_IMAGE property is deprecated. Use BACKGROUND property instead\n" );
914 Image image = Scripting::NewImage( value );
917 controlImpl.SetBackgroundImage( image );
921 // An empty image means the background is no longer required
922 controlImpl.ClearBackground();
927 case Toolkit::Control::Property::KEY_INPUT_FOCUS:
929 if ( value.Get< bool >() )
931 controlImpl.SetKeyInputFocus();
935 controlImpl.ClearKeyInputFocus();
940 case Toolkit::Control::Property::BACKGROUND:
944 const Property::Map* map = value.GetMap();
945 if( map && !map->Empty() )
947 controlImpl.SetBackground( *map );
949 else if( value.Get( url ) )
951 // don't know the size to load
952 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( url, ImageDimensions() );
955 controlImpl.mImpl->RegisterVisual( Toolkit::Control::Property::BACKGROUND, visual, DepthIndex::BACKGROUND );
958 else if( value.Get( color ) )
960 controlImpl.SetBackgroundColor(color);
964 // The background is an empty property map, so we should clear the background
965 controlImpl.ClearBackground();
970 case Toolkit::Control::Property::MARGIN:
973 if( value.Get( margin ) )
975 controlImpl.mImpl->SetMargin( margin );
980 case Toolkit::Control::Property::PADDING:
983 if( value.Get( padding ) )
985 controlImpl.mImpl->SetPadding( padding );
990 case Toolkit::DevelControl::Property::TOOLTIP:
992 TooltipPtr& tooltipPtr = controlImpl.mImpl->mTooltip;
995 tooltipPtr = Tooltip::New( control );
997 tooltipPtr->SetProperties( value );
1005 Property::Value Control::Impl::GetProperty( BaseObject* object, Property::Index index )
1007 Property::Value value;
1009 Toolkit::Control control = Toolkit::Control::DownCast( BaseHandle( object ) );
1013 Control& controlImpl( GetImplementation( control ) );
1017 case Toolkit::Control::Property::STYLE_NAME:
1019 value = controlImpl.GetStyleName();
1023 case Toolkit::DevelControl::Property::STATE:
1025 value = controlImpl.mImpl->mState;
1029 case Toolkit::DevelControl::Property::SUB_STATE:
1031 value = controlImpl.mImpl->mSubStateName;
1035 case Toolkit::DevelControl::Property::LEFT_FOCUSABLE_ACTOR_ID:
1037 value = controlImpl.mImpl->mLeftFocusableActorId;
1041 case Toolkit::DevelControl::Property::RIGHT_FOCUSABLE_ACTOR_ID:
1043 value = controlImpl.mImpl->mRightFocusableActorId;
1047 case Toolkit::DevelControl::Property::UP_FOCUSABLE_ACTOR_ID:
1049 value = controlImpl.mImpl->mUpFocusableActorId;
1053 case Toolkit::DevelControl::Property::DOWN_FOCUSABLE_ACTOR_ID:
1055 value = controlImpl.mImpl->mDownFocusableActorId;
1059 case Toolkit::Control::Property::BACKGROUND_COLOR:
1061 DALI_LOG_WARNING( "BACKGROUND_COLOR property is deprecated. Use BACKGROUND property instead\n" );
1062 value = controlImpl.GetBackgroundColor();
1066 case Toolkit::Control::Property::BACKGROUND_IMAGE:
1068 DALI_LOG_WARNING( "BACKGROUND_IMAGE property is deprecated. Use BACKGROUND property instead\n" );
1070 Toolkit::Visual::Base visual = controlImpl.mImpl->GetVisual( Toolkit::Control::Property::BACKGROUND );
1073 visual.CreatePropertyMap( map );
1079 case Toolkit::Control::Property::KEY_INPUT_FOCUS:
1081 value = controlImpl.HasKeyInputFocus();
1085 case Toolkit::Control::Property::BACKGROUND:
1088 Toolkit::Visual::Base visual = controlImpl.mImpl->GetVisual( Toolkit::Control::Property::BACKGROUND );
1091 visual.CreatePropertyMap( map );
1098 case Toolkit::Control::Property::MARGIN:
1100 value = controlImpl.mImpl->GetMargin();
1104 case Toolkit::Control::Property::PADDING:
1106 value = controlImpl.mImpl->GetPadding();
1110 case Toolkit::DevelControl::Property::TOOLTIP:
1113 if( controlImpl.mImpl->mTooltip )
1115 controlImpl.mImpl->mTooltip->CreatePropertyMap( map );
1127 void Control::Impl::CopyInstancedProperties( RegisteredVisualContainer& visuals, Dictionary<Property::Map>& instancedProperties )
1129 for(RegisteredVisualContainer::Iterator iter = visuals.Begin(); iter!= visuals.End(); iter++)
1131 if( (*iter)->visual )
1133 Property::Map instanceMap;
1134 Toolkit::GetImplementation((*iter)->visual).CreateInstancePropertyMap(instanceMap);
1135 instancedProperties.Add( (*iter)->visual.GetName(), instanceMap );
1141 void Control::Impl::RemoveVisual( RegisteredVisualContainer& visuals, const std::string& visualName )
1143 Actor self( mControlImpl.Self() );
1145 for ( RegisteredVisualContainer::Iterator visualIter = visuals.Begin();
1146 visualIter != visuals.End(); ++visualIter )
1148 Toolkit::Visual::Base visual = (*visualIter)->visual;
1149 if( visual && visual.GetName() == visualName )
1151 Toolkit::GetImplementation(visual).SetOffStage( self );
1152 (*visualIter)->visual.Reset();
1153 visuals.Erase( visualIter );
1159 void Control::Impl::RemoveVisuals( RegisteredVisualContainer& visuals, DictionaryKeys& removeVisuals )
1161 Actor self( mControlImpl.Self() );
1162 for( DictionaryKeys::iterator iter = removeVisuals.begin(); iter != removeVisuals.end(); ++iter )
1164 const std::string visualName = *iter;
1165 RemoveVisual( visuals, visualName );
1169 void Control::Impl::RecreateChangedVisuals( Dictionary<Property::Map>& stateVisualsToChange,
1170 Dictionary<Property::Map>& instancedProperties )
1172 Dali::CustomActor handle( mControlImpl.GetOwner() );
1173 for( Dictionary<Property::Map>::iterator iter = stateVisualsToChange.Begin();
1174 iter != stateVisualsToChange.End(); ++iter )
1176 const std::string& visualName = (*iter).key;
1177 const Property::Map& toMap = (*iter).entry;
1179 // is it a candidate for re-creation?
1180 bool recreate = false;
1182 Toolkit::Visual::Base visual = GetVisualByName( mVisuals, visualName );
1185 Property::Map fromMap;
1186 visual.CreatePropertyMap( fromMap );
1188 Toolkit::Visual::Type fromType = GetVisualTypeFromMap( fromMap );
1189 Toolkit::Visual::Type toType = GetVisualTypeFromMap( toMap );
1191 if( fromType != toType )
1197 if( fromType == Toolkit::Visual::IMAGE || fromType == Toolkit::Visual::N_PATCH
1198 || fromType == Toolkit::Visual::SVG || fromType == Toolkit::Visual::ANIMATED_IMAGE )
1200 Property::Value* fromUrl = fromMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
1201 Property::Value* toUrl = toMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
1203 if( fromUrl && toUrl )
1205 std::string fromUrlString;
1206 std::string toUrlString;
1207 fromUrl->Get(fromUrlString);
1208 toUrl->Get(toUrlString);
1210 if( fromUrlString != toUrlString )
1218 const Property::Map* instancedMap = instancedProperties.FindConst( visualName );
1219 if( recreate || instancedMap )
1221 RemoveVisual( mVisuals, visualName );
1222 Style::ApplyVisual( handle, visualName, toMap, instancedMap );
1226 // @todo check to see if we can apply toMap without recreating the visual
1227 // e.g. by setting only animatable properties
1228 // For now, recreate all visuals, but merge in instance data.
1229 RemoveVisual( mVisuals, visualName );
1230 Style::ApplyVisual( handle, visualName, toMap, instancedMap );
1236 void Control::Impl::ReplaceStateVisualsAndProperties( const StylePtr oldState, const StylePtr newState, const std::string& subState )
1238 // Collect all old visual names
1239 DictionaryKeys stateVisualsToRemove;
1242 oldState->visuals.GetKeys( stateVisualsToRemove );
1243 if( ! subState.empty() )
1245 const StylePtr* oldSubState = oldState->subStates.FindConst(subState);
1248 DictionaryKeys subStateVisualsToRemove;
1249 (*oldSubState)->visuals.GetKeys( subStateVisualsToRemove );
1250 Merge( stateVisualsToRemove, subStateVisualsToRemove );
1255 // Collect all new visual properties
1256 Dictionary<Property::Map> stateVisualsToAdd;
1259 stateVisualsToAdd = newState->visuals;
1260 if( ! subState.empty() )
1262 const StylePtr* newSubState = newState->subStates.FindConst(subState);
1265 stateVisualsToAdd.Merge( (*newSubState)->visuals );
1270 // If a name is in both add/remove, move it to change list.
1271 Dictionary<Property::Map> stateVisualsToChange;
1272 FindChangableVisuals( stateVisualsToAdd, stateVisualsToChange, stateVisualsToRemove);
1274 // Copy instanced properties (e.g. text label) of current visuals
1275 Dictionary<Property::Map> instancedProperties;
1276 CopyInstancedProperties( mVisuals, instancedProperties );
1278 // For each visual in remove list, remove from mVisuals
1279 RemoveVisuals( mVisuals, stateVisualsToRemove );
1281 // For each visual in add list, create and add to mVisuals
1282 Dali::CustomActor handle( mControlImpl.GetOwner() );
1283 Style::ApplyVisuals( handle, stateVisualsToAdd, instancedProperties );
1285 // For each visual in change list, if it requires a new visual,
1286 // remove old visual, create and add to mVisuals
1287 RecreateChangedVisuals( stateVisualsToChange, instancedProperties );
1290 void Control::Impl::SetState( DevelControl::State newState, bool withTransitions )
1292 DevelControl::State oldState = mState;
1293 Dali::CustomActor handle( mControlImpl.GetOwner() );
1294 DALI_LOG_INFO(gLogFilter, Debug::Concise, "Control::Impl::SetState: %s\n",
1295 (mState == DevelControl::NORMAL ? "NORMAL" :(
1296 mState == DevelControl::FOCUSED ?"FOCUSED" : (
1297 mState == DevelControl::DISABLED?"DISABLED":"NONE" ))));
1299 if( mState != newState )
1301 // If mState was Disabled, and new state is Focused, should probably
1302 // store that fact, e.g. in another property that FocusManager can access.
1305 // Trigger state change and transitions
1306 // Apply new style, if stylemanager is available
1307 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
1310 const StylePtr stylePtr = GetImpl( styleManager ).GetRecordedStyle( Toolkit::Control( mControlImpl.GetOwner() ) );
1314 std::string oldStateName = Scripting::GetEnumerationName< Toolkit::DevelControl::State >( oldState, ControlStateTable, ControlStateTableCount );
1315 std::string newStateName = Scripting::GetEnumerationName< Toolkit::DevelControl::State >( newState, ControlStateTable, ControlStateTableCount );
1317 const StylePtr* newStateStyle = stylePtr->subStates.Find( newStateName );
1318 const StylePtr* oldStateStyle = stylePtr->subStates.Find( oldStateName );
1319 if( oldStateStyle && newStateStyle )
1321 // Only change if both state styles exist
1322 ReplaceStateVisualsAndProperties( *oldStateStyle, *newStateStyle, mSubStateName );
1329 void Control::Impl::SetSubState( const std::string& subStateName, bool withTransitions )
1331 if( mSubStateName != subStateName )
1333 // Get existing sub-state visuals, and unregister them
1334 Dali::CustomActor handle( mControlImpl.GetOwner() );
1336 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
1339 const StylePtr stylePtr = GetImpl( styleManager ).GetRecordedStyle( Toolkit::Control( mControlImpl.GetOwner() ) );
1343 std::string stateName = Scripting::GetEnumerationName< Toolkit::DevelControl::State >( mState, ControlStateTable, ControlStateTableCount );
1345 const StylePtr* state = stylePtr->subStates.Find( stateName );
1348 StylePtr stateStyle(*state);
1350 const StylePtr* newStateStyle = stateStyle->subStates.Find( subStateName );
1351 const StylePtr* oldStateStyle = stateStyle->subStates.Find( mSubStateName );
1352 if( oldStateStyle && newStateStyle )
1355 ReplaceStateVisualsAndProperties( *oldStateStyle, *newStateStyle, empty );
1361 mSubStateName = subStateName;
1365 void Control::Impl::OnStageDisconnection()
1367 Actor self = mControlImpl.Self();
1369 // Any visuals set for replacement but not yet ready should still be registered.
1370 // Reason: If a request was made to register a new visual but the control removed from stage before visual was ready
1371 // then when this control appears back on stage it should use that new visual.
1373 // Iterate through all registered visuals and set off stage
1374 SetVisualsOffStage( mVisuals, self );
1376 // Visuals pending replacement can now be taken out of the removal list and set off stage
1377 // Iterate through all replacement visuals and add to a move queue then set off stage
1378 for( auto removalIter = mRemoveVisuals.Begin(), end = mRemoveVisuals.End(); removalIter != end; removalIter++ )
1380 Toolkit::GetImplementation((*removalIter)->visual).SetOffStage( self );
1383 for( auto replacedIter = mVisuals.Begin(), end = mVisuals.End(); replacedIter != end; replacedIter++ )
1385 (*replacedIter)->pending = false;
1388 mRemoveVisuals.Clear();
1391 void Control::Impl::SetMargin( Extents margin )
1393 mControlImpl.mImpl->mMargin = margin;
1395 // Trigger a size negotiation request that may be needed when setting a margin.
1396 mControlImpl.RelayoutRequest();
1399 Extents Control::Impl::GetMargin() const
1401 return mControlImpl.mImpl->mMargin;
1404 void Control::Impl::SetPadding( Extents padding )
1406 mControlImpl.mImpl->mPadding = padding;
1408 // Trigger a size negotiation request that may be needed when setting a padding.
1409 mControlImpl.RelayoutRequest();
1412 Extents Control::Impl::GetPadding() const
1414 return mControlImpl.mImpl->mPadding;
1417 void Control::Impl::SetInputMethodContext( InputMethodContext& inputMethodContext )
1419 mInputMethodContext = inputMethodContext;
1422 bool Control::Impl::FilterKeyEvent( const KeyEvent& event )
1424 bool consumed ( false );
1426 if ( mInputMethodContext )
1428 consumed = mInputMethodContext.FilterEventKey( event );
1433 Toolkit::Internal::LayoutItemPtr Control::Impl::GetLayout() const
1438 void Control::Impl::SetLayout( Toolkit::Internal::LayoutItem& layout )
1442 mLayout->Unparent();
1447 auto controlHandle = Toolkit::Control::DownCast( mControlImpl.Self() ); // Get a handle of this control implementation without copying internals.
1448 mLayout->Initialize( controlHandle, controlHandle.GetTypeName() ); // LayoutGroup takes ownership of existing children
1451 void Control::Impl::RemoveLayout()
1455 mLayout->Unparent();
1460 } // namespace Internal
1462 } // namespace Toolkit