2 * Copyright (c) 2019 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include <dali-toolkit/public-api/controls/control-impl.h>
22 #include <cstring> // for strcmp
26 #include <dali/public-api/animation/constraint.h>
27 #include <dali/public-api/object/type-registry-helper.h>
28 #include <dali/public-api/size-negotiation/relayout-container.h>
29 #include <dali/devel-api/scripting/scripting.h>
30 #include <dali/integration-api/debug.h>
33 #include <dali-toolkit/public-api/align-enumerations.h>
34 #include <dali-toolkit/public-api/controls/control.h>
35 #include <dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h>
36 #include <dali-toolkit/public-api/styling/style-manager.h>
37 #include <dali-toolkit/public-api/visuals/color-visual-properties.h>
38 #include <dali-toolkit/public-api/visuals/visual-properties.h>
39 #include <dali-toolkit/devel-api/controls/control-depth-index-ranges.h>
40 #include <dali-toolkit/devel-api/controls/control-devel.h>
41 #include <dali-toolkit/devel-api/focus-manager/keyinput-focus-manager.h>
42 #include <dali-toolkit/devel-api/visuals/color-visual-properties-devel.h>
43 #include <dali-toolkit/internal/styling/style-manager-impl.h>
44 #include <dali-toolkit/internal/visuals/color/color-visual.h>
45 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
46 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
60 #if defined(DEBUG_ENABLED)
61 Debug::Filter* gLogFilter = Debug::Filter::New( Debug::NoLogging, false, "LOG_CONTROL_VISUALS");
65 * @brief Replace the background visual if it's a color visual with the renderIfTransparent property set as required.
66 * @param[in] controlImpl The control implementation
67 * @param[in] renderIfTransaparent Whether we should render if the color is transparent
69 void ChangeBackgroundColorVisual( Control& controlImpl, bool renderIfTransparent )
71 Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get( controlImpl );
73 Toolkit::Visual::Base backgroundVisual = controlDataImpl.GetVisual( Toolkit::Control::Property::BACKGROUND );
74 if( backgroundVisual )
77 backgroundVisual.CreatePropertyMap( map );
78 Property::Value* typeValue = map.Find( Toolkit::Visual::Property::TYPE );
79 if( typeValue && typeValue->Get< int >() == Toolkit::Visual::COLOR )
81 // Only change it if it's a color visual
82 map[ Toolkit::DevelColorVisual::Property::RENDER_IF_TRANSPARENT ] = renderIfTransparent;
83 controlImpl.SetBackground( map );
89 * @brief Creates a clipping renderer if required.
90 * (EG. If no renders exist and clipping is enabled).
91 * @param[in] controlImpl The control implementation.
93 void CreateClippingRenderer( Control& controlImpl )
95 // We want to add a transparent background if we do not have one for clipping.
96 Actor self( controlImpl.Self() );
97 int clippingMode = ClippingMode::DISABLED;
98 if( self.GetProperty( Actor::Property::CLIPPING_MODE ).Get( clippingMode ) )
100 switch( clippingMode )
102 case ClippingMode::CLIP_CHILDREN:
104 if( self.GetRendererCount() == 0u )
106 Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get( controlImpl );
107 if( controlDataImpl.mVisuals.Empty() )
109 controlImpl.SetBackgroundColor( Color::TRANSPARENT );
113 // We have visuals, check if we've set the background and re-create it to
114 // render even if transparent (only if it's a color visual)
115 ChangeBackgroundColorVisual( controlImpl, true );
121 case ClippingMode::DISABLED:
122 case ClippingMode::CLIP_TO_BOUNDING_BOX:
124 // If we have a background visual, check if it's a color visual and remove the render if transparent flag
125 ChangeBackgroundColorVisual( controlImpl, false );
132 } // unnamed namespace
135 Toolkit::Control Control::New()
137 // Create the implementation, temporarily owned on stack
138 IntrusivePtr<Control> controlImpl = new Control( ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) );
140 // Pass ownership to handle
141 Toolkit::Control handle( *controlImpl );
143 // Second-phase init of the implementation
144 // This can only be done after the CustomActor connection has been made...
145 controlImpl->Initialize();
150 void Control::SetStyleName( const std::string& styleName )
152 if( styleName != mImpl->mStyleName )
154 mImpl->mStyleName = styleName;
156 // Apply new style, if stylemanager is available
157 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
160 GetImpl( styleManager ).ApplyThemeStyle( Toolkit::Control( GetOwner() ) );
165 const std::string& Control::GetStyleName() const
167 return mImpl->mStyleName;
170 void Control::SetBackgroundColor( const Vector4& color )
172 mImpl->mBackgroundColor = color;
174 map[ Toolkit::Visual::Property::TYPE ] = Toolkit::Visual::COLOR;
175 map[ Toolkit::ColorVisual::Property::MIX_COLOR ] = color;
177 int clippingMode = ClippingMode::DISABLED;
178 if( ( Self().GetProperty( Actor::Property::CLIPPING_MODE ).Get( clippingMode ) ) &&
179 ( clippingMode == ClippingMode::CLIP_CHILDREN ) )
181 // If clipping-mode is set to CLIP_CHILDREN, then force visual to add the render even if transparent
182 map[ Toolkit::DevelColorVisual::Property::RENDER_IF_TRANSPARENT ] = true;
185 SetBackground( map );
188 void Control::SetBackground( const Property::Map& map )
190 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( map );
191 visual.SetName("background");
194 mImpl->RegisterVisual( Toolkit::Control::Property::BACKGROUND, visual, DepthIndex::BACKGROUND );
196 // Trigger a size negotiation request that may be needed by the new visual to relayout its contents.
201 void Control::ClearBackground()
203 mImpl->UnregisterVisual( Toolkit::Control::Property::BACKGROUND );
204 mImpl->mBackgroundColor = Color::TRANSPARENT;
206 // Trigger a size negotiation request that may be needed when unregistering a visual.
210 void Control::SetShadow( const Property::Map& map )
212 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( map );
213 visual.SetName("shadow");
217 mImpl->RegisterVisual( Toolkit::DevelControl::Property::SHADOW, visual, DepthIndex::BACKGROUND_EFFECT );
223 void Control::ClearShadow()
225 mImpl->UnregisterVisual( Toolkit::DevelControl::Property::SHADOW );
227 // Trigger a size negotiation request that may be needed when unregistering a visual.
232 void Control::EnableGestureDetection(Gesture::Type type)
234 if ( (type & Gesture::Pinch) && !mImpl->mPinchGestureDetector )
236 mImpl->mPinchGestureDetector = PinchGestureDetector::New();
237 mImpl->mPinchGestureDetector.DetectedSignal().Connect(mImpl, &Impl::PinchDetected);
238 mImpl->mPinchGestureDetector.Attach(Self());
241 if ( (type & Gesture::Pan) && !mImpl->mPanGestureDetector )
243 mImpl->mPanGestureDetector = PanGestureDetector::New();
244 mImpl->mPanGestureDetector.DetectedSignal().Connect(mImpl, &Impl::PanDetected);
245 mImpl->mPanGestureDetector.Attach(Self());
248 if ( (type & Gesture::Tap) && !mImpl->mTapGestureDetector )
250 mImpl->mTapGestureDetector = TapGestureDetector::New();
251 mImpl->mTapGestureDetector.DetectedSignal().Connect(mImpl, &Impl::TapDetected);
252 mImpl->mTapGestureDetector.Attach(Self());
255 if ( (type & Gesture::LongPress) && !mImpl->mLongPressGestureDetector )
257 mImpl->mLongPressGestureDetector = LongPressGestureDetector::New();
258 mImpl->mLongPressGestureDetector.DetectedSignal().Connect(mImpl, &Impl::LongPressDetected);
259 mImpl->mLongPressGestureDetector.Attach(Self());
263 void Control::DisableGestureDetection(Gesture::Type type)
265 if ( (type & Gesture::Pinch) && mImpl->mPinchGestureDetector )
267 mImpl->mPinchGestureDetector.Detach(Self());
268 mImpl->mPinchGestureDetector.Reset();
271 if ( (type & Gesture::Pan) && mImpl->mPanGestureDetector )
273 mImpl->mPanGestureDetector.Detach(Self());
274 mImpl->mPanGestureDetector.Reset();
277 if ( (type & Gesture::Tap) && mImpl->mTapGestureDetector )
279 mImpl->mTapGestureDetector.Detach(Self());
280 mImpl->mTapGestureDetector.Reset();
283 if ( (type & Gesture::LongPress) && mImpl->mLongPressGestureDetector)
285 mImpl->mLongPressGestureDetector.Detach(Self());
286 mImpl->mLongPressGestureDetector.Reset();
290 PinchGestureDetector Control::GetPinchGestureDetector() const
292 return mImpl->mPinchGestureDetector;
295 PanGestureDetector Control::GetPanGestureDetector() const
297 return mImpl->mPanGestureDetector;
300 TapGestureDetector Control::GetTapGestureDetector() const
302 return mImpl->mTapGestureDetector;
305 LongPressGestureDetector Control::GetLongPressGestureDetector() const
307 return mImpl->mLongPressGestureDetector;
310 void Control::SetKeyboardNavigationSupport(bool isSupported)
312 mImpl->mIsKeyboardNavigationSupported = isSupported;
315 bool Control::IsKeyboardNavigationSupported()
317 return mImpl->mIsKeyboardNavigationSupported;
320 void Control::SetKeyInputFocus()
322 if( Self().OnStage() )
324 Toolkit::KeyInputFocusManager::Get().SetFocus(Toolkit::Control::DownCast(Self()));
328 bool Control::HasKeyInputFocus()
331 if( Self().OnStage() )
333 Toolkit::Control control = Toolkit::KeyInputFocusManager::Get().GetCurrentFocusControl();
334 if( Self() == control )
342 void Control::ClearKeyInputFocus()
344 if( Self().OnStage() )
346 Toolkit::KeyInputFocusManager::Get().RemoveFocus(Toolkit::Control::DownCast(Self()));
350 void Control::SetAsKeyboardFocusGroup(bool isFocusGroup)
352 mImpl->mIsKeyboardFocusGroup = isFocusGroup;
354 // The following line will be removed when the deprecated API in KeyboardFocusManager is deleted
355 Toolkit::KeyboardFocusManager::Get().SetAsFocusGroup(Self(), isFocusGroup);
358 bool Control::IsKeyboardFocusGroup()
360 return Toolkit::KeyboardFocusManager::Get().IsFocusGroup(Self());
363 void Control::AccessibilityActivate()
365 // Inform deriving classes
366 OnAccessibilityActivated();
369 void Control::KeyboardEnter()
371 // Inform deriving classes
375 bool Control::OnAccessibilityActivated()
377 return false; // Accessibility activation is not handled by default
380 bool Control::OnKeyboardEnter()
382 return false; // Keyboard enter is not handled by default
385 bool Control::OnAccessibilityPan(PanGesture gesture)
387 return false; // Accessibility pan gesture is not handled by default
390 bool Control::OnAccessibilityTouch(const TouchEvent& touchEvent)
392 return false; // Accessibility touch event is not handled by default
395 bool Control::OnAccessibilityValueChange(bool isIncrease)
397 return false; // Accessibility value change action is not handled by default
400 bool Control::OnAccessibilityZoom()
402 return false; // Accessibility zoom action is not handled by default
405 Actor Control::GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled)
410 void Control::OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor)
414 Toolkit::Control::KeyEventSignalType& Control::KeyEventSignal()
416 return mImpl->mKeyEventSignal;
419 Toolkit::Control::KeyInputFocusSignalType& Control::KeyInputFocusGainedSignal()
421 return mImpl->mKeyInputFocusGainedSignal;
424 Toolkit::Control::KeyInputFocusSignalType& Control::KeyInputFocusLostSignal()
426 return mImpl->mKeyInputFocusLostSignal;
429 bool Control::EmitKeyEventSignal( const KeyEvent& event )
431 // Guard against destruction during signal emission
432 Dali::Toolkit::Control handle( GetOwner() );
434 bool consumed = false;
436 consumed = mImpl->FilterKeyEvent( event );
438 // signals are allocated dynamically when someone connects
439 if ( !consumed && !mImpl->mKeyEventSignal.Empty() )
441 consumed = mImpl->mKeyEventSignal.Emit( handle, event );
446 // Notification for derived classes
447 consumed = OnKeyEvent(event);
453 Control::Control( ControlBehaviour behaviourFlags )
454 : CustomActorImpl( static_cast< ActorFlags >( behaviourFlags ) ),
455 mImpl(new Impl(*this))
457 mImpl->mFlags = behaviourFlags;
465 void Control::Initialize()
467 // Call deriving classes so initialised before styling is applied to them.
470 if( (mImpl->mFlags & REQUIRES_STYLE_CHANGE_SIGNALS) ||
471 !(mImpl->mFlags & DISABLE_STYLE_CHANGE_SIGNALS) )
473 Toolkit::StyleManager styleManager = StyleManager::Get();
475 // if stylemanager is available
478 StyleManager& styleManagerImpl = GetImpl( styleManager );
480 // Register for style changes
481 styleManagerImpl.ControlStyleChangeSignal().Connect( this, &Control::OnStyleChange );
483 // Apply the current style
484 styleManagerImpl.ApplyThemeStyleAtInit( Toolkit::Control( GetOwner() ) );
488 if( mImpl->mFlags & REQUIRES_KEYBOARD_NAVIGATION_SUPPORT )
490 SetKeyboardNavigationSupport( true );
494 void Control::OnInitialize()
498 void Control::OnControlChildAdd( Actor& child )
502 void Control::OnControlChildRemove( Actor& child )
506 void Control::OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change )
508 // By default the control is only interested in theme (not font) changes
509 if( styleManager && change == StyleChange::THEME_CHANGE )
511 GetImpl( styleManager ).ApplyThemeStyle( Toolkit::Control( GetOwner() ) );
516 void Control::OnPinch(const PinchGesture& pinch)
518 if( !( mImpl->mStartingPinchScale ) )
521 mImpl->mStartingPinchScale = new Vector3;
524 if( pinch.state == Gesture::Started )
526 *( mImpl->mStartingPinchScale ) = Self().GetCurrentScale();
529 Self().SetScale( *( mImpl->mStartingPinchScale ) * pinch.scale );
532 void Control::OnPan( const PanGesture& pan )
536 void Control::OnTap(const TapGesture& tap)
540 void Control::OnLongPress( const LongPressGesture& longPress )
544 void Control::EmitKeyInputFocusSignal( bool focusGained )
546 Dali::Toolkit::Control handle( GetOwner() );
550 // signals are allocated dynamically when someone connects
551 if ( !mImpl->mKeyInputFocusGainedSignal.Empty() )
553 mImpl->mKeyInputFocusGainedSignal.Emit( handle );
558 // signals are allocated dynamically when someone connects
559 if ( !mImpl->mKeyInputFocusLostSignal.Empty() )
561 mImpl->mKeyInputFocusLostSignal.Emit( handle );
566 void Control::OnStageConnection( int depth )
568 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::OnStageConnection number of registered visuals(%d)\n", mImpl->mVisuals.Size() );
570 Actor self( Self() );
572 for(RegisteredVisualContainer::Iterator iter = mImpl->mVisuals.Begin(); iter!= mImpl->mVisuals.End(); iter++)
574 // Check whether the visual is empty and enabled
575 if( (*iter)->visual && (*iter)->enabled )
577 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::OnStageConnection Setting visual(%d) on stage\n", (*iter)->index );
578 Toolkit::GetImplementation((*iter)->visual).SetOnStage( self );
582 // The clipping renderer is only created if required.
583 CreateClippingRenderer( *this );
585 // Request to be laid out when the control is connected to the Stage.
586 // Signal that a Relayout may be needed
590 void Control::OnStageDisconnection()
592 mImpl->OnStageDisconnection();
595 void Control::OnKeyInputFocusGained()
597 EmitKeyInputFocusSignal( true );
600 void Control::OnKeyInputFocusLost()
602 EmitKeyInputFocusSignal( false );
605 void Control::OnChildAdd(Actor& child)
607 // Notify derived classes.
608 OnControlChildAdd( child );
611 void Control::OnChildRemove(Actor& child)
613 // Notify derived classes.
614 OnControlChildRemove( child );
617 void Control::OnPropertySet( Property::Index index, Property::Value propertyValue )
619 // If the clipping mode has been set, we may need to create a renderer.
620 // Only do this if we are already on-stage as the OnStageConnection will handle the off-stage clipping controls.
621 if( ( index == Actor::Property::CLIPPING_MODE ) && Self().OnStage() )
623 // Note: This method will handle whether creation of the renderer is required.
624 CreateClippingRenderer( *this );
628 void Control::OnSizeSet(const Vector3& targetSize)
630 Toolkit::Visual::Base visual = mImpl->GetVisual( Toolkit::Control::Property::BACKGROUND );
633 Vector2 size( targetSize );
634 visual.SetTransformAndSize( Property::Map(), size ); // Send an empty map as we do not want to modify the visual's set transform
638 void Control::OnSizeAnimation(Animation& animation, const Vector3& targetSize)
640 // @todo size negotiate background to new size, animate as well?
643 bool Control::OnTouchEvent(const TouchEvent& event)
645 return false; // Do not consume
648 bool Control::OnHoverEvent(const HoverEvent& event)
650 return false; // Do not consume
653 bool Control::OnKeyEvent(const KeyEvent& event)
655 return false; // Do not consume
658 bool Control::OnWheelEvent(const WheelEvent& event)
660 return false; // Do not consume
663 void Control::OnRelayout( const Vector2& size, RelayoutContainer& container )
665 for( unsigned int i = 0, numChildren = Self().GetChildCount(); i < numChildren; ++i )
667 Actor child = Self().GetChildAt( i );
668 Vector2 newChildSize( size );
670 // When set the padding or margin on the control, child should be resized and repositioned.
671 if( ( mImpl->mPadding.start != 0 ) || ( mImpl->mPadding.end != 0 ) || ( mImpl->mPadding.top != 0 ) || ( mImpl->mPadding.bottom != 0 ) ||
672 ( mImpl->mMargin.start != 0 ) || ( mImpl->mMargin.end != 0 ) || ( mImpl->mMargin.top != 0 ) || ( mImpl->mMargin.bottom != 0 ) )
674 Extents padding = mImpl->mPadding;
676 Dali::CustomActor ownerActor(GetOwner());
677 Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>( ownerActor.GetProperty( Dali::Actor::Property::LAYOUT_DIRECTION ).Get<int>() );
679 if( Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection )
681 std::swap( padding.start, padding.end );
684 newChildSize.width = size.width - ( padding.start + padding.end );
685 newChildSize.height = size.height - ( padding.top + padding.bottom );
687 // Cannot use childs Position property as it can already have padding and margin applied on it,
688 // so we end up cumulatively applying them over and over again.
689 Vector2 childOffset( 0.f, 0.f );
690 childOffset.x += ( mImpl->mMargin.start + padding.start );
691 childOffset.y += ( mImpl->mMargin.top + padding.top );
693 child.SetPosition( childOffset.x, childOffset.y );
695 container.Add( child, newChildSize );
698 Toolkit::Visual::Base visual = mImpl->GetVisual( Toolkit::Control::Property::BACKGROUND );
701 visual.SetTransformAndSize( Property::Map(), size ); // Send an empty map as we do not want to modify the visual's set transform
705 void Control::OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension )
709 Vector3 Control::GetNaturalSize()
711 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::GetNaturalSize for %s\n", Self().GetName().c_str() );
712 Toolkit::Visual::Base visual = mImpl->GetVisual( Toolkit::Control::Property::BACKGROUND );
716 visual.GetNaturalSize( naturalSize );
717 naturalSize.width += ( mImpl->mPadding.start + mImpl->mPadding.end );
718 naturalSize.height += ( mImpl->mPadding.top + mImpl->mPadding.bottom );
719 return Vector3( naturalSize );
721 return Vector3::ZERO;
724 float Control::CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension )
726 return CalculateChildSizeBase( child, dimension );
729 float Control::GetHeightForWidth( float width )
731 return GetHeightForWidthBase( width );
734 float Control::GetWidthForHeight( float height )
736 return GetWidthForHeightBase( height );
739 bool Control::RelayoutDependentOnChildren( Dimension::Type dimension )
741 return RelayoutDependentOnChildrenBase( dimension );
744 void Control::OnCalculateRelayoutSize( Dimension::Type dimension )
748 void Control::OnLayoutNegotiated( float size, Dimension::Type dimension )
752 void Control::SignalConnected( SlotObserver* slotObserver, CallbackBase* callback )
754 mImpl->SignalConnected( slotObserver, callback );
757 void Control::SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback )
759 mImpl->SignalDisconnected( slotObserver, callback );
762 Control& GetImplementation( Dali::Toolkit::Control& handle )
764 CustomActorImpl& customInterface = handle.GetImplementation();
765 // downcast to control
766 Control& impl = dynamic_cast< Internal::Control& >( customInterface );
770 const Control& GetImplementation( const Dali::Toolkit::Control& handle )
772 const CustomActorImpl& customInterface = handle.GetImplementation();
773 // downcast to control
774 const Control& impl = dynamic_cast< const Internal::Control& >( customInterface );
778 } // namespace Internal
780 } // namespace Toolkit