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 Creates a clipping renderer if required.
68 * (EG. If no renders exist and clipping is enabled).
69 * @param[in] controlImpl The control implementation.
71 void CreateClippingRenderer(Control& controlImpl)
73 // We want to add a transparent background if we do not have one for clipping.
74 Actor self(controlImpl.Self());
75 int clippingMode = ClippingMode::DISABLED;
76 if(self.GetProperty(Actor::Property::CLIPPING_MODE).Get(clippingMode))
78 Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(controlImpl);
80 if(clippingMode == ClippingMode::CLIP_CHILDREN && controlDataImpl.mVisuals.Empty() && self.GetRendererCount() == 0u)
82 controlImpl.SetBackgroundColor(Color::TRANSPARENT);
87 } // unnamed namespace
89 Toolkit::Control Control::New()
91 // Create the implementation, temporarily owned on stack
92 IntrusivePtr<Control> controlImpl = new Control(ControlBehaviour(CONTROL_BEHAVIOUR_DEFAULT));
94 // Pass ownership to handle
95 Toolkit::Control handle(*controlImpl);
97 // Second-phase init of the implementation
98 // This can only be done after the CustomActor connection has been made...
99 controlImpl->Initialize();
104 void Control::SetStyleName(const std::string& styleName)
106 if(styleName != mImpl->mStyleName)
108 mImpl->mStyleName = styleName;
110 // Apply new style, if stylemanager is available
111 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
114 GetImpl(styleManager).ApplyThemeStyle(Toolkit::Control(GetOwner()));
119 const std::string& Control::GetStyleName() const
121 return mImpl->mStyleName;
124 void Control::SetBackgroundColor(const Vector4& color)
126 mImpl->mBackgroundColor = color;
129 map[Toolkit::Visual::Property::TYPE] = Toolkit::Visual::COLOR;
130 map[Toolkit::ColorVisual::Property::MIX_COLOR] = color;
132 Toolkit::Visual::Base visual = mImpl->GetVisual(Toolkit::Control::Property::BACKGROUND);
133 if(visual && visual.GetType() == Toolkit::Visual::COLOR)
135 // Update background color only
136 mImpl->DoAction(Toolkit::Control::Property::BACKGROUND, DevelColorVisual::Action::UPDATE_PROPERTY, map);
143 void Control::SetBackground(const Property::Map& map)
145 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual(map);
146 visual.SetName("background");
149 mImpl->RegisterVisual(Toolkit::Control::Property::BACKGROUND, visual, DepthIndex::BACKGROUND);
151 // Trigger a size negotiation request that may be needed by the new visual to relayout its contents.
156 void Control::ClearBackground()
158 mImpl->UnregisterVisual(Toolkit::Control::Property::BACKGROUND);
159 mImpl->mBackgroundColor = Color::TRANSPARENT;
161 // Trigger a size negotiation request that may be needed when unregistering a visual.
165 void Control::EnableGestureDetection(GestureType::Value type)
167 if((type & GestureType::PINCH) && !mImpl->mPinchGestureDetector)
169 mImpl->mPinchGestureDetector = PinchGestureDetector::New();
170 mImpl->mPinchGestureDetector.DetectedSignal().Connect(mImpl, &Impl::PinchDetected);
171 mImpl->mPinchGestureDetector.Attach(Self());
174 if((type & GestureType::PAN) && !mImpl->mPanGestureDetector)
176 mImpl->mPanGestureDetector = PanGestureDetector::New();
177 mImpl->mPanGestureDetector.SetMaximumTouchesRequired(2);
178 mImpl->mPanGestureDetector.DetectedSignal().Connect(mImpl, &Impl::PanDetected);
179 mImpl->mPanGestureDetector.Attach(Self());
182 if((type & GestureType::TAP) && !mImpl->mTapGestureDetector)
184 mImpl->mTapGestureDetector = TapGestureDetector::New();
185 mImpl->mTapGestureDetector.DetectedSignal().Connect(mImpl, &Impl::TapDetected);
186 mImpl->mTapGestureDetector.Attach(Self());
189 if((type & GestureType::LONG_PRESS) && !mImpl->mLongPressGestureDetector)
191 mImpl->mLongPressGestureDetector = LongPressGestureDetector::New();
192 mImpl->mLongPressGestureDetector.DetectedSignal().Connect(mImpl, &Impl::LongPressDetected);
193 mImpl->mLongPressGestureDetector.Attach(Self());
197 void Control::DisableGestureDetection(GestureType::Value type)
199 if((type & GestureType::PINCH) && mImpl->mPinchGestureDetector)
201 mImpl->mPinchGestureDetector.Detach(Self());
202 mImpl->mPinchGestureDetector.Reset();
205 if((type & GestureType::PAN) && mImpl->mPanGestureDetector)
207 mImpl->mPanGestureDetector.Detach(Self());
208 mImpl->mPanGestureDetector.Reset();
211 if((type & GestureType::TAP) && mImpl->mTapGestureDetector)
213 mImpl->mTapGestureDetector.Detach(Self());
214 mImpl->mTapGestureDetector.Reset();
217 if((type & GestureType::LONG_PRESS) && mImpl->mLongPressGestureDetector)
219 mImpl->mLongPressGestureDetector.Detach(Self());
220 mImpl->mLongPressGestureDetector.Reset();
224 PinchGestureDetector Control::GetPinchGestureDetector() const
226 return mImpl->mPinchGestureDetector;
229 PanGestureDetector Control::GetPanGestureDetector() const
231 return mImpl->mPanGestureDetector;
234 TapGestureDetector Control::GetTapGestureDetector() const
236 return mImpl->mTapGestureDetector;
239 LongPressGestureDetector Control::GetLongPressGestureDetector() const
241 return mImpl->mLongPressGestureDetector;
244 void Control::SetKeyboardNavigationSupport(bool isSupported)
246 mImpl->mIsKeyboardNavigationSupported = isSupported;
249 bool Control::IsKeyboardNavigationSupported()
251 return mImpl->mIsKeyboardNavigationSupported;
254 void Control::SetKeyInputFocus()
256 if(Self().GetProperty<bool>(Actor::Property::CONNECTED_TO_SCENE))
258 Toolkit::KeyInputFocusManager::Get().SetFocus(Toolkit::Control::DownCast(Self()));
262 bool Control::HasKeyInputFocus()
265 if(Self().GetProperty<bool>(Actor::Property::CONNECTED_TO_SCENE))
267 Toolkit::Control control = Toolkit::KeyInputFocusManager::Get().GetCurrentFocusControl();
268 if(Self() == control)
276 void Control::ClearKeyInputFocus()
278 if(Self().GetProperty<bool>(Actor::Property::CONNECTED_TO_SCENE))
280 Toolkit::KeyInputFocusManager::Get().RemoveFocus(Toolkit::Control::DownCast(Self()));
284 void Control::SetAsKeyboardFocusGroup(bool isFocusGroup)
286 mImpl->mIsKeyboardFocusGroup = isFocusGroup;
288 // The following line will be removed when the deprecated API in KeyboardFocusManager is deleted
289 Toolkit::KeyboardFocusManager::Get().SetAsFocusGroup(Self(), isFocusGroup);
292 bool Control::IsKeyboardFocusGroup()
294 return Toolkit::KeyboardFocusManager::Get().IsFocusGroup(Self());
297 void Control::AccessibilityActivate()
299 // Inform deriving classes
300 OnAccessibilityActivated();
303 void Control::KeyboardEnter()
305 // Inform deriving classes
309 bool Control::OnAccessibilityActivated()
311 if(Toolkit::KeyboardFocusManager::Get().SetCurrentFocusActor(Self()))
313 return OnKeyboardEnter();
318 bool Control::OnKeyboardEnter()
320 return false; // Keyboard enter is not handled by default
323 bool Control::OnAccessibilityPan(PanGesture gesture)
325 return false; // Accessibility pan gesture is not handled by default
328 bool Control::OnAccessibilityValueChange(bool isIncrease)
330 return false; // Accessibility value change action is not handled by default
333 bool Control::OnAccessibilityZoom()
335 return false; // Accessibility zoom action is not handled by default
338 Actor Control::GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled)
343 void Control::OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor)
347 Toolkit::Control::KeyEventSignalType& Control::KeyEventSignal()
349 return mImpl->mKeyEventSignal;
352 Toolkit::Control::KeyInputFocusSignalType& Control::KeyInputFocusGainedSignal()
354 return mImpl->mKeyInputFocusGainedSignal;
357 Toolkit::Control::KeyInputFocusSignalType& Control::KeyInputFocusLostSignal()
359 return mImpl->mKeyInputFocusLostSignal;
362 bool Control::EmitKeyEventSignal(const KeyEvent& event)
364 // Guard against destruction during signal emission
365 Dali::Toolkit::Control handle(GetOwner());
367 bool consumed = false;
369 consumed = mImpl->FilterKeyEvent(event);
371 // signals are allocated dynamically when someone connects
372 if(!consumed && !mImpl->mKeyEventSignal.Empty())
374 consumed = mImpl->mKeyEventSignal.Emit(handle, event);
379 // Notification for derived classes
380 consumed = OnKeyEvent(event);
386 void Control::RelayoutRequest()
388 CustomActorImpl::RelayoutRequest();
392 Control::Control(ControlBehaviour behaviourFlags)
393 : CustomActorImpl(static_cast<ActorFlags>(behaviourFlags)),
394 mImpl(new Impl(*this))
396 mImpl->mFlags = behaviourFlags;
404 void Control::Initialize()
406 // Call deriving classes so initialised before styling is applied to them.
409 if(!(mImpl->mFlags & DISABLE_STYLE_CHANGE_SIGNALS))
411 Toolkit::StyleManager styleManager = StyleManager::Get();
413 // if stylemanager is available
416 StyleManager& styleManagerImpl = GetImpl(styleManager);
418 // Register for style changes
419 styleManagerImpl.ControlStyleChangeSignal().Connect(this, &Control::OnStyleChange);
421 // Apply the current style
422 styleManagerImpl.ApplyThemeStyleAtInit(Toolkit::Control(GetOwner()));
426 if(mImpl->mFlags & REQUIRES_KEYBOARD_NAVIGATION_SUPPORT)
428 SetKeyboardNavigationSupport(true);
432 Self().GetTypeInfo(type);
435 auto typeName = type.GetName();
436 DevelControl::AppendAccessibilityAttribute(Self(), "class", typeName);
440 void Control::OnInitialize()
444 void Control::OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change)
446 // By default the control is only interested in theme (not font) changes
447 if(styleManager && change == StyleChange::THEME_CHANGE)
449 GetImpl(styleManager).ApplyThemeStyle(Toolkit::Control(GetOwner()));
454 void Control::OnPinch(const PinchGesture& pinch)
456 if(!(mImpl->mStartingPinchScale))
459 mImpl->mStartingPinchScale = new Vector3;
462 if(pinch.GetState() == GestureState::STARTED)
464 *(mImpl->mStartingPinchScale) = Self().GetCurrentProperty<Vector3>(Actor::Property::SCALE);
467 Self().SetProperty(Actor::Property::SCALE, *(mImpl->mStartingPinchScale) * pinch.GetScale());
470 void Control::OnPan(const PanGesture& pan)
474 void Control::OnTap(const TapGesture& tap)
478 void Control::OnLongPress(const LongPressGesture& longPress)
482 void Control::EmitKeyInputFocusSignal(bool focusGained)
484 Dali::Toolkit::Control handle(GetOwner());
486 if(Accessibility::IsUp())
488 auto self = mImpl->GetAccessibilityObject(Self());
489 self->EmitFocused(focusGained);
490 auto parent = self->GetParent();
491 if(parent && !self->GetStates()[Dali::Accessibility::State::MANAGES_DESCENDANTS])
493 parent->EmitActiveDescendantChanged(parent, self);
499 // signals are allocated dynamically when someone connects
500 if(!mImpl->mKeyInputFocusGainedSignal.Empty())
502 mImpl->mKeyInputFocusGainedSignal.Emit(handle);
507 // signals are allocated dynamically when someone connects
508 if(!mImpl->mKeyInputFocusLostSignal.Empty())
510 mImpl->mKeyInputFocusLostSignal.Emit(handle);
515 void Control::OnSceneConnection(int depth)
517 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Control::OnSceneConnection number of registered visuals(%d)\n", mImpl->mVisuals.Size());
521 for(RegisteredVisualContainer::Iterator iter = mImpl->mVisuals.Begin(); iter != mImpl->mVisuals.End(); iter++)
523 // Check whether the visual is empty and enabled
524 if((*iter)->visual && (*iter)->enabled)
526 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Control::OnSceneConnection Setting visual(%d) on scene\n", (*iter)->index);
527 Toolkit::GetImplementation((*iter)->visual).SetOnScene(self);
531 // The clipping renderer is only created if required.
532 CreateClippingRenderer(*this);
535 void Control::OnSceneDisconnection()
537 mImpl->OnSceneDisconnection();
540 void Control::OnKeyInputFocusGained()
542 EmitKeyInputFocusSignal(true);
545 void Control::OnKeyInputFocusLost()
547 EmitKeyInputFocusSignal(false);
550 void Control::OnChildAdd(Actor& child)
554 void Control::OnChildRemove(Actor& child)
558 void Control::OnPropertySet(Property::Index index, const Property::Value& propertyValue)
560 // If the clipping mode has been set, we may need to create a renderer.
561 // Only do this if we are already on-stage as the OnSceneConnection will handle the off-stage clipping controls.
564 case Actor::Property::CLIPPING_MODE:
566 if(Self().GetProperty<bool>(Actor::Property::CONNECTED_TO_SCENE))
568 // Note: This method will handle whether creation of the renderer is required.
569 CreateClippingRenderer(*this);
573 case Actor::Property::VISIBLE:
575 if(Dali::Accessibility::IsUp())
577 Dali::Accessibility::Accessible::Get(Self())->EmitVisible(Self().GetProperty(Actor::Property::VISIBLE).Get<bool>());
581 case Toolkit::DevelControl::Property::ACCESSIBILITY_ROLE:
583 if(Dali::Accessibility::IsUp())
585 Dali::Accessibility::Accessible::Get(Self())->Emit(Dali::Accessibility::ObjectPropertyChangeEvent::ROLE);
592 void Control::OnSizeSet(const Vector3& targetSize)
594 Toolkit::Visual::Base visual = mImpl->GetVisual(Toolkit::Control::Property::BACKGROUND);
597 Vector2 size(targetSize);
598 visual.SetTransformAndSize(Property::Map(), size); // Send an empty map as we do not want to modify the visual's set transform
602 void Control::OnSizeAnimation(Animation& animation, const Vector3& targetSize)
604 // @todo size negotiate background to new size, animate as well?
607 bool Control::OnKeyEvent(const KeyEvent& event)
609 return false; // Do not consume
612 void Control::OnRelayout(const Vector2& size, RelayoutContainer& container)
614 for(unsigned int i = 0, numChildren = Self().GetChildCount(); i < numChildren; ++i)
616 Actor child = Self().GetChildAt(i);
617 Vector2 newChildSize(size);
619 // When set the padding or margin on the control, child should be resized and repositioned.
620 if((mImpl->mPadding.start != 0) || (mImpl->mPadding.end != 0) || (mImpl->mPadding.top != 0) || (mImpl->mPadding.bottom != 0) ||
621 (mImpl->mMargin.start != 0) || (mImpl->mMargin.end != 0) || (mImpl->mMargin.top != 0) || (mImpl->mMargin.bottom != 0))
623 Extents padding = mImpl->mPadding;
625 Dali::CustomActor ownerActor(GetOwner());
626 Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>(ownerActor.GetProperty(Dali::Actor::Property::LAYOUT_DIRECTION).Get<int>());
628 if(Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection)
630 std::swap(padding.start, padding.end);
633 newChildSize.width = size.width - (padding.start + padding.end);
634 newChildSize.height = size.height - (padding.top + padding.bottom);
636 // Cannot use childs Position property as it can already have padding and margin applied on it,
637 // so we end up cumulatively applying them over and over again.
638 Vector2 childOffset(0.f, 0.f);
639 childOffset.x += (mImpl->mMargin.start + padding.start);
640 childOffset.y += (mImpl->mMargin.top + padding.top);
642 child.SetProperty(Actor::Property::POSITION, Vector2(childOffset.x, childOffset.y));
644 container.Add(child, newChildSize);
647 Toolkit::Visual::Base visual = mImpl->GetVisual(Toolkit::Control::Property::BACKGROUND);
650 visual.SetTransformAndSize(Property::Map(), size); // Send an empty map as we do not want to modify the visual's set transform
654 void Control::OnSetResizePolicy(ResizePolicy::Type policy, Dimension::Type dimension)
658 Vector3 Control::GetNaturalSize()
660 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Control::GetNaturalSize for %s\n", Self().GetProperty<std::string>(Dali::Actor::Property::NAME).c_str());
661 Toolkit::Visual::Base visual = mImpl->GetVisual(Toolkit::Control::Property::BACKGROUND);
665 visual.GetNaturalSize(naturalSize);
666 naturalSize.width += (mImpl->mPadding.start + mImpl->mPadding.end);
667 naturalSize.height += (mImpl->mPadding.top + mImpl->mPadding.bottom);
668 return Vector3(naturalSize);
670 return Vector3::ZERO;
673 float Control::CalculateChildSize(const Dali::Actor& child, Dimension::Type dimension)
675 return CalculateChildSizeBase(child, dimension);
678 float Control::GetHeightForWidth(float width)
680 return GetHeightForWidthBase(width);
683 float Control::GetWidthForHeight(float height)
685 return GetWidthForHeightBase(height);
688 bool Control::RelayoutDependentOnChildren(Dimension::Type dimension)
690 return RelayoutDependentOnChildrenBase(dimension);
693 void Control::OnCalculateRelayoutSize(Dimension::Type dimension)
697 void Control::OnLayoutNegotiated(float size, Dimension::Type dimension)
701 void Control::SignalConnected(SlotObserver* slotObserver, CallbackBase* callback)
703 mImpl->SignalConnected(slotObserver, callback);
706 void Control::SignalDisconnected(SlotObserver* slotObserver, CallbackBase* callback)
708 mImpl->SignalDisconnected(slotObserver, callback);
711 Control& GetImplementation(Dali::Toolkit::Control& handle)
713 CustomActorImpl& customInterface = handle.GetImplementation();
714 // downcast to control
715 Control& impl = dynamic_cast<Internal::Control&>(customInterface);
719 const Control& GetImplementation(const Dali::Toolkit::Control& handle)
721 const CustomActorImpl& customInterface = handle.GetImplementation();
722 // downcast to control
723 const Control& impl = dynamic_cast<const Internal::Control&>(customInterface);
727 } // namespace Internal
729 } // namespace Toolkit