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.
133 void ResourceReady();
136 * @brief Called when a resource is ready.
137 * @param[in] object The visual whose resources are ready
138 * @note Overriding method in Visual::EventObserver.
140 void ResourceReady(Visual::Base& object) override;
143 * @brief Called when an event occurs.
144 * @param[in] object The visual whose events occur
145 * @param[in] signalId The signal to emit. See Visual to find supported signals
146 * @note Overriding method in Visual::EventObserver.
148 void NotifyVisualEvent(Visual::Base& object, Property::Index signalId) override;
151 * @brief Called when the visual needs relayout request.
152 * @param[in] object The visual who requests relayout
154 void RelayoutRequest(Visual::Base& object) override;
157 * @copydoc Dali::Toolkit::DevelControl::RegisterVisual()
159 void RegisterVisual(Property::Index index, Toolkit::Visual::Base& visual);
162 * @copydoc Dali::Toolkit::DevelControl::RegisterVisual()
164 void RegisterVisual(Property::Index index, Toolkit::Visual::Base& visual, int depthIndex);
167 * @copydoc Dali::Toolkit::DevelControl::RegisterVisual()
169 void RegisterVisual(Property::Index index, Toolkit::Visual::Base& visual, bool enabled);
172 * @copydoc Dali::Toolkit::DevelControl::RegisterVisual()
174 void RegisterVisual(Property::Index index, Toolkit::Visual::Base& visual, bool enabled, int depthIndex);
177 * @copydoc Dali::Toolkit::DevelControl::UnregisterVisual()
179 void UnregisterVisual(Property::Index index);
182 * @copydoc Dali::Toolkit::DevelControl::GetVisual()
184 Toolkit::Visual::Base GetVisual(Property::Index index) const;
187 * @copydoc Dali::Toolkit::DevelControl::EnableVisual()
189 void EnableVisual(Property::Index index, bool enable);
192 * @copydoc Dali::Toolkit::DevelControl::IsVisualEnabled()
194 bool IsVisualEnabled(Property::Index index) const;
197 * @brief Sets the given visual to be ready transition
199 * @param[in] control The control
200 * @param[in] visual The visual to ready transition overriden
201 * @param[in] enable flag to set enabled or disabled.
203 void EnableReadyTransitionOverriden(Toolkit::Visual::Base& visual, bool enable);
206 * @brief Stops observing the given visual.
207 * @param[in] visual The visual to stop observing
209 void StopObservingVisual(Toolkit::Visual::Base& visual);
212 * @brief Starts observing the given visual.
213 * @param[in] visual The visual to start observing
215 void StartObservingVisual(Toolkit::Visual::Base& visual);
218 * @copydoc Dali::Toolkit::DevelControl::GetVisualResourceStatus()
220 Toolkit::Visual::ResourceStatus GetVisualResourceStatus(Property::Index index) const;
223 * @param[in,out] animation Handle to existing animation, or an empty handle that
224 * can be set to a New animation if createAnimation is true
225 * @param[in] transitionData The transition data describing the animation
226 * @param[in] createAnimation True if the animation should be created
228 void AddTransitions(Dali::Animation& animation,
229 const Toolkit::TransitionData& transitionData,
230 bool createAnimation = false);
233 * @copydoc Dali::Toolkit::DevelControl::CreateTransition()
235 Dali::Animation CreateTransition(const Toolkit::TransitionData& transitionData);
238 * @copydoc Dali::Toolkit::DevelControl::DoAction()
240 void DoAction(Dali::Property::Index visualIndex, Dali::Property::Index actionId, const Dali::Property::Value attributes);
243 * @copydoc Dali::Toolkit::DevelControl::DoActionExtension()
245 void DoActionExtension(Dali::Property::Index visualIndex, Dali::Property::Index actionId, Dali::Any attributes);
248 * @brief Function used to set control properties.
249 * @param[in] object The object whose property to set
250 * @param[in] index The index of the property to set
251 * @param[in] value The value of the property to set
253 static void SetProperty(BaseObject* object, Property::Index index, const Property::Value& value);
256 * @brief Function used to retrieve the value of control properties.
257 * @param[in] object The object whose property to get
258 * @param[in] index The index of the property to get
259 * @return The value of the property
261 static Property::Value GetProperty(BaseObject* object, Property::Index index);
264 * @brief Sets the state of the control.
265 * @param[in] newState The state to set
266 * @param[in] withTransitions Whether to show a transition when changing to the new state
268 void SetState(DevelControl::State newState, bool withTransitions = true);
271 * @brief Sets the sub-state of the control.
272 * @param[in] newState The sub-state to set
273 * @param[in] withTransitions Whether to show a transition when changing to the new sub-state
275 void SetSubState(const std::string& subStateName, bool withTransitions = true);
278 * @brief Replaces visuals and properties from the old state to the new state.
279 * @param[in] oldState The old state
280 * @param[in] newState The new state
281 * @param[in] subState The current sub state
283 void ReplaceStateVisualsAndProperties(const StylePtr oldState, const StylePtr newState, const std::string& subState);
286 * @brief Removes a visual from the control's container.
287 * @param[in] visuals The container of visuals
288 * @param[in] visualName The name of the visual to remove
290 void RemoveVisual(RegisteredVisualContainer& visuals, const std::string& visualName);
293 * @brief Removes several visuals from the control's container.
294 * @param[in] visuals The container of visuals
295 * @param[in] removeVisuals The visuals to remove
297 void RemoveVisuals(RegisteredVisualContainer& visuals, DictionaryKeys& removeVisuals);
300 * @brief Copies the visual properties that are specific to the control instance into the instancedProperties container.
301 * @param[in] visuals The control's visual container
302 * @param[out] instancedProperties The instanced properties are added to this container
304 void CopyInstancedProperties(RegisteredVisualContainer& visuals, Dictionary<Property::Map>& instancedProperties);
307 * @brief On state change, ensures visuals are moved or created appropriately.
309 * Go through the list of visuals that are common to both states.
310 * If they are different types, or are both image types with different
311 * URLs, then the existing visual needs moving and the new visual needs creating
313 * @param[in] stateVisualsToChange The visuals to change
314 * @param[in] instancedProperties The instanced properties @see CopyInstancedProperties
316 void RecreateChangedVisuals(Dictionary<Property::Map>& stateVisualsToChange, Dictionary<Property::Map>& instancedProperties);
319 * @brief Whether the resource is ready
320 * @return True if the resource is read.
322 bool IsResourceReady() const;
325 * @copydoc CustomActorImpl::OnSceneDisconnection()
327 void OnSceneDisconnection();
330 * @brief Sets the margin.
331 * @param[in] margin Margin is a collections of extent ( start, end, top, bottom )
333 void SetMargin(Extents margin);
336 * @brief Returns the value of margin
337 * @return The value of margin
339 Extents GetMargin() const;
342 * @brief Sets the padding.
343 * @param[in] padding Padding is a collections of extent ( start, end, top, bottom ).
345 void SetPadding(Extents padding);
348 * @brief Returns the value of padding
349 * @return The value of padding
351 Extents GetPadding() const;
354 * @brief Set the input method context.
355 * @param[in] inputMethodContext The input method context.
357 void SetInputMethodContext(InputMethodContext& inputMethodContext);
360 * @brief Filter an key event.
361 * @param[in] event The key to be filtered.
362 * @return True if the key handled, otherwise false.
364 bool FilterKeyEvent(const KeyEvent& event);
367 * @brief Adds accessibility attribute
368 * @param[in] key Attribute name to set
369 * @param[in] value Attribute value to set
371 * Attribute is added if not existed previously or updated
374 void AppendAccessibilityAttribute(const std::string& key, const std::string value);
377 * @brief Removes accessibility attribute
378 * @param[in] key Attribute name to remove
380 * Function does nothing if attribute doesn't exist.
382 void RemoveAccessibilityAttribute(const std::string& key);
385 * @brief Removes all accessibility attributes
387 void ClearAccessibilityAttributes();
390 * @brief Sets reading info type attributes
391 * @param[in] types info type attributes to set
393 * This function sets, which part of object will be read out
396 void SetAccessibilityReadingInfoType(const Dali::Accessibility::ReadingInfoTypes types);
399 * @brief Gets currently active reading info type attributes
401 Dali::Accessibility::ReadingInfoTypes GetAccessibilityReadingInfoType() const;
404 * @copydoc DevelControl::VisualEventSignal()
406 DevelControl::VisualEventSignalType& VisualEventSignal();
409 * @brief Sets the shadow with a property map.
410 * @param[in] map The shadow property map
412 void SetShadow(const Property::Map& map);
415 * @brief Clear the shadow.
420 * @copydoc DevelControl::GetVisualProperty()
422 Dali::Property GetVisualProperty(Dali::Property::Index index, Dali::Property::Key visualPropertyKey);
425 * @brief Retrieves source and destination visual properties for the Transition of this Control.
426 * The properties of this Control will be transitioned from the propeties of source Control to that of destination control.
427 * If a property value is different between source and destination Control,
428 * the property information of each Control will be included in sourceProperties and destinationProperties.
430 * @param[out] sourceProperties Source property list to be applied on this Control.
431 * @param[out] destinationProperties Destination property list to be applied on this Control.
432 * @param[in] source Source control of the animation.
433 * @param[in] destination Destination control of the animation.
435 * @note This method do not handle Actor properties.
436 * And the size and order of the sourceProperties and destinationProperties must be synchronized.
438 * This method triggers Control::OnCreateTransition().
440 void CreateTransitions(std::vector<std::pair<Dali::Property::Index, Dali::Property::Map>>& sourceProperties,
441 std::vector<std::pair<Dali::Property::Index, Dali::Property::Map>>& destinationProperties,
442 Dali::Toolkit::Control source,
443 Dali::Toolkit::Control destination);
446 * @brief Update visual properties.
447 * @param[in] properties Property list to be used to update visual properties of this Control.
449 * @note This method triggers Control::OnUpdateVisualProperties().
451 void UpdateVisualProperties(const std::vector<std::pair<Dali::Property::Index, Dali::Property::Map>>& properties);
454 * @copydoc Dali::Toolkit::Internal::Control::GetAccessibleObject()
456 Toolkit::DevelControl::ControlAccessible* GetAccessibleObject();
460 * Used as an alternative to boolean so that it is obvious whether a visual is enabled/disabled.
466 DISABLED = 0, ///< Visual disabled.
467 ENABLED = 1 ///< Visual enabled.
472 * 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.
474 struct DepthIndexValue
478 NOT_SET = 0, ///< Visual depth value not set by caller.
479 SET = 1 ///< Visual depth value set by caller.
484 * @brief Adds the visual to the list of registered visuals.
485 * @param[in] index The Property index of the visual, used to reference visual
486 * @param[in,out] visual The visual to register, which can be altered in this function
487 * @param[in] enabled false if derived class wants to control when visual is set on stage
488 * @param[in] depthIndexValueSet Set to true if the depthIndex has actually been set manually
489 * @param[in] depthIndex The visual's depth-index is set to this
491 * @note Registering a visual with an index that already has a registered visual will replace it. The replacement will
492 * occur once the replacement visual is ready (loaded).
494 void RegisterVisual(Property::Index index, Toolkit::Visual::Base& visual, VisualState::Type enabled, DepthIndexValue::Type depthIndexValueSet, int depthIndex = 0);
497 * @brief Emits the resource ready signal.
499 void EmitResourceReadySignal();
502 * @brief Callbacks called on idle.
504 void OnIdleCallback();
507 * @brief Checks highlighted object geometry if it is showing or not
509 void CheckHighlightedObjectGeometry();
512 * @brief Register property notification to check highlighted object position
514 void RegisterAccessibilityPositionPropertyNotification();
517 * @brief Remove property notification added by RegisterPropertyNotification
519 void UnregisterAccessibilityPositionPropertyNotification();
522 Control& mControlImpl;
523 DevelControl::State mState;
524 std::string mSubStateName;
525 Property::Map mAccessibilityAttributes;
527 int mLeftFocusableActorId; ///< Actor ID of Left focusable control.
528 int mRightFocusableActorId; ///< Actor ID of Right focusable control.
529 int mUpFocusableActorId; ///< Actor ID of Up focusable control.
530 int mDownFocusableActorId; ///< Actor ID of Down focusable control.
531 int mClockwiseFocusableActorId; ///< Actor ID of Clockwise focusable control.
532 int mCounterClockwiseFocusableActorId; ///< Actor ID of Counter clockwise focusable control.
534 RegisteredVisualContainer mVisuals; ///< Stores visuals needed by the control, non trivial type so std::vector used.
535 std::string mStyleName;
536 Vector4 mBackgroundColor; ///< The color of the background visual
537 Vector3* mStartingPinchScale; ///< The scale when a pinch gesture starts, TODO: consider removing this
538 Extents mMargin; ///< The margin values
539 Extents mPadding; ///< The padding values
540 Toolkit::Control::KeyEventSignalType mKeyEventSignal;
541 Toolkit::Control::KeyInputFocusSignalType mKeyInputFocusGainedSignal;
542 Toolkit::Control::KeyInputFocusSignalType mKeyInputFocusLostSignal;
543 Toolkit::Control::ResourceReadySignalType mResourceReadySignal;
544 DevelControl::VisualEventSignalType mVisualEventSignal;
547 Toolkit::DevelControl::AccessibilityActivateSignalType mAccessibilityActivateSignal;
548 Toolkit::DevelControl::AccessibilityReadingSkippedSignalType mAccessibilityReadingSkippedSignal;
549 Toolkit::DevelControl::AccessibilityReadingPausedSignalType mAccessibilityReadingPausedSignal;
550 Toolkit::DevelControl::AccessibilityReadingResumedSignalType mAccessibilityReadingResumedSignal;
551 Toolkit::DevelControl::AccessibilityReadingCancelledSignalType mAccessibilityReadingCancelledSignal;
552 Toolkit::DevelControl::AccessibilityReadingStoppedSignalType mAccessibilityReadingStoppedSignal;
554 Toolkit::DevelControl::AccessibilityGetNameSignalType mAccessibilityGetNameSignal;
555 Toolkit::DevelControl::AccessibilityGetDescriptionSignalType mAccessibilityGetDescriptionSignal;
556 Toolkit::DevelControl::AccessibilityDoGestureSignalType mAccessibilityDoGestureSignal;
558 std::string mAccessibilityName;
559 std::string mAccessibilityDescription;
560 std::string mAccessibilityTranslationDomain;
561 std::string mAutomationId;
563 bool mAccessibilityHighlightable = false;
564 bool mAccessibilityHidden = false;
566 Dali::Accessibility::Role mAccessibilityRole = Dali::Accessibility::Role::UNKNOWN;
568 std::map<Dali::Accessibility::RelationType, std::set<Accessibility::Accessible*>> mAccessibilityRelations;
569 std::unique_ptr<Toolkit::DevelControl::ControlAccessible> mAccessibleObject;
572 PinchGestureDetector mPinchGestureDetector;
573 PanGestureDetector mPanGestureDetector;
574 TapGestureDetector mTapGestureDetector;
575 LongPressGestureDetector mLongPressGestureDetector;
580 InputMethodContext mInputMethodContext;
581 CallbackBase* mIdleCallback; ///< The idle callback to emit the resource ready signal.
583 ControlBehaviour mFlags : CONTROL_BEHAVIOUR_FLAG_COUNT; ///< Flags passed in from constructor.
584 bool mIsKeyboardNavigationSupported : 1; ///< Stores whether keyboard navigation is supported by the control.
585 bool mIsKeyboardFocusGroup : 1; ///< Stores whether the control is a focus group.
586 bool mIsEmittingResourceReadySignal : 1; ///< True during ResourceReady().
587 bool mNeedToEmitResourceReady : 1; ///< True if need to emit the resource ready signal again.
588 bool mDispatchKeyEvents : 1; ///< Whether the actor emits key event signals
590 RegisteredVisualContainer mRemoveVisuals; ///< List of visuals that are being replaced by another visual once ready
592 // Properties - these need to be members of Internal::Control::Impl as they access private methods/data of Internal::Control and Internal::Control::Impl.
593 static const PropertyRegistration PROPERTY_1;
594 static const PropertyRegistration PROPERTY_2;
595 static const PropertyRegistration PROPERTY_3;
596 static const PropertyRegistration PROPERTY_4;
597 static const PropertyRegistration PROPERTY_5;
598 static const PropertyRegistration PROPERTY_6;
599 static const PropertyRegistration PROPERTY_7;
600 static const PropertyRegistration PROPERTY_8;
601 static const PropertyRegistration PROPERTY_9;
602 static const PropertyRegistration PROPERTY_10;
603 static const PropertyRegistration PROPERTY_11;
604 static const PropertyRegistration PROPERTY_12;
605 static const PropertyRegistration PROPERTY_13;
606 static const PropertyRegistration PROPERTY_14;
607 static const PropertyRegistration PROPERTY_15;
608 static const PropertyRegistration PROPERTY_16;
609 static const PropertyRegistration PROPERTY_17;
610 static const PropertyRegistration PROPERTY_18;
611 static const PropertyRegistration PROPERTY_19;
612 static const PropertyRegistration PROPERTY_20;
613 static const PropertyRegistration PROPERTY_21;
614 static const PropertyRegistration PROPERTY_22;
615 static const PropertyRegistration PROPERTY_23;
616 static const PropertyRegistration PROPERTY_24;
617 static const PropertyRegistration PROPERTY_25;
618 static const PropertyRegistration PROPERTY_26;
621 // Accessibility - notification for highlighted object to check if it is showing.
622 bool mIsAccessibilityPositionPropertyNotificationSet{false};
623 Dali::PropertyNotification mAccessibilityPositionNotification;
624 Dali::Accessibility::ScreenRelativeMoveType mAccessibilityLastScreenRelativeMoveType{Accessibility::ScreenRelativeMoveType::OUTSIDE};
627 } // namespace Internal
629 } // namespace Toolkit
633 #endif // DALI_TOOLKIT_CONTROL_DATA_IMPL_H