1 #ifndef DALI_TOOLKIT_CONTROL_DATA_IMPL_H
2 #define DALI_TOOLKIT_CONTROL_DATA_IMPL_H
5 * Copyright (c) 2023 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali-toolkit/devel-api/controls/control-devel.h>
23 #include <dali/devel-api/adaptor-framework/accessibility.h>
24 #include <dali/public-api/object/property-notification.h>
25 #include <dali/public-api/object/type-registry.h>
29 #include <dali-toolkit/devel-api/visual-factory/visual-base.h>
30 #include <dali-toolkit/internal/builder/dictionary.h>
31 #include <dali-toolkit/internal/builder/style.h>
32 #include <dali-toolkit/internal/controls/tooltip/tooltip.h>
33 #include <dali-toolkit/internal/visuals/visual-event-observer.h>
34 #include <dali-toolkit/public-api/controls/control-impl.h>
35 #include <dali-toolkit/public-api/visuals/visual-properties.h>
36 #include <dali/devel-api/common/owner-container.h>
37 #include <dali/integration-api/debug.h>
49 * Struct used to store Visual within the control, index is a unique key for each visual.
51 struct RegisteredVisual
53 Property::Index index;
54 Toolkit::Visual::Base visual;
57 bool overideReadyTransition : 1;
59 RegisteredVisual(Property::Index aIndex, Toolkit::Visual::Base& aVisual, bool aEnabled, bool aPendingReplacement)
63 pending(aPendingReplacement),
64 overideReadyTransition(false)
69 typedef Dali::OwnerContainer<RegisteredVisual*> RegisteredVisualContainer;
72 * @brief Holds the Implementation for the internal control class
74 class Control::Impl : public ConnectionTracker, public Visual::EventObserver
76 friend class Toolkit::DevelControl::ControlAccessible;
80 * @brief Retrieves the implementation of the internal control class.
81 * @param[in] internalControl A ref to the control whose internal implementation is required
82 * @return The internal implementation
84 static Control::Impl& Get(Internal::Control& internalControl);
87 * @copydoc Get( Internal::Control& )
89 static const Control::Impl& Get(const Internal::Control& internalControl);
93 * @param[in] controlImpl The control which owns this implementation
95 Impl(Control& controlImpl);
103 * @brief Called when a pinch is detected.
104 * @param[in] actor The actor the pinch occurred on
105 * @param[in] pinch The pinch gesture details
107 void PinchDetected(Actor actor, const PinchGesture& pinch);
110 * @brief Called when a pan is detected.
111 * @param[in] actor The actor the pan occurred on
112 * @param[in] pinch The pan gesture details
114 void PanDetected(Actor actor, const PanGesture& pan);
117 * @brief Called when a tap is detected.
118 * @param[in] actor The actor the tap occurred on
119 * @param[in] pinch The tap gesture details
121 void TapDetected(Actor actor, const TapGesture& tap);
124 * @brief Called when a long-press is detected.
125 * @param[in] actor The actor the long-press occurred on
126 * @param[in] pinch The long-press gesture details
128 void LongPressDetected(Actor actor, const LongPressGesture& longPress);
131 * @brief Called when resources of control are ready.
132 * @param[in] relayoutRequest True to request relayout
134 void ResourceReady(bool relayoutRequest);
137 * @brief Called when a resource is ready.
138 * @param[in] object The visual whose resources are ready
139 * @note Overriding method in Visual::EventObserver.
141 void ResourceReady(Visual::Base& object) override;
144 * @brief Called when an event occurs.
145 * @param[in] object The visual whose events occur
146 * @param[in] signalId The signal to emit. See Visual to find supported signals
147 * @note Overriding method in Visual::EventObserver.
149 void NotifyVisualEvent(Visual::Base& object, Property::Index signalId) override;
152 * @brief Called when the visual needs relayout request.
153 * @param[in] object The visual who requests relayout
155 void RelayoutRequest(Visual::Base& object) override;
158 * @copydoc Dali::Toolkit::DevelControl::RegisterVisual()
160 void RegisterVisual(Property::Index index, Toolkit::Visual::Base& visual);
163 * @copydoc Dali::Toolkit::DevelControl::RegisterVisual()
165 void RegisterVisual(Property::Index index, Toolkit::Visual::Base& visual, int depthIndex);
168 * @copydoc Dali::Toolkit::DevelControl::RegisterVisual()
170 void RegisterVisual(Property::Index index, Toolkit::Visual::Base& visual, bool enabled);
173 * @copydoc Dali::Toolkit::DevelControl::RegisterVisual()
175 void RegisterVisual(Property::Index index, Toolkit::Visual::Base& visual, bool enabled, int depthIndex);
178 * @copydoc Dali::Toolkit::DevelControl::UnregisterVisual()
180 void UnregisterVisual(Property::Index index);
183 * @copydoc Dali::Toolkit::DevelControl::GetVisual()
185 Toolkit::Visual::Base GetVisual(Property::Index index) const;
188 * @copydoc Dali::Toolkit::DevelControl::EnableVisual()
190 void EnableVisual(Property::Index index, bool enable);
193 * @copydoc Dali::Toolkit::DevelControl::IsVisualEnabled()
195 bool IsVisualEnabled(Property::Index index) const;
198 * @brief Sets the given visual to be ready transition
200 * @param[in] control The control
201 * @param[in] visual The visual to ready transition overriden
202 * @param[in] enable flag to set enabled or disabled.
204 void EnableReadyTransitionOverriden(Toolkit::Visual::Base& visual, bool enable);
207 * @brief Stops observing the given visual.
208 * @param[in] visual The visual to stop observing
210 void StopObservingVisual(Toolkit::Visual::Base& visual);
213 * @brief Starts observing the given visual.
214 * @param[in] visual The visual to start observing
216 void StartObservingVisual(Toolkit::Visual::Base& visual);
219 * @copydoc Dali::Toolkit::DevelControl::GetVisualResourceStatus()
221 Toolkit::Visual::ResourceStatus GetVisualResourceStatus(Property::Index index) const;
224 * @param[in,out] animation Handle to existing animation, or an empty handle that
225 * can be set to a New animation if createAnimation is true
226 * @param[in] transitionData The transition data describing the animation
227 * @param[in] createAnimation True if the animation should be created
229 void AddTransitions(Dali::Animation& animation,
230 const Toolkit::TransitionData& transitionData,
231 bool createAnimation = false);
234 * @copydoc Dali::Toolkit::DevelControl::CreateTransition()
236 Dali::Animation CreateTransition(const Toolkit::TransitionData& transitionData);
239 * @copydoc Dali::Toolkit::DevelControl::DoAction()
241 void DoAction(Dali::Property::Index visualIndex, Dali::Property::Index actionId, const Dali::Property::Value attributes);
244 * @copydoc Dali::Toolkit::DevelControl::DoActionExtension()
246 void DoActionExtension(Dali::Property::Index visualIndex, Dali::Property::Index actionId, Dali::Any attributes);
249 * @brief Function used to set control properties.
250 * @param[in] object The object whose property to set
251 * @param[in] index The index of the property to set
252 * @param[in] value The value of the property to set
254 static void SetProperty(BaseObject* object, Property::Index index, const Property::Value& value);
257 * @brief Function used to retrieve the value of control properties.
258 * @param[in] object The object whose property to get
259 * @param[in] index The index of the property to get
260 * @return The value of the property
262 static Property::Value GetProperty(BaseObject* object, Property::Index index);
265 * @brief Sets the state of the control.
266 * @param[in] newState The state to set
267 * @param[in] withTransitions Whether to show a transition when changing to the new state
269 void SetState(DevelControl::State newState, bool withTransitions = true);
272 * @brief Sets the sub-state of the control.
273 * @param[in] newState The sub-state to set
274 * @param[in] withTransitions Whether to show a transition when changing to the new sub-state
276 void SetSubState(const std::string& subStateName, bool withTransitions = true);
279 * @brief Replaces visuals and properties from the old state to the new state.
280 * @param[in] oldState The old state
281 * @param[in] newState The new state
282 * @param[in] subState The current sub state
284 void ReplaceStateVisualsAndProperties(const StylePtr oldState, const StylePtr newState, const std::string& subState);
287 * @brief Removes a visual from the control's container.
288 * @param[in] visuals The container of visuals
289 * @param[in] visualName The name of the visual to remove
291 void RemoveVisual(RegisteredVisualContainer& visuals, const std::string& visualName);
294 * @brief Removes several visuals from the control's container.
295 * @param[in] visuals The container of visuals
296 * @param[in] removeVisuals The visuals to remove
298 void RemoveVisuals(RegisteredVisualContainer& visuals, DictionaryKeys& removeVisuals);
301 * @brief Copies the visual properties that are specific to the control instance into the instancedProperties container.
302 * @param[in] visuals The control's visual container
303 * @param[out] instancedProperties The instanced properties are added to this container
305 void CopyInstancedProperties(RegisteredVisualContainer& visuals, Dictionary<Property::Map>& instancedProperties);
308 * @brief On state change, ensures visuals are moved or created appropriately.
310 * Go through the list of visuals that are common to both states.
311 * If they are different types, or are both image types with different
312 * URLs, then the existing visual needs moving and the new visual needs creating
314 * @param[in] stateVisualsToChange The visuals to change
315 * @param[in] instancedProperties The instanced properties @see CopyInstancedProperties
317 void RecreateChangedVisuals(Dictionary<Property::Map>& stateVisualsToChange, Dictionary<Property::Map>& instancedProperties);
320 * @brief Whether the resource is ready
321 * @return True if the resource is read.
323 bool IsResourceReady() const;
326 * @copydoc CustomActorImpl::OnSceneDisconnection()
328 void OnSceneDisconnection();
331 * @brief Sets the margin.
332 * @param[in] margin Margin is a collections of extent ( start, end, top, bottom )
334 void SetMargin(Extents margin);
337 * @brief Returns the value of margin
338 * @return The value of margin
340 Extents GetMargin() const;
343 * @brief Sets the padding.
344 * @param[in] padding Padding is a collections of extent ( start, end, top, bottom ).
346 void SetPadding(Extents padding);
349 * @brief Returns the value of padding
350 * @return The value of padding
352 Extents GetPadding() const;
355 * @brief Set the input method context.
356 * @param[in] inputMethodContext The input method context.
358 void SetInputMethodContext(InputMethodContext& inputMethodContext);
361 * @brief Filter an key event.
362 * @param[in] event The key to be filtered.
363 * @return True if the key handled, otherwise false.
365 bool FilterKeyEvent(const KeyEvent& event);
368 * @brief Adds accessibility attribute
369 * @param[in] key Attribute name to set
370 * @param[in] value Attribute value to set
372 * Attribute is added if not existed previously or updated
375 void AppendAccessibilityAttribute(const std::string& key, const std::string value);
378 * @brief Removes accessibility attribute
379 * @param[in] key Attribute name to remove
381 * Function does nothing if attribute doesn't exist.
383 void RemoveAccessibilityAttribute(const std::string& key);
386 * @brief Removes all accessibility attributes
388 void ClearAccessibilityAttributes();
391 * @brief Sets reading info type attributes
392 * @param[in] types info type attributes to set
394 * This function sets, which part of object will be read out
397 void SetAccessibilityReadingInfoType(const Dali::Accessibility::ReadingInfoTypes types);
400 * @brief Gets currently active reading info type attributes
402 Dali::Accessibility::ReadingInfoTypes GetAccessibilityReadingInfoType() const;
405 * @copydoc DevelControl::VisualEventSignal()
407 DevelControl::VisualEventSignalType& VisualEventSignal();
410 * @brief Sets the shadow with a property map.
411 * @param[in] map The shadow property map
413 void SetShadow(const Property::Map& map);
416 * @brief Clear the shadow.
421 * @copydoc DevelControl::GetVisualProperty()
423 Dali::Property GetVisualProperty(Dali::Property::Index index, Dali::Property::Key visualPropertyKey);
426 * @brief Retrieves source and destination visual properties for the Transition of this Control.
427 * The properties of this Control will be transitioned from the propeties of source Control to that of destination control.
428 * If a property value is different between source and destination Control,
429 * the property information of each Control will be included in sourceProperties and destinationProperties.
431 * @param[out] sourceProperties Source property list to be applied on this Control.
432 * @param[out] destinationProperties Destination property list to be applied on this Control.
433 * @param[in] source Source control of the animation.
434 * @param[in] destination Destination control of the animation.
436 * @note This method do not handle Actor properties.
437 * And the size and order of the sourceProperties and destinationProperties must be synchronized.
439 * This method triggers Control::OnCreateTransition().
441 void CreateTransitions(std::vector<std::pair<Dali::Property::Index, Dali::Property::Map>>& sourceProperties,
442 std::vector<std::pair<Dali::Property::Index, Dali::Property::Map>>& destinationProperties,
443 Dali::Toolkit::Control source,
444 Dali::Toolkit::Control destination);
447 * @brief Update visual properties.
448 * @param[in] properties Property list to be used to update visual properties of this Control.
450 * @note This method triggers Control::OnUpdateVisualProperties().
452 void UpdateVisualProperties(const std::vector<std::pair<Dali::Property::Index, Dali::Property::Map>>& properties);
455 * @copydoc Dali::Toolkit::Internal::Control::GetAccessibleObject()
457 Toolkit::DevelControl::ControlAccessible* GetAccessibleObject();
461 * Used as an alternative to boolean so that it is obvious whether a visual is enabled/disabled.
467 DISABLED = 0, ///< Visual disabled.
468 ENABLED = 1 ///< Visual enabled.
473 * Used as an alternative to boolean so that it is obvious whether a visual's depth value has been set or not by the caller.
475 struct DepthIndexValue
479 NOT_SET = 0, ///< Visual depth value not set by caller.
480 SET = 1 ///< Visual depth value set by caller.
485 * @brief Adds the visual to the list of registered visuals.
486 * @param[in] index The Property index of the visual, used to reference visual
487 * @param[in,out] visual The visual to register, which can be altered in this function
488 * @param[in] enabled false if derived class wants to control when visual is set on stage
489 * @param[in] depthIndexValueSet Set to true if the depthIndex has actually been set manually
490 * @param[in] depthIndex The visual's depth-index is set to this
492 * @note Registering a visual with an index that already has a registered visual will replace it. The replacement will
493 * occur once the replacement visual is ready (loaded).
495 void RegisterVisual(Property::Index index, Toolkit::Visual::Base& visual, VisualState::Type enabled, DepthIndexValue::Type depthIndexValueSet, int depthIndex = 0);
498 * @brief Emits the resource ready signal.
500 void EmitResourceReadySignal();
503 * @brief Callbacks called on idle.
505 void OnIdleCallback();
508 * @brief Checks highlighted object geometry if it is showing or not
510 void CheckHighlightedObjectGeometry();
513 * @brief Register property notification to check highlighted object position
515 void RegisterAccessibilityPositionPropertyNotification();
518 * @brief Remove property notification added by RegisterPropertyNotification
520 void UnregisterAccessibilityPositionPropertyNotification();
523 Control& mControlImpl;
524 DevelControl::State mState;
525 std::string mSubStateName;
526 Property::Map mAccessibilityAttributes;
528 int mLeftFocusableActorId; ///< Actor ID of Left focusable control.
529 int mRightFocusableActorId; ///< Actor ID of Right focusable control.
530 int mUpFocusableActorId; ///< Actor ID of Up focusable control.
531 int mDownFocusableActorId; ///< Actor ID of Down focusable control.
532 int mClockwiseFocusableActorId; ///< Actor ID of Clockwise focusable control.
533 int mCounterClockwiseFocusableActorId; ///< Actor ID of Counter clockwise focusable control.
535 RegisteredVisualContainer mVisuals; ///< Stores visuals needed by the control, non trivial type so std::vector used.
536 std::string mStyleName;
537 Vector4 mBackgroundColor; ///< The color of the background visual
538 Vector3* mStartingPinchScale; ///< The scale when a pinch gesture starts, TODO: consider removing this
539 Extents mMargin; ///< The margin values
540 Extents mPadding; ///< The padding values
541 Toolkit::Control::KeyEventSignalType mKeyEventSignal;
542 Toolkit::Control::KeyInputFocusSignalType mKeyInputFocusGainedSignal;
543 Toolkit::Control::KeyInputFocusSignalType mKeyInputFocusLostSignal;
544 Toolkit::Control::ResourceReadySignalType mResourceReadySignal;
545 DevelControl::VisualEventSignalType mVisualEventSignal;
548 Toolkit::DevelControl::AccessibilityActivateSignalType mAccessibilityActivateSignal;
549 Toolkit::DevelControl::AccessibilityReadingSkippedSignalType mAccessibilityReadingSkippedSignal;
550 Toolkit::DevelControl::AccessibilityReadingPausedSignalType mAccessibilityReadingPausedSignal;
551 Toolkit::DevelControl::AccessibilityReadingResumedSignalType mAccessibilityReadingResumedSignal;
552 Toolkit::DevelControl::AccessibilityReadingCancelledSignalType mAccessibilityReadingCancelledSignal;
553 Toolkit::DevelControl::AccessibilityReadingStoppedSignalType mAccessibilityReadingStoppedSignal;
555 Toolkit::DevelControl::AccessibilityGetNameSignalType mAccessibilityGetNameSignal;
556 Toolkit::DevelControl::AccessibilityGetDescriptionSignalType mAccessibilityGetDescriptionSignal;
557 Toolkit::DevelControl::AccessibilityDoGestureSignalType mAccessibilityDoGestureSignal;
559 std::string mAccessibilityName;
560 std::string mAccessibilityDescription;
561 std::string mAccessibilityTranslationDomain;
562 std::string mAutomationId;
564 bool mAccessibilityHighlightable = false;
565 bool mAccessibilityHidden = false;
567 Dali::Accessibility::Role mAccessibilityRole = Dali::Accessibility::Role::UNKNOWN;
569 std::map<Dali::Accessibility::RelationType, std::set<Accessibility::Accessible*>> mAccessibilityRelations;
570 std::unique_ptr<Toolkit::DevelControl::ControlAccessible> mAccessibleObject;
573 PinchGestureDetector mPinchGestureDetector;
574 PanGestureDetector mPanGestureDetector;
575 TapGestureDetector mTapGestureDetector;
576 LongPressGestureDetector mLongPressGestureDetector;
581 InputMethodContext mInputMethodContext;
582 CallbackBase* mIdleCallback; ///< The idle callback to emit the resource ready signal.
584 ControlBehaviour mFlags : CONTROL_BEHAVIOUR_FLAG_COUNT; ///< Flags passed in from constructor.
585 bool mIsKeyboardNavigationSupported : 1; ///< Stores whether keyboard navigation is supported by the control.
586 bool mIsKeyboardFocusGroup : 1; ///< Stores whether the control is a focus group.
587 bool mIsEmittingResourceReadySignal : 1; ///< True during ResourceReady().
588 bool mNeedToEmitResourceReady : 1; ///< True if need to emit the resource ready signal again.
589 bool mDispatchKeyEvents : 1; ///< Whether the actor emits key event signals
591 RegisteredVisualContainer mRemoveVisuals; ///< List of visuals that are being replaced by another visual once ready
593 // Properties - these need to be members of Internal::Control::Impl as they access private methods/data of Internal::Control and Internal::Control::Impl.
594 static const PropertyRegistration PROPERTY_1;
595 static const PropertyRegistration PROPERTY_2;
596 static const PropertyRegistration PROPERTY_3;
597 static const PropertyRegistration PROPERTY_4;
598 static const PropertyRegistration PROPERTY_5;
599 static const PropertyRegistration PROPERTY_6;
600 static const PropertyRegistration PROPERTY_7;
601 static const PropertyRegistration PROPERTY_8;
602 static const PropertyRegistration PROPERTY_9;
603 static const PropertyRegistration PROPERTY_10;
604 static const PropertyRegistration PROPERTY_11;
605 static const PropertyRegistration PROPERTY_12;
606 static const PropertyRegistration PROPERTY_13;
607 static const PropertyRegistration PROPERTY_14;
608 static const PropertyRegistration PROPERTY_15;
609 static const PropertyRegistration PROPERTY_16;
610 static const PropertyRegistration PROPERTY_17;
611 static const PropertyRegistration PROPERTY_18;
612 static const PropertyRegistration PROPERTY_19;
613 static const PropertyRegistration PROPERTY_20;
614 static const PropertyRegistration PROPERTY_21;
615 static const PropertyRegistration PROPERTY_22;
616 static const PropertyRegistration PROPERTY_23;
617 static const PropertyRegistration PROPERTY_24;
618 static const PropertyRegistration PROPERTY_25;
619 static const PropertyRegistration PROPERTY_26;
622 // Accessibility - notification for highlighted object to check if it is showing.
623 bool mIsAccessibilityPositionPropertyNotificationSet{false};
624 Dali::PropertyNotification mAccessibilityPositionNotification;
625 Dali::Accessibility::ScreenRelativeMoveType mAccessibilityLastScreenRelativeMoveType{Accessibility::ScreenRelativeMoveType::OUTSIDE};
628 } // namespace Internal
630 } // namespace Toolkit
634 #endif // DALI_TOOLKIT_CONTROL_DATA_IMPL_H