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 <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 );
133 * @brief Sets Control::Property::BACKGROUND visual
134 * @param[in] controlImpl The control implementation
135 * @param[in] visual The control background visual
136 * @param[in] size The current size
138 void SetBackgroundVisual( Control::Impl& controlImpl, Toolkit::Visual::Base& visual, const Vector2& size )
140 Property::Map transformMap = Property::Map();
142 if( ( ( controlImpl.mMargin.start != 0 ) ||
143 ( controlImpl.mMargin.end != 0 ) ||
144 ( controlImpl.mMargin.top != 0 ) ||
145 ( controlImpl.mMargin.bottom != 0 ) ) &&
146 ( controlImpl.mControlImpl.Self().GetCurrentAnchorPoint() != AnchorPoint::CENTER ) )
148 transformMap.Add( Toolkit::Visual::Transform::Property::SIZE, size )
149 .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY, Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
150 .Add( Toolkit::Visual::Transform::Property::OFFSET, Vector2( controlImpl.mMargin.start, controlImpl.mMargin.top ) )
151 .Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY, Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
152 .Add( Toolkit::Visual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN )
153 .Add( Toolkit::Visual::Transform::Property::ANCHOR_POINT, Toolkit::Align::TOP_BEGIN );
156 visual.SetTransformAndSize( transformMap, size ); // Send an empty map as we do not want to modify the visual's set transform
159 } // unnamed namespace
162 Toolkit::Control Control::New()
164 // Create the implementation, temporarily owned on stack
165 IntrusivePtr<Control> controlImpl = new Control( ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) );
167 // Pass ownership to handle
168 Toolkit::Control handle( *controlImpl );
170 // Second-phase init of the implementation
171 // This can only be done after the CustomActor connection has been made...
172 controlImpl->Initialize();
177 void Control::SetStyleName( const std::string& styleName )
179 if( styleName != mImpl->mStyleName )
181 mImpl->mStyleName = styleName;
183 // Apply new style, if stylemanager is available
184 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
187 GetImpl( styleManager ).ApplyThemeStyle( Toolkit::Control( GetOwner() ) );
192 const std::string& Control::GetStyleName() const
194 return mImpl->mStyleName;
197 void Control::SetBackgroundColor( const Vector4& color )
199 mImpl->mBackgroundColor = color;
201 map[ Toolkit::Visual::Property::TYPE ] = Toolkit::Visual::COLOR;
202 map[ Toolkit::ColorVisual::Property::MIX_COLOR ] = color;
204 int clippingMode = ClippingMode::DISABLED;
205 if( ( Self().GetProperty( Actor::Property::CLIPPING_MODE ).Get( clippingMode ) ) &&
206 ( clippingMode == ClippingMode::CLIP_CHILDREN ) )
208 // If clipping-mode is set to CLIP_CHILDREN, then force visual to add the render even if transparent
209 map[ Toolkit::DevelColorVisual::Property::RENDER_IF_TRANSPARENT ] = true;
212 SetBackground( map );
215 Vector4 Control::GetBackgroundColor() const
217 return mImpl->mBackgroundColor;
220 void Control::SetBackground( const Property::Map& map )
222 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( map );
223 visual.SetName("background");
226 mImpl->RegisterVisual( Toolkit::Control::Property::BACKGROUND, visual, DepthIndex::BACKGROUND );
228 // Trigger a size negotiation request that may be needed by the new visual to relayout its contents.
233 void Control::SetBackgroundImage( Image image )
235 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( image );
238 mImpl->RegisterVisual( Toolkit::Control::Property::BACKGROUND, visual, DepthIndex::BACKGROUND );
242 void Control::ClearBackground()
244 mImpl->UnregisterVisual( Toolkit::Control::Property::BACKGROUND );
245 mImpl->mBackgroundColor = Color::TRANSPARENT;
247 // Trigger a size negotiation request that may be needed when unregistering a visual.
251 void Control::EnableGestureDetection(Gesture::Type type)
253 if ( (type & Gesture::Pinch) && !mImpl->mPinchGestureDetector )
255 mImpl->mPinchGestureDetector = PinchGestureDetector::New();
256 mImpl->mPinchGestureDetector.DetectedSignal().Connect(mImpl, &Impl::PinchDetected);
257 mImpl->mPinchGestureDetector.Attach(Self());
260 if ( (type & Gesture::Pan) && !mImpl->mPanGestureDetector )
262 mImpl->mPanGestureDetector = PanGestureDetector::New();
263 mImpl->mPanGestureDetector.DetectedSignal().Connect(mImpl, &Impl::PanDetected);
264 mImpl->mPanGestureDetector.Attach(Self());
267 if ( (type & Gesture::Tap) && !mImpl->mTapGestureDetector )
269 mImpl->mTapGestureDetector = TapGestureDetector::New();
270 mImpl->mTapGestureDetector.DetectedSignal().Connect(mImpl, &Impl::TapDetected);
271 mImpl->mTapGestureDetector.Attach(Self());
274 if ( (type & Gesture::LongPress) && !mImpl->mLongPressGestureDetector )
276 mImpl->mLongPressGestureDetector = LongPressGestureDetector::New();
277 mImpl->mLongPressGestureDetector.DetectedSignal().Connect(mImpl, &Impl::LongPressDetected);
278 mImpl->mLongPressGestureDetector.Attach(Self());
282 void Control::DisableGestureDetection(Gesture::Type type)
284 if ( (type & Gesture::Pinch) && mImpl->mPinchGestureDetector )
286 mImpl->mPinchGestureDetector.Detach(Self());
287 mImpl->mPinchGestureDetector.Reset();
290 if ( (type & Gesture::Pan) && mImpl->mPanGestureDetector )
292 mImpl->mPanGestureDetector.Detach(Self());
293 mImpl->mPanGestureDetector.Reset();
296 if ( (type & Gesture::Tap) && mImpl->mTapGestureDetector )
298 mImpl->mTapGestureDetector.Detach(Self());
299 mImpl->mTapGestureDetector.Reset();
302 if ( (type & Gesture::LongPress) && mImpl->mLongPressGestureDetector)
304 mImpl->mLongPressGestureDetector.Detach(Self());
305 mImpl->mLongPressGestureDetector.Reset();
309 PinchGestureDetector Control::GetPinchGestureDetector() const
311 return mImpl->mPinchGestureDetector;
314 PanGestureDetector Control::GetPanGestureDetector() const
316 return mImpl->mPanGestureDetector;
319 TapGestureDetector Control::GetTapGestureDetector() const
321 return mImpl->mTapGestureDetector;
324 LongPressGestureDetector Control::GetLongPressGestureDetector() const
326 return mImpl->mLongPressGestureDetector;
329 void Control::SetKeyboardNavigationSupport(bool isSupported)
331 mImpl->mIsKeyboardNavigationSupported = isSupported;
334 bool Control::IsKeyboardNavigationSupported()
336 return mImpl->mIsKeyboardNavigationSupported;
339 void Control::SetKeyInputFocus()
341 if( Self().OnStage() )
343 Toolkit::KeyInputFocusManager::Get().SetFocus(Toolkit::Control::DownCast(Self()));
347 bool Control::HasKeyInputFocus()
350 if( Self().OnStage() )
352 Toolkit::Control control = Toolkit::KeyInputFocusManager::Get().GetCurrentFocusControl();
353 if( Self() == control )
361 void Control::ClearKeyInputFocus()
363 if( Self().OnStage() )
365 Toolkit::KeyInputFocusManager::Get().RemoveFocus(Toolkit::Control::DownCast(Self()));
369 void Control::SetAsKeyboardFocusGroup(bool isFocusGroup)
371 mImpl->mIsKeyboardFocusGroup = isFocusGroup;
373 // The following line will be removed when the deprecated API in KeyboardFocusManager is deleted
374 Toolkit::KeyboardFocusManager::Get().SetAsFocusGroup(Self(), isFocusGroup);
377 bool Control::IsKeyboardFocusGroup()
379 return Toolkit::KeyboardFocusManager::Get().IsFocusGroup(Self());
382 void Control::AccessibilityActivate()
384 // Inform deriving classes
385 OnAccessibilityActivated();
388 void Control::KeyboardEnter()
390 // Inform deriving classes
394 bool Control::OnAccessibilityActivated()
396 return false; // Accessibility activation is not handled by default
399 bool Control::OnKeyboardEnter()
401 return false; // Keyboard enter is not handled by default
404 bool Control::OnAccessibilityPan(PanGesture gesture)
406 return false; // Accessibility pan gesture is not handled by default
409 bool Control::OnAccessibilityTouch(const TouchEvent& touchEvent)
411 return false; // Accessibility touch event is not handled by default
414 bool Control::OnAccessibilityValueChange(bool isIncrease)
416 return false; // Accessibility value change action is not handled by default
419 bool Control::OnAccessibilityZoom()
421 return false; // Accessibility zoom action is not handled by default
424 Actor Control::GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled)
429 void Control::OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor)
433 Toolkit::Control::KeyEventSignalType& Control::KeyEventSignal()
435 return mImpl->mKeyEventSignal;
438 Toolkit::Control::KeyInputFocusSignalType& Control::KeyInputFocusGainedSignal()
440 return mImpl->mKeyInputFocusGainedSignal;
443 Toolkit::Control::KeyInputFocusSignalType& Control::KeyInputFocusLostSignal()
445 return mImpl->mKeyInputFocusLostSignal;
448 bool Control::EmitKeyEventSignal( const KeyEvent& event )
450 // Guard against destruction during signal emission
451 Dali::Toolkit::Control handle( GetOwner() );
453 bool consumed = false;
455 consumed = mImpl->FilterKeyEvent( event );
457 // signals are allocated dynamically when someone connects
458 if ( !consumed && !mImpl->mKeyEventSignal.Empty() )
460 consumed = mImpl->mKeyEventSignal.Emit( handle, event );
465 // Notification for derived classes
466 consumed = OnKeyEvent(event);
472 Control::Control( ControlBehaviour behaviourFlags )
473 : CustomActorImpl( static_cast< ActorFlags >( behaviourFlags ) ),
474 mImpl(new Impl(*this))
476 mImpl->mFlags = behaviourFlags;
484 void Control::Initialize()
486 // Call deriving classes so initialised before styling is applied to them.
489 if( (mImpl->mFlags & REQUIRES_STYLE_CHANGE_SIGNALS) ||
490 !(mImpl->mFlags & DISABLE_STYLE_CHANGE_SIGNALS) )
492 Toolkit::StyleManager styleManager = StyleManager::Get();
494 // if stylemanager is available
497 StyleManager& styleManagerImpl = GetImpl( styleManager );
499 // Register for style changes
500 styleManagerImpl.ControlStyleChangeSignal().Connect( this, &Control::OnStyleChange );
502 // Apply the current style
503 styleManagerImpl.ApplyThemeStyleAtInit( Toolkit::Control( GetOwner() ) );
507 if( mImpl->mFlags & REQUIRES_KEYBOARD_NAVIGATION_SUPPORT )
509 SetKeyboardNavigationSupport( true );
513 void Control::OnInitialize()
517 void Control::OnControlChildAdd( Actor& child )
521 void Control::OnControlChildRemove( Actor& child )
525 void Control::OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change )
527 // By default the control is only interested in theme (not font) changes
528 if( styleManager && change == StyleChange::THEME_CHANGE )
530 GetImpl( styleManager ).ApplyThemeStyle( Toolkit::Control( GetOwner() ) );
535 void Control::OnPinch(const PinchGesture& pinch)
537 if( !( mImpl->mStartingPinchScale ) )
540 mImpl->mStartingPinchScale = new Vector3;
543 if( pinch.state == Gesture::Started )
545 *( mImpl->mStartingPinchScale ) = Self().GetCurrentScale();
548 Self().SetScale( *( mImpl->mStartingPinchScale ) * pinch.scale );
551 void Control::OnPan( const PanGesture& pan )
555 void Control::OnTap(const TapGesture& tap)
559 void Control::OnLongPress( const LongPressGesture& longPress )
563 void Control::EmitKeyInputFocusSignal( bool focusGained )
565 Dali::Toolkit::Control handle( GetOwner() );
569 // signals are allocated dynamically when someone connects
570 if ( !mImpl->mKeyInputFocusGainedSignal.Empty() )
572 mImpl->mKeyInputFocusGainedSignal.Emit( handle );
577 // signals are allocated dynamically when someone connects
578 if ( !mImpl->mKeyInputFocusLostSignal.Empty() )
580 mImpl->mKeyInputFocusLostSignal.Emit( handle );
585 void Control::OnStageConnection( int depth )
587 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::OnStageConnection number of registered visuals(%d)\n", mImpl->mVisuals.Size() );
589 Actor self( Self() );
591 for(RegisteredVisualContainer::Iterator iter = mImpl->mVisuals.Begin(); iter!= mImpl->mVisuals.End(); iter++)
593 // Check whether the visual is empty and enabled
594 if( (*iter)->visual && (*iter)->enabled )
596 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::OnStageConnection Setting visual(%d) on stage\n", (*iter)->index );
597 Toolkit::GetImplementation((*iter)->visual).SetOnStage( self );
601 // The clipping renderer is only created if required.
602 CreateClippingRenderer( *this );
605 void Control::OnStageDisconnection()
607 mImpl->OnStageDisconnection();
610 void Control::OnKeyInputFocusGained()
612 EmitKeyInputFocusSignal( true );
615 void Control::OnKeyInputFocusLost()
617 EmitKeyInputFocusSignal( false );
620 void Control::OnChildAdd(Actor& child)
622 // Notify derived classes.
623 OnControlChildAdd( child );
626 void Control::OnChildRemove(Actor& child)
628 // Notify derived classes.
629 OnControlChildRemove( child );
632 void Control::OnPropertySet( Property::Index index, Property::Value propertyValue )
634 // If the clipping mode has been set, we may need to create a renderer.
635 // Only do this if we are already on-stage as the OnStageConnection will handle the off-stage clipping controls.
636 if( ( index == Actor::Property::CLIPPING_MODE ) && Self().OnStage() )
638 // Note: This method will handle whether creation of the renderer is required.
639 CreateClippingRenderer( *this );
643 void Control::OnSizeSet(const Vector3& targetSize)
645 Toolkit::Visual::Base visual = mImpl->GetVisual( Toolkit::Control::Property::BACKGROUND );
648 Vector2 size( targetSize );
649 SetBackgroundVisual( *mImpl, visual, size );
654 void Control::OnSizeAnimation(Animation& animation, const Vector3& targetSize)
656 // @todo size negotiate background to new size, animate as well?
659 bool Control::OnTouchEvent(const TouchEvent& event)
661 return false; // Do not consume
664 bool Control::OnHoverEvent(const HoverEvent& event)
666 return false; // Do not consume
669 bool Control::OnKeyEvent(const KeyEvent& event)
671 return false; // Do not consume
674 bool Control::OnWheelEvent(const WheelEvent& event)
676 return false; // Do not consume
679 void Control::OnRelayout( const Vector2& size, RelayoutContainer& container )
681 for( unsigned int i = 0, numChildren = Self().GetChildCount(); i < numChildren; ++i )
683 Actor child = Self().GetChildAt( i );
684 Vector2 newChildSize( size );
686 // When set the padding or margin on the control, child should be resized and repositioned.
687 if( ( mImpl->mPadding.start != 0 ) || ( mImpl->mPadding.end != 0 ) || ( mImpl->mPadding.top != 0 ) || ( mImpl->mPadding.bottom != 0 ) ||
688 ( mImpl->mMargin.start != 0 ) || ( mImpl->mMargin.end != 0 ) || ( mImpl->mMargin.top != 0 ) || ( mImpl->mMargin.bottom != 0 ) )
690 Extents padding = mImpl->mPadding;
692 Dali::CustomActor ownerActor(GetOwner());
693 Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>( ownerActor.GetProperty( Dali::Actor::Property::LAYOUT_DIRECTION ).Get<int>() );
695 if( Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection )
697 std::swap( padding.start, padding.end );
700 newChildSize.width = size.width - ( padding.start + padding.end );
701 newChildSize.height = size.height - ( padding.top + padding.bottom );
703 // Cannot use childs Position property as it can already have padding and margin applied on it,
704 // so we end up cumulatively applying them over and over again.
705 Vector2 childOffset( 0.f, 0.f );
706 childOffset.x += ( mImpl->mMargin.start + padding.start );
707 childOffset.y += ( mImpl->mMargin.top + padding.top );
709 child.SetPosition( childOffset.x, childOffset.y );
712 container.Add( child, newChildSize );
715 Toolkit::Visual::Base visual = mImpl->GetVisual( Toolkit::Control::Property::BACKGROUND );
718 SetBackgroundVisual( *mImpl, visual, size );
722 void Control::OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension )
726 Vector3 Control::GetNaturalSize()
728 Toolkit::Visual::Base visual = mImpl->GetVisual( Toolkit::Control::Property::BACKGROUND );
732 visual.GetNaturalSize( naturalSize );
733 naturalSize.width += ( mImpl->mPadding.start + mImpl->mPadding.end );
734 naturalSize.height += ( mImpl->mPadding.top + mImpl->mPadding.bottom );
735 return Vector3( naturalSize );
737 return Vector3::ZERO;
740 float Control::CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension )
742 return CalculateChildSizeBase( child, dimension );
745 float Control::GetHeightForWidth( float width )
747 return GetHeightForWidthBase( width );
750 float Control::GetWidthForHeight( float height )
752 return GetWidthForHeightBase( height );
755 bool Control::RelayoutDependentOnChildren( Dimension::Type dimension )
757 return RelayoutDependentOnChildrenBase( dimension );
760 void Control::OnCalculateRelayoutSize( Dimension::Type dimension )
764 void Control::OnLayoutNegotiated( float size, Dimension::Type dimension )
768 void Control::SignalConnected( SlotObserver* slotObserver, CallbackBase* callback )
770 mImpl->SignalConnected( slotObserver, callback );
773 void Control::SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback )
775 mImpl->SignalDisconnected( slotObserver, callback );
778 Control& GetImplementation( Dali::Toolkit::Control& handle )
780 CustomActorImpl& customInterface = handle.GetImplementation();
781 // downcast to control
782 Control& impl = dynamic_cast< Internal::Control& >( customInterface );
786 const Control& GetImplementation( const Dali::Toolkit::Control& handle )
788 const CustomActorImpl& customInterface = handle.GetImplementation();
789 // downcast to control
790 const Control& impl = dynamic_cast< const Internal::Control& >( customInterface );
794 } // namespace Internal
796 } // namespace Toolkit