2 * Copyright (c) 2021 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/actors/actor-devel.h>
23 #include <dali/devel-api/common/stage.h>
24 #include <dali/devel-api/scripting/scripting.h>
25 #include <dali/integration-api/debug.h>
26 #include <dali/public-api/animation/constraint.h>
27 #include <dali/public-api/object/type-info.h>
28 #include <dali/public-api/object/type-registry-helper.h>
29 #include <dali/public-api/size-negotiation/relayout-container.h>
30 #include <cstring> // for strcmp
36 #include <dali-toolkit/dali-toolkit.h>
37 #include <dali-toolkit/devel-api/controls/control-depth-index-ranges.h>
38 #include <dali-toolkit/devel-api/controls/control-devel.h>
39 #include <dali-toolkit/devel-api/focus-manager/keyinput-focus-manager.h>
40 #include <dali-toolkit/devel-api/visuals/color-visual-actions-devel.h>
41 #include <dali-toolkit/devel-api/visuals/color-visual-properties-devel.h>
42 #include <dali-toolkit/internal/controls/control/control-data-impl.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/public-api/align-enumerations.h>
47 #include <dali-toolkit/public-api/controls/control.h>
48 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
49 #include <dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h>
50 #include <dali-toolkit/public-api/styling/style-manager.h>
51 #include <dali-toolkit/public-api/visuals/color-visual-properties.h>
52 #include <dali-toolkit/public-api/visuals/visual-properties.h>
62 #if defined(DEBUG_ENABLED)
63 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_CONTROL_VISUALS");
67 * @brief Replace the background visual if it's a color visual with the renderIfTransparent property set as required.
68 * @param[in] controlImpl The control implementation
69 * @param[in] renderIfTransaparent Whether we should render if the color is transparent
71 void ChangeBackgroundColorVisual(Control& controlImpl, bool renderIfTransparent)
73 Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(controlImpl);
75 Toolkit::Visual::Base backgroundVisual = controlDataImpl.GetVisual(Toolkit::Control::Property::BACKGROUND);
76 if(backgroundVisual && backgroundVisual.GetType() == Toolkit::Visual::COLOR)
79 backgroundVisual.CreatePropertyMap(map);
81 // Only change it if it's a color visual
82 map[Toolkit::DevelColorVisual::Property::RENDER_IF_TRANSPARENT] = renderIfTransparent;
83 controlImpl.SetBackground(map);
88 * @brief Creates a clipping renderer if required.
89 * (EG. If no renders exist and clipping is enabled).
90 * @param[in] controlImpl The control implementation.
92 void CreateClippingRenderer(Control& controlImpl)
94 // We want to add a transparent background if we do not have one for clipping.
95 Actor self(controlImpl.Self());
96 int clippingMode = ClippingMode::DISABLED;
97 if(self.GetProperty(Actor::Property::CLIPPING_MODE).Get(clippingMode))
101 case ClippingMode::CLIP_CHILDREN:
103 if(self.GetRendererCount() == 0u)
105 Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(controlImpl);
106 if(controlDataImpl.mVisuals.Empty())
108 controlImpl.SetBackgroundColor(Color::TRANSPARENT);
112 // We have visuals, check if we've set the background and re-create it to
113 // render even if transparent (only if it's a color visual)
114 ChangeBackgroundColorVisual(controlImpl, true);
120 case ClippingMode::DISABLED:
121 case ClippingMode::CLIP_TO_BOUNDING_BOX:
123 // If we have a background visual, check if it's a color visual and remove the render if transparent flag
124 ChangeBackgroundColorVisual(controlImpl, false);
131 } // unnamed namespace
133 Toolkit::Control Control::New()
135 // Create the implementation, temporarily owned on stack
136 IntrusivePtr<Control> controlImpl = new Control(ControlBehaviour(CONTROL_BEHAVIOUR_DEFAULT));
138 // Pass ownership to handle
139 Toolkit::Control handle(*controlImpl);
141 // Second-phase init of the implementation
142 // This can only be done after the CustomActor connection has been made...
143 controlImpl->Initialize();
148 void Control::SetStyleName(const std::string& styleName)
150 if(styleName != mImpl->mStyleName)
152 mImpl->mStyleName = styleName;
154 // Apply new style, if stylemanager is available
155 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
158 GetImpl(styleManager).ApplyThemeStyle(Toolkit::Control(GetOwner()));
163 const std::string& Control::GetStyleName() const
165 return mImpl->mStyleName;
168 void Control::SetBackgroundColor(const Vector4& color)
170 mImpl->mBackgroundColor = color;
173 map[Toolkit::Visual::Property::TYPE] = Toolkit::Visual::COLOR;
174 map[Toolkit::ColorVisual::Property::MIX_COLOR] = color;
176 bool renderIfTransparent = false;
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;
183 renderIfTransparent = true;
186 Toolkit::Visual::Base visual = mImpl->GetVisual(Toolkit::Control::Property::BACKGROUND);
187 if(visual && visual.GetType() == Toolkit::Visual::COLOR)
189 Property::Map visualMap;
190 visual.CreatePropertyMap(visualMap);
192 Property::Value* renderValue = visualMap.Find(Toolkit::DevelColorVisual::Property::RENDER_IF_TRANSPARENT);
193 Property::Value* colorValue = visualMap.Find(Toolkit::ColorVisual::Property::MIX_COLOR);
194 if(renderValue && colorValue)
196 if((renderValue->Get<bool>() == true || colorValue->Get<Vector4>().a > 0.0f) && (renderIfTransparent || color.a > 0.0f))
198 // Update background color only
199 mImpl->DoAction(Toolkit::Control::Property::BACKGROUND, DevelColorVisual::Action::UPDATE_PROPERTY, map);
208 void Control::SetBackground(const Property::Map& map)
210 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual(map);
211 visual.SetName("background");
214 mImpl->RegisterVisual(Toolkit::Control::Property::BACKGROUND, visual, DepthIndex::BACKGROUND);
216 // Trigger a size negotiation request that may be needed by the new visual to relayout its contents.
221 void Control::ClearBackground()
223 mImpl->UnregisterVisual(Toolkit::Control::Property::BACKGROUND);
224 mImpl->mBackgroundColor = Color::TRANSPARENT;
226 // Trigger a size negotiation request that may be needed when unregistering a visual.
230 void Control::EnableGestureDetection(GestureType::Value type)
232 if((type & GestureType::PINCH) && !mImpl->mPinchGestureDetector)
234 mImpl->mPinchGestureDetector = PinchGestureDetector::New();
235 mImpl->mPinchGestureDetector.DetectedSignal().Connect(mImpl, &Impl::PinchDetected);
236 mImpl->mPinchGestureDetector.Attach(Self());
239 if((type & GestureType::PAN) && !mImpl->mPanGestureDetector)
241 mImpl->mPanGestureDetector = PanGestureDetector::New();
242 mImpl->mPanGestureDetector.SetMaximumTouchesRequired(2);
243 mImpl->mPanGestureDetector.DetectedSignal().Connect(mImpl, &Impl::PanDetected);
244 mImpl->mPanGestureDetector.Attach(Self());
247 if((type & GestureType::TAP) && !mImpl->mTapGestureDetector)
249 mImpl->mTapGestureDetector = TapGestureDetector::New();
250 mImpl->mTapGestureDetector.DetectedSignal().Connect(mImpl, &Impl::TapDetected);
251 mImpl->mTapGestureDetector.Attach(Self());
254 if((type & GestureType::LONG_PRESS) && !mImpl->mLongPressGestureDetector)
256 mImpl->mLongPressGestureDetector = LongPressGestureDetector::New();
257 mImpl->mLongPressGestureDetector.DetectedSignal().Connect(mImpl, &Impl::LongPressDetected);
258 mImpl->mLongPressGestureDetector.Attach(Self());
262 void Control::DisableGestureDetection(GestureType::Value type)
264 if((type & GestureType::PINCH) && mImpl->mPinchGestureDetector)
266 mImpl->mPinchGestureDetector.Detach(Self());
267 mImpl->mPinchGestureDetector.Reset();
270 if((type & GestureType::PAN) && mImpl->mPanGestureDetector)
272 mImpl->mPanGestureDetector.Detach(Self());
273 mImpl->mPanGestureDetector.Reset();
276 if((type & GestureType::TAP) && mImpl->mTapGestureDetector)
278 mImpl->mTapGestureDetector.Detach(Self());
279 mImpl->mTapGestureDetector.Reset();
282 if((type & GestureType::LONG_PRESS) && mImpl->mLongPressGestureDetector)
284 mImpl->mLongPressGestureDetector.Detach(Self());
285 mImpl->mLongPressGestureDetector.Reset();
289 PinchGestureDetector Control::GetPinchGestureDetector() const
291 return mImpl->mPinchGestureDetector;
294 PanGestureDetector Control::GetPanGestureDetector() const
296 return mImpl->mPanGestureDetector;
299 TapGestureDetector Control::GetTapGestureDetector() const
301 return mImpl->mTapGestureDetector;
304 LongPressGestureDetector Control::GetLongPressGestureDetector() const
306 return mImpl->mLongPressGestureDetector;
309 void Control::SetKeyboardNavigationSupport(bool isSupported)
311 mImpl->mIsKeyboardNavigationSupported = isSupported;
314 bool Control::IsKeyboardNavigationSupported()
316 return mImpl->mIsKeyboardNavigationSupported;
319 void Control::SetKeyInputFocus()
321 if(Self().GetProperty<bool>(Actor::Property::CONNECTED_TO_SCENE))
323 Toolkit::KeyInputFocusManager::Get().SetFocus(Toolkit::Control::DownCast(Self()));
327 bool Control::HasKeyInputFocus()
330 if(Self().GetProperty<bool>(Actor::Property::CONNECTED_TO_SCENE))
332 Toolkit::Control control = Toolkit::KeyInputFocusManager::Get().GetCurrentFocusControl();
333 if(Self() == control)
341 void Control::ClearKeyInputFocus()
343 if(Self().GetProperty<bool>(Actor::Property::CONNECTED_TO_SCENE))
345 Toolkit::KeyInputFocusManager::Get().RemoveFocus(Toolkit::Control::DownCast(Self()));
349 void Control::SetAsKeyboardFocusGroup(bool isFocusGroup)
351 mImpl->mIsKeyboardFocusGroup = isFocusGroup;
353 // The following line will be removed when the deprecated API in KeyboardFocusManager is deleted
354 Toolkit::KeyboardFocusManager::Get().SetAsFocusGroup(Self(), isFocusGroup);
357 bool Control::IsKeyboardFocusGroup()
359 return Toolkit::KeyboardFocusManager::Get().IsFocusGroup(Self());
362 void Control::AccessibilityActivate()
364 // Inform deriving classes
365 OnAccessibilityActivated();
368 void Control::KeyboardEnter()
370 // Inform deriving classes
374 bool Control::OnAccessibilityActivated()
376 if(Toolkit::KeyboardFocusManager::Get().SetCurrentFocusActor(Self()))
378 return OnKeyboardEnter();
383 bool Control::OnKeyboardEnter()
385 return false; // Keyboard enter is not handled by default
388 bool Control::OnAccessibilityPan(PanGesture gesture)
390 return false; // Accessibility pan gesture is not handled by default
393 bool Control::OnAccessibilityValueChange(bool isIncrease)
395 return false; // Accessibility value change action is not handled by default
398 bool Control::OnAccessibilityZoom()
400 return false; // Accessibility zoom action is not handled by default
403 Actor Control::GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled)
408 void Control::OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor)
412 Toolkit::Control::KeyEventSignalType& Control::KeyEventSignal()
414 return mImpl->mKeyEventSignal;
417 Toolkit::Control::KeyInputFocusSignalType& Control::KeyInputFocusGainedSignal()
419 return mImpl->mKeyInputFocusGainedSignal;
422 Toolkit::Control::KeyInputFocusSignalType& Control::KeyInputFocusLostSignal()
424 return mImpl->mKeyInputFocusLostSignal;
427 bool Control::EmitKeyEventSignal(const KeyEvent& event)
429 // Guard against destruction during signal emission
430 Dali::Toolkit::Control handle(GetOwner());
432 bool consumed = false;
434 consumed = mImpl->FilterKeyEvent(event);
436 // signals are allocated dynamically when someone connects
437 if(!consumed && !mImpl->mKeyEventSignal.Empty())
439 consumed = mImpl->mKeyEventSignal.Emit(handle, event);
444 // Notification for derived classes
445 consumed = OnKeyEvent(event);
451 Control::Control(ControlBehaviour behaviourFlags)
452 : CustomActorImpl(static_cast<ActorFlags>(behaviourFlags)),
453 mImpl(new Impl(*this))
455 mImpl->mFlags = behaviourFlags;
463 void Control::Initialize()
465 // Call deriving classes so initialised before styling is applied to them.
468 if(!(mImpl->mFlags & DISABLE_STYLE_CHANGE_SIGNALS))
470 Toolkit::StyleManager styleManager = StyleManager::Get();
472 // if stylemanager is available
475 StyleManager& styleManagerImpl = GetImpl(styleManager);
477 // Register for style changes
478 styleManagerImpl.ControlStyleChangeSignal().Connect(this, &Control::OnStyleChange);
480 // Apply the current style
481 styleManagerImpl.ApplyThemeStyleAtInit(Toolkit::Control(GetOwner()));
485 if(mImpl->mFlags & REQUIRES_KEYBOARD_NAVIGATION_SUPPORT)
487 SetKeyboardNavigationSupport(true);
491 Self().GetTypeInfo(type);
494 auto typeName = type.GetName();
495 DevelControl::AppendAccessibilityAttribute(Self(), "class", typeName);
498 if(Accessibility::IsUp())
499 mImpl->AccessibilityRegister();
502 void Control::OnInitialize()
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.GetState() == GestureState::STARTED)
526 *(mImpl->mStartingPinchScale) = Self().GetCurrentProperty<Vector3>(Actor::Property::SCALE);
529 Self().SetProperty(Actor::Property::SCALE, *(mImpl->mStartingPinchScale) * pinch.GetScale());
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());
548 if(Accessibility::IsUp())
550 auto self = mImpl->GetAccessibilityObject(Self());
551 self->EmitFocused(focusGained);
552 auto parent = self->GetParent();
553 if(parent && !self->GetStates()[Dali::Accessibility::State::MANAGES_DESCENDANTS])
555 parent->EmitActiveDescendantChanged(parent, self);
561 // signals are allocated dynamically when someone connects
562 if(!mImpl->mKeyInputFocusGainedSignal.Empty())
564 mImpl->mKeyInputFocusGainedSignal.Emit(handle);
569 // signals are allocated dynamically when someone connects
570 if(!mImpl->mKeyInputFocusLostSignal.Empty())
572 mImpl->mKeyInputFocusLostSignal.Emit(handle);
577 void Control::OnSceneConnection(int depth)
579 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Control::OnSceneConnection number of registered visuals(%d)\n", mImpl->mVisuals.Size());
583 for(RegisteredVisualContainer::Iterator iter = mImpl->mVisuals.Begin(); iter != mImpl->mVisuals.End(); iter++)
585 // Check whether the visual is empty and enabled
586 if((*iter)->visual && (*iter)->enabled)
588 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Control::OnSceneConnection Setting visual(%d) on scene\n", (*iter)->index);
589 Toolkit::GetImplementation((*iter)->visual).SetOnScene(self);
593 // The clipping renderer is only created if required.
594 CreateClippingRenderer(*this);
596 // Request to be laid out when the control is connected to the Scene.
597 // Signal that a Relayout may be needed
598 if(Accessibility::IsUp())
600 mImpl->AccessibilityRegister();
604 void Control::OnSceneDisconnection()
606 if(Accessibility::IsUp())
608 mImpl->AccessibilityDeregister(true);
610 mImpl->OnSceneDisconnection();
613 void Control::OnKeyInputFocusGained()
615 EmitKeyInputFocusSignal(true);
618 void Control::OnKeyInputFocusLost()
620 EmitKeyInputFocusSignal(false);
623 void Control::OnChildAdd(Actor& child)
627 void Control::OnChildRemove(Actor& child)
631 void Control::OnPropertySet(Property::Index index, const Property::Value& propertyValue)
633 // If the clipping mode has been set, we may need to create a renderer.
634 // Only do this if we are already on-stage as the OnSceneConnection will handle the off-stage clipping controls.
637 case Actor::Property::CLIPPING_MODE:
639 if(Self().GetProperty<bool>(Actor::Property::CONNECTED_TO_SCENE))
641 // Note: This method will handle whether creation of the renderer is required.
642 CreateClippingRenderer(*this);
646 case Actor::Property::VISIBLE:
648 if(Dali::Accessibility::IsUp())
650 Dali::Accessibility::Accessible::Get(Self())->EmitVisible(Self().GetProperty(Actor::Property::VISIBLE).Get<bool>());
654 case Toolkit::DevelControl::Property::ACCESSIBILITY_ROLE:
656 if(Dali::Accessibility::IsUp())
658 Dali::Accessibility::Accessible::Get(Self())->Emit(Dali::Accessibility::ObjectPropertyChangeEvent::ROLE);
665 void Control::OnSizeSet(const Vector3& targetSize)
667 Toolkit::Visual::Base visual = mImpl->GetVisual(Toolkit::Control::Property::BACKGROUND);
670 Vector2 size(targetSize);
671 visual.SetTransformAndSize(Property::Map(), size); // Send an empty map as we do not want to modify the visual's set transform
675 void Control::OnSizeAnimation(Animation& animation, const Vector3& targetSize)
677 // @todo size negotiate background to new size, animate as well?
680 bool Control::OnKeyEvent(const KeyEvent& event)
682 return false; // Do not consume
685 void Control::OnRelayout(const Vector2& size, RelayoutContainer& container)
687 for(unsigned int i = 0, numChildren = Self().GetChildCount(); i < numChildren; ++i)
689 Actor child = Self().GetChildAt(i);
690 Vector2 newChildSize(size);
692 // When set the padding or margin on the control, child should be resized and repositioned.
693 if((mImpl->mPadding.start != 0) || (mImpl->mPadding.end != 0) || (mImpl->mPadding.top != 0) || (mImpl->mPadding.bottom != 0) ||
694 (mImpl->mMargin.start != 0) || (mImpl->mMargin.end != 0) || (mImpl->mMargin.top != 0) || (mImpl->mMargin.bottom != 0))
696 Extents padding = mImpl->mPadding;
698 Dali::CustomActor ownerActor(GetOwner());
699 Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>(ownerActor.GetProperty(Dali::Actor::Property::LAYOUT_DIRECTION).Get<int>());
701 if(Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection)
703 std::swap(padding.start, padding.end);
706 newChildSize.width = size.width - (padding.start + padding.end);
707 newChildSize.height = size.height - (padding.top + padding.bottom);
709 // Cannot use childs Position property as it can already have padding and margin applied on it,
710 // so we end up cumulatively applying them over and over again.
711 Vector2 childOffset(0.f, 0.f);
712 childOffset.x += (mImpl->mMargin.start + padding.start);
713 childOffset.y += (mImpl->mMargin.top + padding.top);
715 child.SetProperty(Actor::Property::POSITION, Vector2(childOffset.x, childOffset.y));
717 container.Add(child, newChildSize);
720 Toolkit::Visual::Base visual = mImpl->GetVisual(Toolkit::Control::Property::BACKGROUND);
723 visual.SetTransformAndSize(Property::Map(), size); // Send an empty map as we do not want to modify the visual's set transform
727 void Control::OnSetResizePolicy(ResizePolicy::Type policy, Dimension::Type dimension)
731 Vector3 Control::GetNaturalSize()
733 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Control::GetNaturalSize for %s\n", Self().GetProperty<std::string>(Dali::Actor::Property::NAME).c_str());
734 Toolkit::Visual::Base visual = mImpl->GetVisual(Toolkit::Control::Property::BACKGROUND);
738 visual.GetNaturalSize(naturalSize);
739 naturalSize.width += (mImpl->mPadding.start + mImpl->mPadding.end);
740 naturalSize.height += (mImpl->mPadding.top + mImpl->mPadding.bottom);
741 return Vector3(naturalSize);
743 return Vector3::ZERO;
746 float Control::CalculateChildSize(const Dali::Actor& child, Dimension::Type dimension)
748 return CalculateChildSizeBase(child, dimension);
751 float Control::GetHeightForWidth(float width)
753 return GetHeightForWidthBase(width);
756 float Control::GetWidthForHeight(float height)
758 return GetWidthForHeightBase(height);
761 bool Control::RelayoutDependentOnChildren(Dimension::Type dimension)
763 return RelayoutDependentOnChildrenBase(dimension);
766 void Control::OnCalculateRelayoutSize(Dimension::Type dimension)
770 void Control::OnLayoutNegotiated(float size, Dimension::Type dimension)
774 void Control::SignalConnected(SlotObserver* slotObserver, CallbackBase* callback)
776 mImpl->SignalConnected(slotObserver, callback);
779 void Control::SignalDisconnected(SlotObserver* slotObserver, CallbackBase* callback)
781 mImpl->SignalDisconnected(slotObserver, callback);
784 Control& GetImplementation(Dali::Toolkit::Control& handle)
786 CustomActorImpl& customInterface = handle.GetImplementation();
787 // downcast to control
788 Control& impl = dynamic_cast<Internal::Control&>(customInterface);
792 const Control& GetImplementation(const Dali::Toolkit::Control& handle)
794 const CustomActorImpl& customInterface = handle.GetImplementation();
795 // downcast to control
796 const Control& impl = dynamic_cast<const Internal::Control&>(customInterface);
800 } // namespace Internal
802 } // namespace Toolkit