2 * Copyright (c) 2020 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 <dali/devel-api/scripting/scripting.h>
23 #include <dali/integration-api/debug.h>
24 #include <dali/public-api/animation/constraint.h>
25 #include <dali/public-api/object/type-registry-helper.h>
26 #include <dali/public-api/size-negotiation/relayout-container.h>
27 #include <cstring> // for strcmp
31 #include <dali/public-api/object/type-info.h>
32 #include <dali/devel-api/common/stage.h>
33 #include <dali/devel-api/actors/actor-devel.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/focus-manager/keyinput-focus-manager.h>
39 #include <dali-toolkit/devel-api/visuals/color-visual-actions-devel.h>
40 #include <dali-toolkit/devel-api/visuals/color-visual-properties-devel.h>
41 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
42 #include <dali-toolkit/internal/styling/style-manager-impl.h>
43 #include <dali-toolkit/internal/visuals/color/color-visual.h>
44 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
45 #include <dali-toolkit/public-api/align-enumerations.h>
46 #include <dali-toolkit/public-api/controls/control.h>
47 #include <dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h>
48 #include <dali-toolkit/public-api/styling/style-manager.h>
49 #include <dali-toolkit/public-api/visuals/color-visual-properties.h>
50 #include <dali-toolkit/public-api/visuals/visual-properties.h>
51 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
52 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
53 #include <dali-toolkit/dali-toolkit.h>
63 #if defined(DEBUG_ENABLED)
64 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_CONTROL_VISUALS");
68 * @brief Replace the background visual if it's a color visual with the renderIfTransparent property set as required.
69 * @param[in] controlImpl The control implementation
70 * @param[in] renderIfTransaparent Whether we should render if the color is transparent
72 void ChangeBackgroundColorVisual(Control& controlImpl, bool renderIfTransparent)
74 Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(controlImpl);
76 Toolkit::Visual::Base backgroundVisual = controlDataImpl.GetVisual(Toolkit::Control::Property::BACKGROUND);
77 if(backgroundVisual && backgroundVisual.GetType() == Toolkit::Visual::COLOR)
80 backgroundVisual.CreatePropertyMap(map);
82 // Only change it if it's a color visual
83 map[Toolkit::DevelColorVisual::Property::RENDER_IF_TRANSPARENT] = renderIfTransparent;
84 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))
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
134 Toolkit::Control Control::New()
136 // Create the implementation, temporarily owned on stack
137 IntrusivePtr<Control> controlImpl = new Control(ControlBehaviour(CONTROL_BEHAVIOUR_DEFAULT));
139 // Pass ownership to handle
140 Toolkit::Control handle(*controlImpl);
142 // Second-phase init of the implementation
143 // This can only be done after the CustomActor connection has been made...
144 controlImpl->Initialize();
149 void Control::SetStyleName(const std::string& styleName)
151 if(styleName != mImpl->mStyleName)
153 mImpl->mStyleName = styleName;
155 // Apply new style, if stylemanager is available
156 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
159 GetImpl(styleManager).ApplyThemeStyle(Toolkit::Control(GetOwner()));
164 const std::string& Control::GetStyleName() const
166 return mImpl->mStyleName;
169 void Control::SetBackgroundColor(const Vector4& color)
171 mImpl->mBackgroundColor = color;
174 map[Toolkit::Visual::Property::TYPE] = Toolkit::Visual::COLOR;
175 map[Toolkit::ColorVisual::Property::MIX_COLOR] = color;
177 bool renderIfTransparent = false;
178 int clippingMode = ClippingMode::DISABLED;
179 if((Self().GetProperty(Actor::Property::CLIPPING_MODE).Get(clippingMode)) &&
180 (clippingMode == ClippingMode::CLIP_CHILDREN))
182 // If clipping-mode is set to CLIP_CHILDREN, then force visual to add the render even if transparent
183 map[Toolkit::DevelColorVisual::Property::RENDER_IF_TRANSPARENT] = true;
184 renderIfTransparent = true;
187 Toolkit::Visual::Base visual = mImpl->GetVisual(Toolkit::Control::Property::BACKGROUND);
188 if(visual && visual.GetType() == Toolkit::Visual::COLOR)
190 Property::Map visualMap;
191 visual.CreatePropertyMap(visualMap);
193 Property::Value* renderValue = visualMap.Find(Toolkit::DevelColorVisual::Property::RENDER_IF_TRANSPARENT);
194 Property::Value* colorValue = visualMap.Find(Toolkit::ColorVisual::Property::MIX_COLOR);
195 if(renderValue && colorValue)
197 if((renderValue->Get<bool>() == true || colorValue->Get<Vector4>().a > 0.0f) && (renderIfTransparent || color.a > 0.0f))
199 // Update background color only
200 mImpl->DoAction(Toolkit::Control::Property::BACKGROUND, DevelColorVisual::Action::UPDATE_PROPERTY, map);
209 void Control::SetBackground(const Property::Map& map)
211 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual(map);
212 visual.SetName("background");
215 mImpl->RegisterVisual(Toolkit::Control::Property::BACKGROUND, visual, DepthIndex::BACKGROUND);
217 // Trigger a size negotiation request that may be needed by the new visual to relayout its contents.
222 void Control::ClearBackground()
224 mImpl->UnregisterVisual(Toolkit::Control::Property::BACKGROUND);
225 mImpl->mBackgroundColor = Color::TRANSPARENT;
227 // Trigger a size negotiation request that may be needed when unregistering a visual.
231 void Control::EnableGestureDetection(GestureType::Value type)
233 if((type & GestureType::PINCH) && !mImpl->mPinchGestureDetector)
235 mImpl->mPinchGestureDetector = PinchGestureDetector::New();
236 mImpl->mPinchGestureDetector.DetectedSignal().Connect(mImpl, &Impl::PinchDetected);
237 mImpl->mPinchGestureDetector.Attach(Self());
240 if((type & GestureType::PAN) && !mImpl->mPanGestureDetector)
242 mImpl->mPanGestureDetector = PanGestureDetector::New();
243 mImpl->mPanGestureDetector.SetMaximumTouchesRequired(2);
244 mImpl->mPanGestureDetector.DetectedSignal().Connect(mImpl, &Impl::PanDetected);
245 mImpl->mPanGestureDetector.Attach(Self());
248 if((type & GestureType::TAP) && !mImpl->mTapGestureDetector)
250 mImpl->mTapGestureDetector = TapGestureDetector::New();
251 mImpl->mTapGestureDetector.DetectedSignal().Connect(mImpl, &Impl::TapDetected);
252 mImpl->mTapGestureDetector.Attach(Self());
255 if((type & GestureType::LONG_PRESS) && !mImpl->mLongPressGestureDetector)
257 mImpl->mLongPressGestureDetector = LongPressGestureDetector::New();
258 mImpl->mLongPressGestureDetector.DetectedSignal().Connect(mImpl, &Impl::LongPressDetected);
259 mImpl->mLongPressGestureDetector.Attach(Self());
263 void Control::DisableGestureDetection(GestureType::Value type)
265 if((type & GestureType::PINCH) && mImpl->mPinchGestureDetector)
267 mImpl->mPinchGestureDetector.Detach(Self());
268 mImpl->mPinchGestureDetector.Reset();
271 if((type & GestureType::PAN) && mImpl->mPanGestureDetector)
273 mImpl->mPanGestureDetector.Detach(Self());
274 mImpl->mPanGestureDetector.Reset();
277 if((type & GestureType::TAP) && mImpl->mTapGestureDetector)
279 mImpl->mTapGestureDetector.Detach(Self());
280 mImpl->mTapGestureDetector.Reset();
283 if((type & GestureType::LONG_PRESS) && 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().GetProperty<bool>(Actor::Property::CONNECTED_TO_SCENE))
324 Toolkit::KeyInputFocusManager::Get().SetFocus(Toolkit::Control::DownCast(Self()));
328 bool Control::HasKeyInputFocus()
331 if(Self().GetProperty<bool>(Actor::Property::CONNECTED_TO_SCENE))
333 Toolkit::Control control = Toolkit::KeyInputFocusManager::Get().GetCurrentFocusControl();
334 if(Self() == control)
342 void Control::ClearKeyInputFocus()
344 if(Self().GetProperty<bool>(Actor::Property::CONNECTED_TO_SCENE))
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 if( Toolkit::KeyboardFocusManager::Get().SetCurrentFocusActor( Self() ) )
379 return OnKeyboardEnter();
384 bool Control::OnKeyboardEnter()
386 return false; // Keyboard enter is not handled by default
389 bool Control::OnAccessibilityPan(PanGesture gesture)
391 return false; // Accessibility pan gesture is not handled by default
394 bool Control::OnAccessibilityValueChange(bool isIncrease)
396 return false; // Accessibility value change action is not handled by default
399 bool Control::OnAccessibilityZoom()
401 return false; // Accessibility zoom action is not handled by default
404 Actor Control::GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled)
409 void Control::OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor)
413 Toolkit::Control::KeyEventSignalType& Control::KeyEventSignal()
415 return mImpl->mKeyEventSignal;
418 Toolkit::Control::KeyInputFocusSignalType& Control::KeyInputFocusGainedSignal()
420 return mImpl->mKeyInputFocusGainedSignal;
423 Toolkit::Control::KeyInputFocusSignalType& Control::KeyInputFocusLostSignal()
425 return mImpl->mKeyInputFocusLostSignal;
428 bool Control::EmitKeyEventSignal(const KeyEvent& event)
430 // Guard against destruction during signal emission
431 Dali::Toolkit::Control handle(GetOwner());
433 bool consumed = false;
435 consumed = mImpl->FilterKeyEvent(event);
437 // signals are allocated dynamically when someone connects
438 if(!consumed && !mImpl->mKeyEventSignal.Empty())
440 consumed = mImpl->mKeyEventSignal.Emit(handle, event);
445 // Notification for derived classes
446 consumed = OnKeyEvent(event);
452 Control::Control(ControlBehaviour behaviourFlags)
453 : CustomActorImpl(static_cast<ActorFlags>(behaviourFlags)),
454 mImpl(new Impl(*this))
456 mImpl->mFlags = behaviourFlags;
464 void Control::Initialize()
466 // Call deriving classes so initialised before styling is applied to them.
469 if(!(mImpl->mFlags & DISABLE_STYLE_CHANGE_SIGNALS))
471 Toolkit::StyleManager styleManager = StyleManager::Get();
473 // if stylemanager is available
476 StyleManager& styleManagerImpl = GetImpl(styleManager);
478 // Register for style changes
479 styleManagerImpl.ControlStyleChangeSignal().Connect(this, &Control::OnStyleChange);
481 // Apply the current style
482 styleManagerImpl.ApplyThemeStyleAtInit(Toolkit::Control(GetOwner()));
486 if(mImpl->mFlags & REQUIRES_KEYBOARD_NAVIGATION_SUPPORT)
488 SetKeyboardNavigationSupport(true);
492 Self().GetTypeInfo( type );
495 auto typeName = type.GetName();
496 DevelControl::AppendAccessibilityAttribute( Self(), "t", typeName );
499 if (Accessibility::IsUp())
500 mImpl->AccessibilityRegister();
503 void Control::OnInitialize()
507 void Control::OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change)
509 // By default the control is only interested in theme (not font) changes
510 if(styleManager && change == StyleChange::THEME_CHANGE)
512 GetImpl(styleManager).ApplyThemeStyle(Toolkit::Control(GetOwner()));
517 void Control::OnPinch(const PinchGesture& pinch)
519 if(!(mImpl->mStartingPinchScale))
522 mImpl->mStartingPinchScale = new Vector3;
525 if(pinch.GetState() == GestureState::STARTED)
527 *(mImpl->mStartingPinchScale) = Self().GetCurrentProperty<Vector3>(Actor::Property::SCALE);
530 Self().SetProperty(Actor::Property::SCALE, *(mImpl->mStartingPinchScale) * pinch.GetScale());
533 void Control::OnPan(const PanGesture& pan)
537 void Control::OnTap(const TapGesture& tap)
541 void Control::OnLongPress(const LongPressGesture& longPress)
545 void Control::EmitKeyInputFocusSignal(bool focusGained)
547 Dali::Toolkit::Control handle(GetOwner());
549 if( Accessibility::IsUp() )
551 auto self = mImpl->GetAccessibilityObject( Self() );
552 self->EmitFocused( focusGained );
553 auto parent = self->GetParent();
554 if( parent && !self->GetStates()[Dali::Accessibility::State::MANAGES_DESCENDANTS] )
556 parent->EmitActiveDescendantChanged( parent, self );
562 // signals are allocated dynamically when someone connects
563 if(!mImpl->mKeyInputFocusGainedSignal.Empty())
565 mImpl->mKeyInputFocusGainedSignal.Emit(handle);
570 // signals are allocated dynamically when someone connects
571 if(!mImpl->mKeyInputFocusLostSignal.Empty())
573 mImpl->mKeyInputFocusLostSignal.Emit(handle);
578 void Control::OnSceneConnection(int depth)
580 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Control::OnSceneConnection number of registered visuals(%d)\n", mImpl->mVisuals.Size());
584 for(RegisteredVisualContainer::Iterator iter = mImpl->mVisuals.Begin(); iter != mImpl->mVisuals.End(); iter++)
586 // Check whether the visual is empty and enabled
587 if((*iter)->visual && (*iter)->enabled)
589 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Control::OnSceneConnection Setting visual(%d) on scene\n", (*iter)->index);
590 Toolkit::GetImplementation((*iter)->visual).SetOnScene(self);
594 // The clipping renderer is only created if required.
595 CreateClippingRenderer(*this);
597 // Request to be laid out when the control is connected to the Scene.
598 // Signal that a Relayout may be needed
599 if( Accessibility::IsUp() )
601 mImpl->AccessibilityRegister();
605 void Control::OnSceneDisconnection()
607 if( Accessibility::IsUp() )
609 mImpl->AccessibilityDeregister();
611 mImpl->OnSceneDisconnection();
614 void Control::OnKeyInputFocusGained()
616 EmitKeyInputFocusSignal(true);
619 void Control::OnKeyInputFocusLost()
621 EmitKeyInputFocusSignal(false);
624 void Control::OnChildAdd(Actor& child)
628 void Control::OnChildRemove(Actor& child)
632 void Control::OnPropertySet(Property::Index index, const 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 OnSceneConnection will handle the off-stage clipping controls.
638 case Actor::Property::CLIPPING_MODE:
640 if( Self().GetProperty< bool >( Actor::Property::CONNECTED_TO_SCENE ))
642 // Note: This method will handle whether creation of the renderer is required.
643 CreateClippingRenderer( *this );
647 case Actor::Property::VISIBLE:
649 if( Dali::Accessibility::IsUp() )
651 Dali::Accessibility::Accessible::Get(Self())->EmitVisible( Self().GetProperty( Actor::Property::VISIBLE ).Get<bool>() );
655 case Toolkit::DevelControl::Property::ACCESSIBILITY_ROLE:
657 if( Dali::Accessibility::IsUp() )
659 Dali::Accessibility::Accessible::Get(Self())->Emit( Dali::Accessibility::ObjectPropertyChangeEvent::ROLE );
666 void Control::OnSizeSet(const Vector3& targetSize)
668 Toolkit::Visual::Base visual = mImpl->GetVisual(Toolkit::Control::Property::BACKGROUND);
671 Vector2 size(targetSize);
672 visual.SetTransformAndSize(Property::Map(), size); // Send an empty map as we do not want to modify the visual's set transform
676 void Control::OnSizeAnimation(Animation& animation, const Vector3& targetSize)
678 // @todo size negotiate background to new size, animate as well?
681 bool Control::OnKeyEvent(const KeyEvent& event)
683 return false; // Do not consume
686 void Control::OnRelayout(const Vector2& size, RelayoutContainer& container)
688 for(unsigned int i = 0, numChildren = Self().GetChildCount(); i < numChildren; ++i)
690 Actor child = Self().GetChildAt(i);
691 Vector2 newChildSize(size);
693 // When set the padding or margin on the control, child should be resized and repositioned.
694 if((mImpl->mPadding.start != 0) || (mImpl->mPadding.end != 0) || (mImpl->mPadding.top != 0) || (mImpl->mPadding.bottom != 0) ||
695 (mImpl->mMargin.start != 0) || (mImpl->mMargin.end != 0) || (mImpl->mMargin.top != 0) || (mImpl->mMargin.bottom != 0))
697 Extents padding = mImpl->mPadding;
699 Dali::CustomActor ownerActor(GetOwner());
700 Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>(ownerActor.GetProperty(Dali::Actor::Property::LAYOUT_DIRECTION).Get<int>());
702 if(Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection)
704 std::swap(padding.start, padding.end);
707 newChildSize.width = size.width - (padding.start + padding.end);
708 newChildSize.height = size.height - (padding.top + padding.bottom);
710 // Cannot use childs Position property as it can already have padding and margin applied on it,
711 // so we end up cumulatively applying them over and over again.
712 Vector2 childOffset(0.f, 0.f);
713 childOffset.x += (mImpl->mMargin.start + padding.start);
714 childOffset.y += (mImpl->mMargin.top + padding.top);
716 child.SetProperty(Actor::Property::POSITION, Vector2(childOffset.x, childOffset.y));
718 container.Add(child, newChildSize);
721 Toolkit::Visual::Base visual = mImpl->GetVisual(Toolkit::Control::Property::BACKGROUND);
724 visual.SetTransformAndSize(Property::Map(), size); // Send an empty map as we do not want to modify the visual's set transform
728 void Control::OnSetResizePolicy(ResizePolicy::Type policy, Dimension::Type dimension)
732 Vector3 Control::GetNaturalSize()
734 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Control::GetNaturalSize for %s\n", Self().GetProperty<std::string>(Dali::Actor::Property::NAME).c_str());
735 Toolkit::Visual::Base visual = mImpl->GetVisual(Toolkit::Control::Property::BACKGROUND);
739 visual.GetNaturalSize(naturalSize);
740 naturalSize.width += (mImpl->mPadding.start + mImpl->mPadding.end);
741 naturalSize.height += (mImpl->mPadding.top + mImpl->mPadding.bottom);
742 return Vector3(naturalSize);
744 return Vector3::ZERO;
747 float Control::CalculateChildSize(const Dali::Actor& child, Dimension::Type dimension)
749 return CalculateChildSizeBase(child, dimension);
752 float Control::GetHeightForWidth(float width)
754 return GetHeightForWidthBase(width);
757 float Control::GetWidthForHeight(float height)
759 return GetWidthForHeightBase(height);
762 bool Control::RelayoutDependentOnChildren(Dimension::Type dimension)
764 return RelayoutDependentOnChildrenBase(dimension);
767 void Control::OnCalculateRelayoutSize(Dimension::Type dimension)
771 void Control::OnLayoutNegotiated(float size, Dimension::Type dimension)
775 void Control::SignalConnected(SlotObserver* slotObserver, CallbackBase* callback)
777 mImpl->SignalConnected(slotObserver, callback);
780 void Control::SignalDisconnected(SlotObserver* slotObserver, CallbackBase* callback)
782 mImpl->SignalDisconnected(slotObserver, callback);
785 Control& GetImplementation(Dali::Toolkit::Control& handle)
787 CustomActorImpl& customInterface = handle.GetImplementation();
788 // downcast to control
789 Control& impl = dynamic_cast<Internal::Control&>(customInterface);
793 const Control& GetImplementation(const Dali::Toolkit::Control& handle)
795 const CustomActorImpl& customInterface = handle.GetImplementation();
796 // downcast to control
797 const Control& impl = dynamic_cast<const Internal::Control&>(customInterface);
801 } // namespace Internal
803 } // namespace Toolkit