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
33 #include <dali-toolkit/devel-api/controls/control-depth-index-ranges.h>
34 #include <dali-toolkit/devel-api/controls/control-devel.h>
35 #include <dali-toolkit/devel-api/focus-manager/keyinput-focus-manager.h>
36 #include <dali-toolkit/devel-api/visuals/color-visual-actions-devel.h>
37 #include <dali-toolkit/devel-api/visuals/color-visual-properties-devel.h>
38 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
39 #include <dali-toolkit/internal/styling/style-manager-impl.h>
40 #include <dali-toolkit/internal/visuals/color/color-visual.h>
41 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
42 #include <dali-toolkit/public-api/align-enumerations.h>
43 #include <dali-toolkit/public-api/controls/control.h>
44 #include <dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h>
45 #include <dali-toolkit/public-api/styling/style-manager.h>
46 #include <dali-toolkit/public-api/visuals/color-visual-properties.h>
47 #include <dali-toolkit/public-api/visuals/visual-properties.h>
57 #if defined(DEBUG_ENABLED)
58 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_CONTROL_VISUALS");
62 * @brief Replace the background visual if it's a color visual with the renderIfTransparent property set as required.
63 * @param[in] controlImpl The control implementation
64 * @param[in] renderIfTransaparent Whether we should render if the color is transparent
66 void ChangeBackgroundColorVisual(Control& controlImpl, bool renderIfTransparent)
68 Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(controlImpl);
70 Toolkit::Visual::Base backgroundVisual = controlDataImpl.GetVisual(Toolkit::Control::Property::BACKGROUND);
71 if(backgroundVisual && backgroundVisual.GetType() == Toolkit::Visual::COLOR)
74 backgroundVisual.CreatePropertyMap(map);
76 // Only change it if it's a color visual
77 map[Toolkit::DevelColorVisual::Property::RENDER_IF_TRANSPARENT] = renderIfTransparent;
78 controlImpl.SetBackground(map);
83 * @brief Creates a clipping renderer if required.
84 * (EG. If no renders exist and clipping is enabled).
85 * @param[in] controlImpl The control implementation.
87 void CreateClippingRenderer(Control& controlImpl)
89 // We want to add a transparent background if we do not have one for clipping.
90 Actor self(controlImpl.Self());
91 int clippingMode = ClippingMode::DISABLED;
92 if(self.GetProperty(Actor::Property::CLIPPING_MODE).Get(clippingMode))
96 case ClippingMode::CLIP_CHILDREN:
98 if(self.GetRendererCount() == 0u)
100 Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(controlImpl);
101 if(controlDataImpl.mVisuals.Empty())
103 controlImpl.SetBackgroundColor(Color::TRANSPARENT);
107 // We have visuals, check if we've set the background and re-create it to
108 // render even if transparent (only if it's a color visual)
109 ChangeBackgroundColorVisual(controlImpl, true);
115 case ClippingMode::DISABLED:
116 case ClippingMode::CLIP_TO_BOUNDING_BOX:
118 // If we have a background visual, check if it's a color visual and remove the render if transparent flag
119 ChangeBackgroundColorVisual(controlImpl, false);
126 } // unnamed namespace
128 Toolkit::Control Control::New()
130 // Create the implementation, temporarily owned on stack
131 IntrusivePtr<Control> controlImpl = new Control(ControlBehaviour(CONTROL_BEHAVIOUR_DEFAULT));
133 // Pass ownership to handle
134 Toolkit::Control handle(*controlImpl);
136 // Second-phase init of the implementation
137 // This can only be done after the CustomActor connection has been made...
138 controlImpl->Initialize();
143 void Control::SetStyleName(const std::string& styleName)
145 if(styleName != mImpl->mStyleName)
147 mImpl->mStyleName = styleName;
149 // Apply new style, if stylemanager is available
150 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
153 GetImpl(styleManager).ApplyThemeStyle(Toolkit::Control(GetOwner()));
158 const std::string& Control::GetStyleName() const
160 return mImpl->mStyleName;
163 void Control::SetBackgroundColor(const Vector4& color)
165 mImpl->mBackgroundColor = color;
168 map[Toolkit::Visual::Property::TYPE] = Toolkit::Visual::COLOR;
169 map[Toolkit::ColorVisual::Property::MIX_COLOR] = color;
171 bool renderIfTransparent = false;
172 int clippingMode = ClippingMode::DISABLED;
173 if((Self().GetProperty(Actor::Property::CLIPPING_MODE).Get(clippingMode)) &&
174 (clippingMode == ClippingMode::CLIP_CHILDREN))
176 // If clipping-mode is set to CLIP_CHILDREN, then force visual to add the render even if transparent
177 map[Toolkit::DevelColorVisual::Property::RENDER_IF_TRANSPARENT] = true;
178 renderIfTransparent = true;
181 Toolkit::Visual::Base visual = mImpl->GetVisual(Toolkit::Control::Property::BACKGROUND);
182 if(visual && visual.GetType() == Toolkit::Visual::COLOR)
184 Property::Map visualMap;
185 visual.CreatePropertyMap(visualMap);
187 Property::Value* renderValue = visualMap.Find(Toolkit::DevelColorVisual::Property::RENDER_IF_TRANSPARENT);
188 Property::Value* colorValue = visualMap.Find(Toolkit::ColorVisual::Property::MIX_COLOR);
189 if(renderValue && colorValue)
191 if((renderValue->Get<bool>() == true || colorValue->Get<Vector4>().a > 0.0f) && (renderIfTransparent || color.a > 0.0f))
193 // Update background color only
194 mImpl->DoAction(Toolkit::Control::Property::BACKGROUND, DevelColorVisual::Action::UPDATE_PROPERTY, map);
203 void Control::SetBackground(const Property::Map& map)
205 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual(map);
206 visual.SetName("background");
209 mImpl->RegisterVisual(Toolkit::Control::Property::BACKGROUND, visual, DepthIndex::BACKGROUND);
211 // Trigger a size negotiation request that may be needed by the new visual to relayout its contents.
216 void Control::ClearBackground()
218 mImpl->UnregisterVisual(Toolkit::Control::Property::BACKGROUND);
219 mImpl->mBackgroundColor = Color::TRANSPARENT;
221 // Trigger a size negotiation request that may be needed when unregistering a visual.
225 void Control::EnableGestureDetection(GestureType::Value type)
227 if((type & GestureType::PINCH) && !mImpl->mPinchGestureDetector)
229 mImpl->mPinchGestureDetector = PinchGestureDetector::New();
230 mImpl->mPinchGestureDetector.DetectedSignal().Connect(mImpl, &Impl::PinchDetected);
231 mImpl->mPinchGestureDetector.Attach(Self());
234 if((type & GestureType::PAN) && !mImpl->mPanGestureDetector)
236 mImpl->mPanGestureDetector = PanGestureDetector::New();
237 mImpl->mPanGestureDetector.DetectedSignal().Connect(mImpl, &Impl::PanDetected);
238 mImpl->mPanGestureDetector.Attach(Self());
241 if((type & GestureType::TAP) && !mImpl->mTapGestureDetector)
243 mImpl->mTapGestureDetector = TapGestureDetector::New();
244 mImpl->mTapGestureDetector.DetectedSignal().Connect(mImpl, &Impl::TapDetected);
245 mImpl->mTapGestureDetector.Attach(Self());
248 if((type & GestureType::LONG_PRESS) && !mImpl->mLongPressGestureDetector)
250 mImpl->mLongPressGestureDetector = LongPressGestureDetector::New();
251 mImpl->mLongPressGestureDetector.DetectedSignal().Connect(mImpl, &Impl::LongPressDetected);
252 mImpl->mLongPressGestureDetector.Attach(Self());
256 void Control::DisableGestureDetection(GestureType::Value type)
258 if((type & GestureType::PINCH) && mImpl->mPinchGestureDetector)
260 mImpl->mPinchGestureDetector.Detach(Self());
261 mImpl->mPinchGestureDetector.Reset();
264 if((type & GestureType::PAN) && mImpl->mPanGestureDetector)
266 mImpl->mPanGestureDetector.Detach(Self());
267 mImpl->mPanGestureDetector.Reset();
270 if((type & GestureType::TAP) && mImpl->mTapGestureDetector)
272 mImpl->mTapGestureDetector.Detach(Self());
273 mImpl->mTapGestureDetector.Reset();
276 if((type & GestureType::LONG_PRESS) && mImpl->mLongPressGestureDetector)
278 mImpl->mLongPressGestureDetector.Detach(Self());
279 mImpl->mLongPressGestureDetector.Reset();
283 PinchGestureDetector Control::GetPinchGestureDetector() const
285 return mImpl->mPinchGestureDetector;
288 PanGestureDetector Control::GetPanGestureDetector() const
290 return mImpl->mPanGestureDetector;
293 TapGestureDetector Control::GetTapGestureDetector() const
295 return mImpl->mTapGestureDetector;
298 LongPressGestureDetector Control::GetLongPressGestureDetector() const
300 return mImpl->mLongPressGestureDetector;
303 void Control::SetKeyboardNavigationSupport(bool isSupported)
305 mImpl->mIsKeyboardNavigationSupported = isSupported;
308 bool Control::IsKeyboardNavigationSupported()
310 return mImpl->mIsKeyboardNavigationSupported;
313 void Control::SetKeyInputFocus()
315 if(Self().GetProperty<bool>(Actor::Property::CONNECTED_TO_SCENE))
317 Toolkit::KeyInputFocusManager::Get().SetFocus(Toolkit::Control::DownCast(Self()));
321 bool Control::HasKeyInputFocus()
324 if(Self().GetProperty<bool>(Actor::Property::CONNECTED_TO_SCENE))
326 Toolkit::Control control = Toolkit::KeyInputFocusManager::Get().GetCurrentFocusControl();
327 if(Self() == control)
335 void Control::ClearKeyInputFocus()
337 if(Self().GetProperty<bool>(Actor::Property::CONNECTED_TO_SCENE))
339 Toolkit::KeyInputFocusManager::Get().RemoveFocus(Toolkit::Control::DownCast(Self()));
343 void Control::SetAsKeyboardFocusGroup(bool isFocusGroup)
345 mImpl->mIsKeyboardFocusGroup = isFocusGroup;
347 // The following line will be removed when the deprecated API in KeyboardFocusManager is deleted
348 Toolkit::KeyboardFocusManager::Get().SetAsFocusGroup(Self(), isFocusGroup);
351 bool Control::IsKeyboardFocusGroup()
353 return Toolkit::KeyboardFocusManager::Get().IsFocusGroup(Self());
356 void Control::AccessibilityActivate()
358 // Inform deriving classes
359 OnAccessibilityActivated();
362 void Control::KeyboardEnter()
364 // Inform deriving classes
368 bool Control::OnAccessibilityActivated()
370 return false; // Accessibility activation is not handled by default
373 bool Control::OnKeyboardEnter()
375 return false; // Keyboard enter is not handled by default
378 bool Control::OnAccessibilityPan(PanGesture gesture)
380 return false; // Accessibility pan gesture is not handled by default
383 bool Control::OnAccessibilityValueChange(bool isIncrease)
385 return false; // Accessibility value change action is not handled by default
388 bool Control::OnAccessibilityZoom()
390 return false; // Accessibility zoom action is not handled by default
393 Actor Control::GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled)
398 void Control::OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor)
402 Toolkit::Control::KeyEventSignalType& Control::KeyEventSignal()
404 return mImpl->mKeyEventSignal;
407 Toolkit::Control::KeyInputFocusSignalType& Control::KeyInputFocusGainedSignal()
409 return mImpl->mKeyInputFocusGainedSignal;
412 Toolkit::Control::KeyInputFocusSignalType& Control::KeyInputFocusLostSignal()
414 return mImpl->mKeyInputFocusLostSignal;
417 bool Control::EmitKeyEventSignal(const KeyEvent& event)
419 // Guard against destruction during signal emission
420 Dali::Toolkit::Control handle(GetOwner());
422 bool consumed = false;
424 consumed = mImpl->FilterKeyEvent(event);
426 // signals are allocated dynamically when someone connects
427 if(!consumed && !mImpl->mKeyEventSignal.Empty())
429 consumed = mImpl->mKeyEventSignal.Emit(handle, event);
434 // Notification for derived classes
435 consumed = OnKeyEvent(event);
441 Control::Control(ControlBehaviour behaviourFlags)
442 : CustomActorImpl(static_cast<ActorFlags>(behaviourFlags)),
443 mImpl(new Impl(*this))
445 mImpl->mFlags = behaviourFlags;
453 void Control::Initialize()
455 // Call deriving classes so initialised before styling is applied to them.
458 if(!(mImpl->mFlags & DISABLE_STYLE_CHANGE_SIGNALS))
460 Toolkit::StyleManager styleManager = StyleManager::Get();
462 // if stylemanager is available
465 StyleManager& styleManagerImpl = GetImpl(styleManager);
467 // Register for style changes
468 styleManagerImpl.ControlStyleChangeSignal().Connect(this, &Control::OnStyleChange);
470 // Apply the current style
471 styleManagerImpl.ApplyThemeStyleAtInit(Toolkit::Control(GetOwner()));
475 if(mImpl->mFlags & REQUIRES_KEYBOARD_NAVIGATION_SUPPORT)
477 SetKeyboardNavigationSupport(true);
481 void Control::OnInitialize()
485 void Control::OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change)
487 // By default the control is only interested in theme (not font) changes
488 if(styleManager && change == StyleChange::THEME_CHANGE)
490 GetImpl(styleManager).ApplyThemeStyle(Toolkit::Control(GetOwner()));
495 void Control::OnPinch(const PinchGesture& pinch)
497 if(!(mImpl->mStartingPinchScale))
500 mImpl->mStartingPinchScale = new Vector3;
503 if(pinch.GetState() == GestureState::STARTED)
505 *(mImpl->mStartingPinchScale) = Self().GetCurrentProperty<Vector3>(Actor::Property::SCALE);
508 Self().SetProperty(Actor::Property::SCALE, *(mImpl->mStartingPinchScale) * pinch.GetScale());
511 void Control::OnPan(const PanGesture& pan)
515 void Control::OnTap(const TapGesture& tap)
519 void Control::OnLongPress(const LongPressGesture& longPress)
523 void Control::EmitKeyInputFocusSignal(bool focusGained)
525 Dali::Toolkit::Control handle(GetOwner());
529 // signals are allocated dynamically when someone connects
530 if(!mImpl->mKeyInputFocusGainedSignal.Empty())
532 mImpl->mKeyInputFocusGainedSignal.Emit(handle);
537 // signals are allocated dynamically when someone connects
538 if(!mImpl->mKeyInputFocusLostSignal.Empty())
540 mImpl->mKeyInputFocusLostSignal.Emit(handle);
545 void Control::OnSceneConnection(int depth)
547 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Control::OnSceneConnection number of registered visuals(%d)\n", mImpl->mVisuals.Size());
551 for(RegisteredVisualContainer::Iterator iter = mImpl->mVisuals.Begin(); iter != mImpl->mVisuals.End(); iter++)
553 // Check whether the visual is empty and enabled
554 if((*iter)->visual && (*iter)->enabled)
556 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Control::OnSceneConnection Setting visual(%d) on scene\n", (*iter)->index);
557 Toolkit::GetImplementation((*iter)->visual).SetOnScene(self);
561 // The clipping renderer is only created if required.
562 CreateClippingRenderer(*this);
564 // Request to be laid out when the control is connected to the Scene.
565 // Signal that a Relayout may be needed
568 void Control::OnSceneDisconnection()
570 mImpl->OnSceneDisconnection();
573 void Control::OnKeyInputFocusGained()
575 EmitKeyInputFocusSignal(true);
578 void Control::OnKeyInputFocusLost()
580 EmitKeyInputFocusSignal(false);
583 void Control::OnChildAdd(Actor& child)
587 void Control::OnChildRemove(Actor& child)
591 void Control::OnPropertySet(Property::Index index, const Property::Value& propertyValue)
593 // If the clipping mode has been set, we may need to create a renderer.
594 // Only do this if we are already on-stage as the OnSceneConnection will handle the off-stage clipping controls.
595 if((index == Actor::Property::CLIPPING_MODE) && Self().GetProperty<bool>(Actor::Property::CONNECTED_TO_SCENE))
597 // Note: This method will handle whether creation of the renderer is required.
598 CreateClippingRenderer(*this);
602 void Control::OnSizeSet(const Vector3& targetSize)
604 Toolkit::Visual::Base visual = mImpl->GetVisual(Toolkit::Control::Property::BACKGROUND);
607 Vector2 size(targetSize);
608 visual.SetTransformAndSize(Property::Map(), size); // Send an empty map as we do not want to modify the visual's set transform
612 void Control::OnSizeAnimation(Animation& animation, const Vector3& targetSize)
614 // @todo size negotiate background to new size, animate as well?
617 bool Control::OnKeyEvent(const KeyEvent& event)
619 return false; // Do not consume
622 void Control::OnRelayout(const Vector2& size, RelayoutContainer& container)
624 for(unsigned int i = 0, numChildren = Self().GetChildCount(); i < numChildren; ++i)
626 Actor child = Self().GetChildAt(i);
627 Vector2 newChildSize(size);
629 // When set the padding or margin on the control, child should be resized and repositioned.
630 if((mImpl->mPadding.start != 0) || (mImpl->mPadding.end != 0) || (mImpl->mPadding.top != 0) || (mImpl->mPadding.bottom != 0) ||
631 (mImpl->mMargin.start != 0) || (mImpl->mMargin.end != 0) || (mImpl->mMargin.top != 0) || (mImpl->mMargin.bottom != 0))
633 Extents padding = mImpl->mPadding;
635 Dali::CustomActor ownerActor(GetOwner());
636 Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>(ownerActor.GetProperty(Dali::Actor::Property::LAYOUT_DIRECTION).Get<int>());
638 if(Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection)
640 std::swap(padding.start, padding.end);
643 newChildSize.width = size.width - (padding.start + padding.end);
644 newChildSize.height = size.height - (padding.top + padding.bottom);
646 // Cannot use childs Position property as it can already have padding and margin applied on it,
647 // so we end up cumulatively applying them over and over again.
648 Vector2 childOffset(0.f, 0.f);
649 childOffset.x += (mImpl->mMargin.start + padding.start);
650 childOffset.y += (mImpl->mMargin.top + padding.top);
652 child.SetProperty(Actor::Property::POSITION, Vector2(childOffset.x, childOffset.y));
654 container.Add(child, newChildSize);
657 Toolkit::Visual::Base visual = mImpl->GetVisual(Toolkit::Control::Property::BACKGROUND);
660 visual.SetTransformAndSize(Property::Map(), size); // Send an empty map as we do not want to modify the visual's set transform
664 void Control::OnSetResizePolicy(ResizePolicy::Type policy, Dimension::Type dimension)
668 Vector3 Control::GetNaturalSize()
670 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Control::GetNaturalSize for %s\n", Self().GetProperty<std::string>(Dali::Actor::Property::NAME).c_str());
671 Toolkit::Visual::Base visual = mImpl->GetVisual(Toolkit::Control::Property::BACKGROUND);
675 visual.GetNaturalSize(naturalSize);
676 naturalSize.width += (mImpl->mPadding.start + mImpl->mPadding.end);
677 naturalSize.height += (mImpl->mPadding.top + mImpl->mPadding.bottom);
678 return Vector3(naturalSize);
680 return Vector3::ZERO;
683 float Control::CalculateChildSize(const Dali::Actor& child, Dimension::Type dimension)
685 return CalculateChildSizeBase(child, dimension);
688 float Control::GetHeightForWidth(float width)
690 return GetHeightForWidthBase(width);
693 float Control::GetWidthForHeight(float height)
695 return GetWidthForHeightBase(height);
698 bool Control::RelayoutDependentOnChildren(Dimension::Type dimension)
700 return RelayoutDependentOnChildrenBase(dimension);
703 void Control::OnCalculateRelayoutSize(Dimension::Type dimension)
707 void Control::OnLayoutNegotiated(float size, Dimension::Type dimension)
711 void Control::SignalConnected(SlotObserver* slotObserver, CallbackBase* callback)
713 mImpl->SignalConnected(slotObserver, callback);
716 void Control::SignalDisconnected(SlotObserver* slotObserver, CallbackBase* callback)
718 mImpl->SignalDisconnected(slotObserver, callback);
721 Control& GetImplementation(Dali::Toolkit::Control& handle)
723 CustomActorImpl& customInterface = handle.GetImplementation();
724 // downcast to control
725 Control& impl = dynamic_cast<Internal::Control&>(customInterface);
729 const Control& GetImplementation(const Dali::Toolkit::Control& handle)
731 const CustomActorImpl& customInterface = handle.GetImplementation();
732 // downcast to control
733 const Control& impl = dynamic_cast<const Internal::Control&>(customInterface);
737 } // namespace Internal
739 } // namespace Toolkit