1 #ifndef DALI_TOOLKIT_CONTROL_DATA_IMPL_H
2 #define DALI_TOOLKIT_CONTROL_DATA_IMPL_H
5 * Copyright (c) 2022 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;
58 RegisteredVisual(Property::Index aIndex, Toolkit::Visual::Base& aVisual, bool aEnabled, bool aPendingReplacement)
62 pending(aPendingReplacement)
67 typedef Dali::OwnerContainer<RegisteredVisual*> RegisteredVisualContainer;
70 * @brief Holds the Implementation for the internal control class
72 class Control::Impl : public ConnectionTracker, public Visual::EventObserver
74 friend class Toolkit::DevelControl::ControlAccessible;
78 * @brief Retrieves the implementation of the internal control class.
79 * @param[in] internalControl A ref to the control whose internal implementation is required
80 * @return The internal implementation
82 static Control::Impl& Get(Internal::Control& internalControl);
85 * @copydoc Get( Internal::Control& )
87 static const Control::Impl& Get(const Internal::Control& internalControl);
91 * @param[in] controlImpl The control which owns this implementation
93 Impl(Control& controlImpl);
101 * @brief Called when a pinch is detected.
102 * @param[in] actor The actor the pinch occurred on
103 * @param[in] pinch The pinch gesture details
105 void PinchDetected(Actor actor, const PinchGesture& pinch);
108 * @brief Called when a pan is detected.
109 * @param[in] actor The actor the pan occurred on
110 * @param[in] pinch The pan gesture details
112 void PanDetected(Actor actor, const PanGesture& pan);
115 * @brief Called when a tap is detected.
116 * @param[in] actor The actor the tap occurred on
117 * @param[in] pinch The tap gesture details
119 void TapDetected(Actor actor, const TapGesture& tap);
122 * @brief Called when a long-press is detected.
123 * @param[in] actor The actor the long-press occurred on
124 * @param[in] pinch The long-press gesture details
126 void LongPressDetected(Actor actor, const LongPressGesture& longPress);
129 * @brief Called when resources of control are ready.
130 * @param[in] relayoutRequest True to request relayout
132 void ResourceReady(bool relayoutRequest);
135 * @brief Called when a resource is ready.
136 * @param[in] object The visual whose resources are ready
137 * @note Overriding method in Visual::EventObserver.
139 void ResourceReady(Visual::Base& object) override;
142 * @brief Called when an event occurs.
143 * @param[in] object The visual whose events occur
144 * @param[in] signalId The signal to emit. See Visual to find supported signals
145 * @note Overriding method in Visual::EventObserver.
147 void NotifyVisualEvent(Visual::Base& object, Property::Index signalId) override;
150 * @brief Called when the visual needs relayout request.
151 * @param[in] object The visual who requests relayout
153 void RelayoutRequest(Visual::Base& object) override;
156 * @copydoc Dali::Toolkit::DevelControl::RegisterVisual()
158 void RegisterVisual(Property::Index index, Toolkit::Visual::Base& visual);
161 * @copydoc Dali::Toolkit::DevelControl::RegisterVisual()
163 void RegisterVisual(Property::Index index, Toolkit::Visual::Base& visual, int depthIndex);
166 * @copydoc Dali::Toolkit::DevelControl::RegisterVisual()
168 void RegisterVisual(Property::Index index, Toolkit::Visual::Base& visual, bool enabled);
171 * @copydoc Dali::Toolkit::DevelControl::RegisterVisual()
173 void RegisterVisual(Property::Index index, Toolkit::Visual::Base& visual, bool enabled, int depthIndex);
176 * @copydoc Dali::Toolkit::DevelControl::UnregisterVisual()
178 void UnregisterVisual(Property::Index index);
181 * @copydoc Dali::Toolkit::DevelControl::GetVisual()
183 Toolkit::Visual::Base GetVisual(Property::Index index) const;
186 * @copydoc Dali::Toolkit::DevelControl::EnableVisual()
188 void EnableVisual(Property::Index index, bool enable);
191 * @copydoc Dali::Toolkit::DevelControl::IsVisualEnabled()
193 bool IsVisualEnabled(Property::Index index) const;
196 * @brief Stops observing the given visual.
197 * @param[in] visual The visual to stop observing
199 void StopObservingVisual(Toolkit::Visual::Base& visual);
202 * @brief Starts observing the given visual.
203 * @param[in] visual The visual to start observing
205 void StartObservingVisual(Toolkit::Visual::Base& visual);
208 * @copydoc Dali::Toolkit::DevelControl::GetVisualResourceStatus()
210 Toolkit::Visual::ResourceStatus GetVisualResourceStatus(Property::Index index) const;
213 * @param[in,out] animation Handle to existing animation, or an empty handle that
214 * can be set to a New animation if createAnimation is true
215 * @param[in] transitionData The transition data describing the animation
216 * @param[in] createAnimation True if the animation should be created
218 void AddTransitions(Dali::Animation& animation,
219 const Toolkit::TransitionData& transitionData,
220 bool createAnimation = false);
223 * @copydoc Dali::Toolkit::DevelControl::CreateTransition()
225 Dali::Animation CreateTransition(const Toolkit::TransitionData& transitionData);
228 * @copydoc Dali::Toolkit::DevelControl::DoAction()
230 void DoAction(Dali::Property::Index visualIndex, Dali::Property::Index actionId, const Dali::Property::Value attributes);
233 * @copydoc Dali::Toolkit::DevelControl::DoActionExtension()
235 void DoActionExtension(Dali::Property::Index visualIndex, Dali::Property::Index actionId, Dali::Any attributes);
238 * @brief Function used to set control properties.
239 * @param[in] object The object whose property to set
240 * @param[in] index The index of the property to set
241 * @param[in] value The value of the property to set
243 static void SetProperty(BaseObject* object, Property::Index index, const Property::Value& value);
246 * @brief Function used to retrieve the value of control properties.
247 * @param[in] object The object whose property to get
248 * @param[in] index The index of the property to get
249 * @return The value of the property
251 static Property::Value GetProperty(BaseObject* object, Property::Index index);
254 * @brief Sets the state of the control.
255 * @param[in] newState The state to set
256 * @param[in] withTransitions Whether to show a transition when changing to the new state
258 void SetState(DevelControl::State newState, bool withTransitions = true);
261 * @brief Sets the sub-state of the control.
262 * @param[in] newState The sub-state to set
263 * @param[in] withTransitions Whether to show a transition when changing to the new sub-state
265 void SetSubState(const std::string& subStateName, bool withTransitions = true);
268 * @brief Replaces visuals and properties from the old state to the new state.
269 * @param[in] oldState The old state
270 * @param[in] newState The new state
271 * @param[in] subState The current sub state
273 void ReplaceStateVisualsAndProperties(const StylePtr oldState, const StylePtr newState, const std::string& subState);
276 * @brief Removes a visual from the control's container.
277 * @param[in] visuals The container of visuals
278 * @param[in] visualName The name of the visual to remove
280 void RemoveVisual(RegisteredVisualContainer& visuals, const std::string& visualName);
283 * @brief Removes several visuals from the control's container.
284 * @param[in] visuals The container of visuals
285 * @param[in] removeVisuals The visuals to remove
287 void RemoveVisuals(RegisteredVisualContainer& visuals, DictionaryKeys& removeVisuals);
290 * @brief Copies the visual properties that are specific to the control instance into the instancedProperties container.
291 * @param[in] visuals The control's visual container
292 * @param[out] instancedProperties The instanced properties are added to this container
294 void CopyInstancedProperties(RegisteredVisualContainer& visuals, Dictionary<Property::Map>& instancedProperties);
297 * @brief On state change, ensures visuals are moved or created appropriately.
299 * Go through the list of visuals that are common to both states.
300 * If they are different types, or are both image types with different
301 * URLs, then the existing visual needs moving and the new visual needs creating
303 * @param[in] stateVisualsToChange The visuals to change
304 * @param[in] instancedProperties The instanced properties @see CopyInstancedProperties
306 void RecreateChangedVisuals(Dictionary<Property::Map>& stateVisualsToChange, Dictionary<Property::Map>& instancedProperties);
309 * @brief Whether the resource is ready
310 * @return True if the resource is read.
312 bool IsResourceReady() const;
315 * @copydoc CustomActorImpl::OnSceneDisconnection()
317 void OnSceneDisconnection();
320 * @brief Sets the margin.
321 * @param[in] margin Margin is a collections of extent ( start, end, top, bottom )
323 void SetMargin(Extents margin);
326 * @brief Returns the value of margin
327 * @return The value of margin
329 Extents GetMargin() const;
332 * @brief Sets the padding.
333 * @param[in] padding Padding is a collections of extent ( start, end, top, bottom ).
335 void SetPadding(Extents padding);
338 * @brief Returns the value of padding
339 * @return The value of padding
341 Extents GetPadding() const;
344 * @brief Set the input method context.
345 * @param[in] inputMethodContext The input method context.
347 void SetInputMethodContext(InputMethodContext& inputMethodContext);
350 * @brief Filter an key event.
351 * @param[in] event The key to be filtered.
352 * @return True if the key handled, otherwise false.
354 bool FilterKeyEvent(const KeyEvent& event);
357 * @brief Adds accessibility attribute
358 * @param[in] key Attribute name to set
359 * @param[in] value Attribute value to set
361 * Attribute is added if not existed previously or updated
364 void AppendAccessibilityAttribute(const std::string& key, const std::string value);
367 * @brief Removes accessibility attribute
368 * @param[in] key Attribute name to remove
370 * Function does nothing if attribute doesn't exist.
372 void RemoveAccessibilityAttribute(const std::string& key);
375 * @brief Removes all accessibility attributes
377 void ClearAccessibilityAttributes();
380 * @brief Sets reading info type attributes
381 * @param[in] types info type attributes to set
383 * This function sets, which part of object will be read out
386 void SetAccessibilityReadingInfoType(const Dali::Accessibility::ReadingInfoTypes types);
389 * @brief Gets currently active reading info type attributes
391 Dali::Accessibility::ReadingInfoTypes GetAccessibilityReadingInfoType() const;
394 * @copydoc DevelControl::VisualEventSignal()
396 DevelControl::VisualEventSignalType& VisualEventSignal();
399 * @brief Sets the shadow with a property map.
400 * @param[in] map The shadow property map
402 void SetShadow(const Property::Map& map);
405 * @brief Clear the shadow.
410 * @copydoc DevelControl::GetVisualProperty()
412 Dali::Property GetVisualProperty(Dali::Property::Index index, Dali::Property::Key visualPropertyKey);
415 * @brief Retrieves source and destination visual properties for the Transition of this Control.
416 * The properties of this Control will be transitioned from the propeties of source Control to that of destination control.
417 * If a property value is different between source and destination Control,
418 * the property information of each Control will be included in sourceProperties and destinationProperties.
420 * @param[out] sourceProperties Source property list to be applied on this Control.
421 * @param[out] destinationProperties Destination property list to be applied on this Control.
422 * @param[in] source Source control of the animation.
423 * @param[in] destination Destination control of the animation.
425 * @note This method do not handle Actor properties.
426 * And the size and order of the sourceProperties and destinationProperties must be synchronized.
428 * This method triggers Control::OnCreateTransition().
430 void CreateTransitions(std::vector<std::pair<Dali::Property::Index, Dali::Property::Map>>& sourceProperties,
431 std::vector<std::pair<Dali::Property::Index, Dali::Property::Map>>& destinationProperties,
432 Dali::Toolkit::Control source,
433 Dali::Toolkit::Control destination);
436 * @brief Update visual properties.
437 * @param[in] properties Property list to be used to update visual properties of this Control.
439 * @note This method triggers Control::OnUpdateVisualProperties().
441 void UpdateVisualProperties(const std::vector<std::pair<Dali::Property::Index, Dali::Property::Map>>& properties);
444 * @copydoc Dali::Toolkit::Internal::Control::GetAccessibleObject()
446 Toolkit::DevelControl::ControlAccessible* GetAccessibleObject();
450 * Used as an alternative to boolean so that it is obvious whether a visual is enabled/disabled.
456 DISABLED = 0, ///< Visual disabled.
457 ENABLED = 1 ///< Visual enabled.
462 * 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.
464 struct DepthIndexValue
468 NOT_SET = 0, ///< Visual depth value not set by caller.
469 SET = 1 ///< Visual depth value set by caller.
474 * @brief Adds the visual to the list of registered visuals.
475 * @param[in] index The Property index of the visual, used to reference visual
476 * @param[in,out] visual The visual to register, which can be altered in this function
477 * @param[in] enabled false if derived class wants to control when visual is set on stage
478 * @param[in] depthIndexValueSet Set to true if the depthIndex has actually been set manually
479 * @param[in] depthIndex The visual's depth-index is set to this
481 * @note Registering a visual with an index that already has a registered visual will replace it. The replacement will
482 * occur once the replacement visual is ready (loaded).
484 void RegisterVisual(Property::Index index, Toolkit::Visual::Base& visual, VisualState::Type enabled, DepthIndexValue::Type depthIndexValueSet, int depthIndex = 0);
487 * @brief Emits the resource ready signal.
489 void EmitResourceReadySignal();
492 * @brief Callbacks called on idle.
494 void OnIdleCallback();
497 * @brief Checks highlighted object geometry if it is showing or not
499 void CheckHighlightedObjectGeometry();
502 * @brief Register property notification to check highlighted object position
504 void RegisterAccessibilityPositionPropertyNotification();
507 * @brief Remove property notification added by RegisterPropertyNotification
509 void UnregisterAccessibilityPositionPropertyNotification();
512 Control& mControlImpl;
513 DevelControl::State mState;
514 std::string mSubStateName;
515 Property::Map mAccessibilityAttributes;
517 int mLeftFocusableActorId; ///< Actor ID of Left focusable control.
518 int mRightFocusableActorId; ///< Actor ID of Right focusable control.
519 int mUpFocusableActorId; ///< Actor ID of Up focusable control.
520 int mDownFocusableActorId; ///< Actor ID of Down focusable control.
521 int mClockwiseFocusableActorId; ///< Actor ID of Clockwise focusable control.
522 int mCounterClockwiseFocusableActorId; ///< Actor ID of Counter clockwise focusable control.
524 RegisteredVisualContainer mVisuals; ///< Stores visuals needed by the control, non trivial type so std::vector used.
525 std::string mStyleName;
526 Vector4 mBackgroundColor; ///< The color of the background visual
527 Vector3* mStartingPinchScale; ///< The scale when a pinch gesture starts, TODO: consider removing this
528 Extents mMargin; ///< The margin values
529 Extents mPadding; ///< The padding values
530 Toolkit::Control::KeyEventSignalType mKeyEventSignal;
531 Toolkit::Control::KeyInputFocusSignalType mKeyInputFocusGainedSignal;
532 Toolkit::Control::KeyInputFocusSignalType mKeyInputFocusLostSignal;
533 Toolkit::Control::ResourceReadySignalType mResourceReadySignal;
534 DevelControl::VisualEventSignalType mVisualEventSignal;
537 Toolkit::DevelControl::AccessibilityActivateSignalType mAccessibilityActivateSignal;
538 Toolkit::DevelControl::AccessibilityReadingSkippedSignalType mAccessibilityReadingSkippedSignal;
539 Toolkit::DevelControl::AccessibilityReadingPausedSignalType mAccessibilityReadingPausedSignal;
540 Toolkit::DevelControl::AccessibilityReadingResumedSignalType mAccessibilityReadingResumedSignal;
541 Toolkit::DevelControl::AccessibilityReadingCancelledSignalType mAccessibilityReadingCancelledSignal;
542 Toolkit::DevelControl::AccessibilityReadingStoppedSignalType mAccessibilityReadingStoppedSignal;
544 Toolkit::DevelControl::AccessibilityGetNameSignalType mAccessibilityGetNameSignal;
545 Toolkit::DevelControl::AccessibilityGetDescriptionSignalType mAccessibilityGetDescriptionSignal;
546 Toolkit::DevelControl::AccessibilityDoGestureSignalType mAccessibilityDoGestureSignal;
548 std::string mAccessibilityName;
549 std::string mAccessibilityDescription;
550 std::string mAccessibilityTranslationDomain;
551 std::string mAutomationId;
553 bool mAccessibilityHighlightable = false;
554 bool mAccessibilityHidden = false;
556 Dali::Accessibility::Role mAccessibilityRole = Dali::Accessibility::Role::UNKNOWN;
558 std::map<Dali::Accessibility::RelationType, std::set<Accessibility::Accessible*>> mAccessibilityRelations;
559 std::unique_ptr<Toolkit::DevelControl::ControlAccessible> mAccessibleObject;
562 PinchGestureDetector mPinchGestureDetector;
563 PanGestureDetector mPanGestureDetector;
564 TapGestureDetector mTapGestureDetector;
565 LongPressGestureDetector mLongPressGestureDetector;
570 InputMethodContext mInputMethodContext;
571 CallbackBase* mIdleCallback; ///< The idle callback to emit the resource ready signal.
573 ControlBehaviour mFlags : CONTROL_BEHAVIOUR_FLAG_COUNT; ///< Flags passed in from constructor.
574 bool mIsKeyboardNavigationSupported : 1; ///< Stores whether keyboard navigation is supported by the control.
575 bool mIsKeyboardFocusGroup : 1; ///< Stores whether the control is a focus group.
576 bool mIsEmittingResourceReadySignal : 1; ///< True during ResourceReady().
577 bool mNeedToEmitResourceReady : 1; ///< True if need to emit the resource ready signal again.
578 bool mDispatchKeyEvents : 1; ///< Whether the actor emits key event signals
580 RegisteredVisualContainer mRemoveVisuals; ///< List of visuals that are being replaced by another visual once ready
582 // Properties - these need to be members of Internal::Control::Impl as they access private methods/data of Internal::Control and Internal::Control::Impl.
583 static const PropertyRegistration PROPERTY_1;
584 static const PropertyRegistration PROPERTY_2;
585 static const PropertyRegistration PROPERTY_3;
586 static const PropertyRegistration PROPERTY_4;
587 static const PropertyRegistration PROPERTY_5;
588 static const PropertyRegistration PROPERTY_6;
589 static const PropertyRegistration PROPERTY_7;
590 static const PropertyRegistration PROPERTY_8;
591 static const PropertyRegistration PROPERTY_9;
592 static const PropertyRegistration PROPERTY_10;
593 static const PropertyRegistration PROPERTY_11;
594 static const PropertyRegistration PROPERTY_12;
595 static const PropertyRegistration PROPERTY_13;
596 static const PropertyRegistration PROPERTY_14;
597 static const PropertyRegistration PROPERTY_15;
598 static const PropertyRegistration PROPERTY_16;
599 static const PropertyRegistration PROPERTY_17;
600 static const PropertyRegistration PROPERTY_18;
601 static const PropertyRegistration PROPERTY_19;
602 static const PropertyRegistration PROPERTY_20;
603 static const PropertyRegistration PROPERTY_21;
604 static const PropertyRegistration PROPERTY_22;
605 static const PropertyRegistration PROPERTY_23;
606 static const PropertyRegistration PROPERTY_24;
607 static const PropertyRegistration PROPERTY_25;
608 static const PropertyRegistration PROPERTY_26;
611 // Accessibility - notification for highlighted object to check if it is showing.
612 bool mIsAccessibilityPositionPropertyNotificationSet{false};
613 Dali::PropertyNotification mAccessibilityPositionNotification;
614 Dali::Accessibility::ScreenRelativeMoveType mAccessibilityLastScreenRelativeMoveType{Accessibility::ScreenRelativeMoveType::OUTSIDE};
617 } // namespace Internal
619 } // namespace Toolkit
623 #endif // DALI_TOOLKIT_CONTROL_DATA_IMPL_H