1 #ifndef DALI_TOOLKIT_CONTROL_DATA_IMPL_H
2 #define DALI_TOOLKIT_CONTROL_DATA_IMPL_H
5 * Copyright (c) 2021 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/devel-api/adaptor-framework/autofill-item.h>
25 #include <dali/devel-api/adaptor-framework/autofill-manager.h>
26 #include <dali/public-api/object/property-notification.h>
27 #include <dali/public-api/object/type-registry.h>
31 #include <dali-toolkit/devel-api/visual-factory/visual-base.h>
32 #include <dali-toolkit/devel-api/controls/text-controls/autofill-container.h>
33 #include <dali-toolkit/internal/builder/dictionary.h>
34 #include <dali-toolkit/internal/builder/style.h>
35 #include <dali-toolkit/internal/controls/tooltip/tooltip.h>
36 #include <dali-toolkit/internal/visuals/visual-event-observer.h>
37 #include <dali-toolkit/public-api/controls/control-impl.h>
38 #include <dali-toolkit/public-api/visuals/visual-properties.h>
39 #include <dali/devel-api/common/owner-container.h>
40 #include <dali/integration-api/debug.h>
50 * Struct used to store Visual within the control, index is a unique key for each visual.
52 struct RegisteredVisual
54 Property::Index index;
55 Toolkit::Visual::Base visual;
59 RegisteredVisual(Property::Index aIndex, Toolkit::Visual::Base& aVisual, bool aEnabled, bool aPendingReplacement)
63 pending(aPendingReplacement)
68 typedef Dali::OwnerContainer<RegisteredVisual*> RegisteredVisualContainer;
71 * @brief Holds the Implementation for the internal control class
73 class Control::Impl : public ConnectionTracker, public Visual::EventObserver
77 * @brief Retrieves the implementation of the internal control class.
78 * @param[in] internalControl A ref to the control whose internal implementation is required
79 * @return The internal implementation
81 static Control::Impl& Get(Internal::Control& internalControl);
84 * @copydoc Get( Internal::Control& )
86 static const Control::Impl& Get(const Internal::Control& internalControl);
90 * @param[in] controlImpl The control which owns this implementation
92 Impl(Control& controlImpl);
100 * @brief Called when a pinch is detected.
101 * @param[in] actor The actor the pinch occurred on
102 * @param[in] pinch The pinch gesture details
104 void PinchDetected(Actor actor, const PinchGesture& pinch);
107 * @brief Called when a pan is detected.
108 * @param[in] actor The actor the pan occurred on
109 * @param[in] pinch The pan gesture details
111 void PanDetected(Actor actor, const PanGesture& pan);
114 * @brief Called when a tap is detected.
115 * @param[in] actor The actor the tap occurred on
116 * @param[in] pinch The tap gesture details
118 void TapDetected(Actor actor, const TapGesture& tap);
121 * @brief Called when a long-press is detected.
122 * @param[in] actor The actor the long-press occurred on
123 * @param[in] pinch The long-press gesture details
125 void LongPressDetected(Actor actor, const LongPressGesture& longPress);
128 * @brief Called when a resource is ready.
129 * @param[in] object The visual whose resources are ready
130 * @note Overriding method in Visual::EventObserver.
132 void ResourceReady(Visual::Base& object) override;
135 * @brief Called when an event occurs.
136 * @param[in] object The visual whose events occur
137 * @param[in] signalId The signal to emit. See Visual to find supported signals
138 * @note Overriding method in Visual::EventObserver.
140 void NotifyVisualEvent(Visual::Base& object, Property::Index signalId) override;
143 * @copydoc Dali::Toolkit::DevelControl::RegisterVisual()
145 void RegisterVisual(Property::Index index, Toolkit::Visual::Base& visual);
148 * @copydoc Dali::Toolkit::DevelControl::RegisterVisual()
150 void RegisterVisual(Property::Index index, Toolkit::Visual::Base& visual, int depthIndex);
153 * @copydoc Dali::Toolkit::DevelControl::RegisterVisual()
155 void RegisterVisual(Property::Index index, Toolkit::Visual::Base& visual, bool enabled);
158 * @copydoc Dali::Toolkit::DevelControl::RegisterVisual()
160 void RegisterVisual(Property::Index index, Toolkit::Visual::Base& visual, bool enabled, int depthIndex);
163 * @copydoc Dali::Toolkit::DevelControl::UnregisterVisual()
165 void UnregisterVisual(Property::Index index);
168 * @copydoc Dali::Toolkit::DevelControl::GetVisual()
170 Toolkit::Visual::Base GetVisual(Property::Index index) const;
173 * @copydoc Dali::Toolkit::DevelControl::EnableVisual()
175 void EnableVisual(Property::Index index, bool enable);
178 * @copydoc Dali::Toolkit::DevelControl::IsVisualEnabled()
180 bool IsVisualEnabled(Property::Index index) const;
183 * @brief Stops observing the given visual.
184 * @param[in] visual The visual to stop observing
186 void StopObservingVisual(Toolkit::Visual::Base& visual);
189 * @brief Starts observing the given visual.
190 * @param[in] visual The visual to start observing
192 void StartObservingVisual(Toolkit::Visual::Base& visual);
195 * @copydoc Dali::Toolkit::DevelControl::GetVisualResourceStatus()
197 Toolkit::Visual::ResourceStatus GetVisualResourceStatus(Property::Index index) const;
200 * @param[in,out] animation Handle to existing animation, or an empty handle that
201 * can be set to a New animation if createAnimation is true
202 * @param[in] transitionData The transition data describing the animation
203 * @param[in] createAnimation True if the animation should be created
205 void AddTransitions(Dali::Animation& animation,
206 const Toolkit::TransitionData& transitionData,
207 bool createAnimation = false);
210 * @copydoc Dali::Toolkit::DevelControl::CreateTransition()
212 Dali::Animation CreateTransition(const Toolkit::TransitionData& transitionData);
215 * @copydoc Dali::Toolkit::DevelControl::DoAction()
217 void DoAction(Dali::Property::Index visualIndex, Dali::Property::Index actionId, const Dali::Property::Value attributes);
220 * @brief Function used to set control properties.
221 * @param[in] object The object whose property to set
222 * @param[in] index The index of the property to set
223 * @param[in] value The value of the property to set
225 static void SetProperty(BaseObject* object, Property::Index index, const Property::Value& value);
228 * @brief Function used to retrieve the value of control properties.
229 * @param[in] object The object whose property to get
230 * @param[in] index The index of the property to get
231 * @return The value of the property
233 static Property::Value GetProperty(BaseObject* object, Property::Index index);
236 * @brief Sets the state of the control.
237 * @param[in] newState The state to set
238 * @param[in] withTransitions Whether to show a transition when changing to the new state
240 void SetState(DevelControl::State newState, bool withTransitions = true);
243 * @brief Sets the sub-state of the control.
244 * @param[in] newState The sub-state to set
245 * @param[in] withTransitions Whether to show a transition when changing to the new sub-state
247 void SetSubState(const std::string& subStateName, bool withTransitions = true);
250 * @brief Replaces visuals and properties from the old state to the new state.
251 * @param[in] oldState The old state
252 * @param[in] newState The new state
253 * @param[in] subState The current sub state
255 void ReplaceStateVisualsAndProperties(const StylePtr oldState, const StylePtr newState, const std::string& subState);
258 * @brief Removes a visual from the control's container.
259 * @param[in] visuals The container of visuals
260 * @param[in] visualName The name of the visual to remove
262 void RemoveVisual(RegisteredVisualContainer& visuals, const std::string& visualName);
265 * @brief Removes several visuals from the control's container.
266 * @param[in] visuals The container of visuals
267 * @param[in] removeVisuals The visuals to remove
269 void RemoveVisuals(RegisteredVisualContainer& visuals, DictionaryKeys& removeVisuals);
272 * @brief Copies the visual properties that are specific to the control instance into the instancedProperties container.
273 * @param[in] visuals The control's visual container
274 * @param[out] instancedProperties The instanced properties are added to this container
276 void CopyInstancedProperties(RegisteredVisualContainer& visuals, Dictionary<Property::Map>& instancedProperties);
279 * @brief On state change, ensures visuals are moved or created appropriately.
281 * Go through the list of visuals that are common to both states.
282 * If they are different types, or are both image types with different
283 * URLs, then the existing visual needs moving and the new visual needs creating
285 * @param[in] stateVisualsToChange The visuals to change
286 * @param[in] instancedProperties The instanced properties @see CopyInstancedProperties
288 void RecreateChangedVisuals(Dictionary<Property::Map>& stateVisualsToChange, Dictionary<Property::Map>& instancedProperties);
291 * @brief Whether the resource is ready
292 * @return True if the resource is read.
294 bool IsResourceReady() const;
297 * @copydoc CustomActorImpl::OnSceneDisconnection()
299 void OnSceneDisconnection();
302 * @brief Sets the margin.
303 * @param[in] margin Margin is a collections of extent ( start, end, top, bottom )
305 void SetMargin(Extents margin);
308 * @brief Returns the value of margin
309 * @return The value of margin
311 Extents GetMargin() const;
314 * @brief Sets the padding.
315 * @param[in] padding Padding is a collections of extent ( start, end, top, bottom ).
317 void SetPadding(Extents padding);
320 * @brief Returns the value of padding
321 * @return The value of padding
323 Extents GetPadding() const;
326 * @brief Set the input method context.
327 * @param[in] inputMethodContext The input method context.
329 void SetInputMethodContext(InputMethodContext& inputMethodContext);
332 * @brief Filter an key event.
333 * @param[in] event The key to be filtered.
334 * @return True if the key handled, otherwise false.
336 bool FilterKeyEvent(const KeyEvent& event);
339 * @brief Adds accessibility attribute
340 * @param[in] key Attribute name to set
341 * @param[in] value Attribute value to set
343 * Attribute is added if not existed previously or updated
346 void AppendAccessibilityAttribute(const std::string& key,
347 const std::string value);
350 * @brief Removes accessibility attribute
351 * @param[in] key Attribute name to remove
353 * Function does nothing if attribute doesn't exist.
355 void RemoveAccessibilityAttribute(const std::string& key);
358 * @brief Removes all accessibility attributes
360 void ClearAccessibilityAttributes();
363 * @brief Sets reading info type attributes
364 * @param[in] types info type attributes to set
366 * This function sets, which part of object will be read out
369 void SetAccessibilityReadingInfoType(const Dali::Accessibility::ReadingInfoTypes types);
372 * @brief Gets currently active reading info type attributes
374 Dali::Accessibility::ReadingInfoTypes GetAccessibilityReadingInfoType() const;
377 * @copydoc DevelControl::VisualEventSignal()
379 DevelControl::VisualEventSignalType& VisualEventSignal();
382 * @brief Sets the shadow with a property map.
383 * @param[in] map The shadow property map
385 void SetShadow(const Property::Map& map);
388 * @brief Clear the shadow.
393 * @brief Sets whether the Autofill functionality is enabled.
394 * @param[in] autofillEnabled Set true when Autofill should be enabled.
396 void SetAutofillEnabled( bool autofillEnabled );
399 * @brief Check if the Autofill framework is enabled.
400 * @return True if Autofill is enabled
402 bool IsAutofillEnabled();
405 * @brief Sets AutofillItemHandle
406 * @param item AutofillItem handle
408 void SetAutofillItemHandle( Dali::AutofillItem item );
411 * @brief Gets AutofillItemHandle
412 * @return AutofillItem handle
414 Dali::AutofillItem GetAutofillItemHandle();
417 * @brief Sets AutofillContainer which this control belongs to.
418 * @param[in] container
420 void SetAutofillContainer( Toolkit::AutofillContainer container );
423 * @brief Gets AutofillContainer that the control belongs to.
424 * @return AutofillContainer handle
426 Toolkit::AutofillContainer GetAutofillContainer();
429 * @copydoc DevelControl::GetVisualProperty()
431 Dali::Property GetVisualProperty(Dali::Property::Index index, Dali::Property::Key visualPropertyKey);
435 * Used as an alternative to boolean so that it is obvious whether a visual is enabled/disabled.
441 DISABLED = 0, ///< Visual disabled.
442 ENABLED = 1 ///< Visual enabled.
447 * 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.
449 struct DepthIndexValue
453 NOT_SET = 0, ///< Visual depth value not set by caller.
454 SET = 1 ///< Visual depth value set by caller.
459 * @brief Adds the visual to the list of registered visuals.
460 * @param[in] index The Property index of the visual, used to reference visual
461 * @param[in,out] visual The visual to register, which can be altered in this function
462 * @param[in] enabled false if derived class wants to control when visual is set on stage
463 * @param[in] depthIndexValueSet Set to true if the depthIndex has actually been set manually
464 * @param[in] depthIndex The visual's depth-index is set to this
466 * @note Registering a visual with an index that already has a registered visual will replace it. The replacement will
467 * occur once the replacement visual is ready (loaded).
469 void RegisterVisual(Property::Index index, Toolkit::Visual::Base& visual, VisualState::Type enabled, DepthIndexValue::Type depthIndexValueSet, int depthIndex = 0);
472 * @brief Emits the resource ready signal.
474 void EmitResourceReadySignal();
477 * @brief Callbacks called on idle.
479 void OnIdleCallback();
482 Control& mControlImpl;
483 DevelControl::State mState;
484 std::string mSubStateName;
485 Property::Map mAccessibilityAttributes;
487 int mLeftFocusableActorId; ///< Actor ID of Left focusable control.
488 int mRightFocusableActorId; ///< Actor ID of Right focusable control.
489 int mUpFocusableActorId; ///< Actor ID of Up focusable control.
490 int mDownFocusableActorId; ///< Actor ID of Down focusable control.
492 RegisteredVisualContainer mVisuals; ///< Stores visuals needed by the control, non trivial type so std::vector used.
493 std::string mStyleName;
494 Vector4 mBackgroundColor; ///< The color of the background visual
495 Vector3* mStartingPinchScale; ///< The scale when a pinch gesture starts, TODO: consider removing this
496 Extents mMargin; ///< The margin values
497 Extents mPadding; ///< The padding values
498 Toolkit::Control::KeyEventSignalType mKeyEventSignal;
499 Toolkit::Control::KeyInputFocusSignalType mKeyInputFocusGainedSignal;
500 Toolkit::Control::KeyInputFocusSignalType mKeyInputFocusLostSignal;
501 Toolkit::Control::ResourceReadySignalType mResourceReadySignal;
502 DevelControl::VisualEventSignalType mVisualEventSignal;
503 Toolkit::DevelControl::AccessibilityActivateSignalType mAccessibilityActivateSignal;
504 Toolkit::DevelControl::AccessibilityReadingSkippedSignalType mAccessibilityReadingSkippedSignal;
505 Toolkit::DevelControl::AccessibilityReadingPausedSignalType mAccessibilityReadingPausedSignal;
506 Toolkit::DevelControl::AccessibilityReadingResumedSignalType mAccessibilityReadingResumedSignal;
507 Toolkit::DevelControl::AccessibilityReadingCancelledSignalType mAccessibilityReadingCancelledSignal;
508 Toolkit::DevelControl::AccessibilityReadingStoppedSignalType mAccessibilityReadingStoppedSignal;
510 Toolkit::DevelControl::AccessibilityGetNameSignalType mAccessibilityGetNameSignal;
511 Toolkit::DevelControl::AccessibilityGetDescriptionSignalType mAccessibilityGetDescriptionSignal;
512 Toolkit::DevelControl::AccessibilityDoGestureSignalType mAccessibilityDoGestureSignal;
514 std::string mAccessibilityName;
515 bool mAccessibilityNameSet = false;
517 std::string mAccessibilityDescription;
518 bool mAccessibilityDescriptionSet = false;
520 std::string mAccessibilityTranslationDomain;
521 bool mAccessibilityTranslationDomainSet = false;
523 bool mAccessibilityHighlightable = false;
524 bool mAccessibilityHighlightableSet = false;
526 Dali::Accessibility::Role mAccessibilityRole = Dali::Accessibility::Role::UNKNOWN;
528 std::vector<std::vector<Accessibility::Address>> mAccessibilityRelations;
529 bool mAccessibilityAnimated = false;
532 PinchGestureDetector mPinchGestureDetector;
533 PanGestureDetector mPanGestureDetector;
534 TapGestureDetector mTapGestureDetector;
535 LongPressGestureDetector mLongPressGestureDetector;
540 InputMethodContext mInputMethodContext;
541 CallbackBase* mIdleCallback; ///< The idle callback to emit the resource ready signal.
542 AutofillItem mAutofillItem;
543 Toolkit::AutofillContainer mAutofillContainer;
545 ControlBehaviour mFlags : CONTROL_BEHAVIOUR_FLAG_COUNT; ///< Flags passed in from constructor.
546 bool mIsKeyboardNavigationSupported : 1; ///< Stores whether keyboard navigation is supported by the control.
547 bool mIsKeyboardFocusGroup : 1; ///< Stores whether the control is a focus group.
548 bool mIsEmittingResourceReadySignal : 1; ///< True during ResourceReady().
549 bool mNeedToEmitResourceReady : 1; ///< True if need to emit the resource ready signal again.
550 bool mIsAutofillEnabled : 1; ///< Stroes whether the Autofill functionality is enabled.
552 RegisteredVisualContainer mRemoveVisuals; ///< List of visuals that are being replaced by another visual once ready
554 // Properties - these need to be members of Internal::Control::Impl as they access private methods/data of Internal::Control and Internal::Control::Impl.
555 static const PropertyRegistration PROPERTY_1;
556 static const PropertyRegistration PROPERTY_2;
557 static const PropertyRegistration PROPERTY_3;
558 static const PropertyRegistration PROPERTY_4;
559 static const PropertyRegistration PROPERTY_5;
560 static const PropertyRegistration PROPERTY_6;
561 static const PropertyRegistration PROPERTY_7;
562 static const PropertyRegistration PROPERTY_8;
563 static const PropertyRegistration PROPERTY_9;
564 static const PropertyRegistration PROPERTY_10;
565 static const PropertyRegistration PROPERTY_11;
566 static const PropertyRegistration PROPERTY_12;
567 static const PropertyRegistration PROPERTY_13;
568 static const PropertyRegistration PROPERTY_14;
569 static const PropertyRegistration PROPERTY_15;
570 static const PropertyRegistration PROPERTY_16;
571 static const PropertyRegistration PROPERTY_17;
572 static const PropertyRegistration PROPERTY_18;
573 static const PropertyRegistration PROPERTY_19;
574 static const PropertyRegistration PROPERTY_20;
575 static const PropertyRegistration PROPERTY_21;
576 static const PropertyRegistration PROPERTY_22;
579 * The method acquires Accessible handle from Actor object
580 * @param actor Actor object
581 * @return handle to Accessible object
583 static Dali::Accessibility::Accessible* GetAccessibilityObject(Dali::Actor actor);
584 Dali::Accessibility::Accessible* GetAccessibilityObject();
586 void AccessibilityRegister();
587 void AccessibilityDeregister();
589 struct AccessibleImpl : public virtual Dali::Accessibility::Accessible,
590 public virtual Dali::Accessibility::Component,
591 public virtual Dali::Accessibility::Collection,
592 public virtual Dali::Accessibility::Action
595 bool modal = false, root = false;
597 AccessibleImpl(Dali::Actor self, Dali::Accessibility::Role role, bool modal = false);
599 std::string GetName() override;
600 virtual std::string GetNameRaw();
601 std::string GetDescription() override;
602 virtual std::string GetDescriptionRaw();
603 Dali::Accessibility::Accessible* GetParent() override;
604 size_t GetChildCount() override;
605 Dali::Accessibility::Accessible* GetChildAtIndex(size_t index) override;
606 size_t GetIndexInParent() override;
607 Dali::Accessibility::Role GetRole() override;
608 Dali::Accessibility::States GetStates() override;
609 Dali::Accessibility::Attributes GetAttributes() override;
610 Dali::Rect<> GetExtents(Dali::Accessibility::CoordType ctype) override;
611 Dali::Accessibility::ComponentLayer GetLayer() override;
612 int16_t GetMdiZOrder() override;
613 bool GrabFocus() override;
614 double GetAlpha() override;
615 bool GrabHighlight() override;
616 bool ClearHighlight() override;
618 std::string GetActionName(size_t index) override;
619 std::string GetLocalizedActionName(size_t index) override;
620 std::string GetActionDescription(size_t index) override;
621 size_t GetActionCount() override;
622 std::string GetActionKeyBinding(size_t index) override;
623 bool DoAction(size_t index) override;
624 bool DoAction(const std::string& name) override;
625 bool DoGesture(const Dali::Accessibility::GestureInfo& gestureInfo) override;
626 std::vector<Dali::Accessibility::Relation> GetRelationSet() override;
628 virtual Dali::Accessibility::States CalculateStates();
629 virtual void EnsureChildVisible(Actor child);
630 virtual void EnsureSelfVisible();
631 virtual Property::Index GetNamePropertyIndex();
632 virtual Property::Index GetDescriptionPropertyIndex();
635 std::function<std::unique_ptr<Dali::Accessibility::Accessible>(Actor)> accessibilityConstructor;
636 std::unique_ptr<Dali::Accessibility::Accessible> accessibilityObject;
637 Dali::PropertyNotification accessibilityNotificationPosition, accessibilityNotificationSize, accessibilityNotificationCulled;
638 bool accessibilityNotificationSet = false;
639 static void PositionOrSizeChangedCallback(PropertyNotification&);
640 static void CulledChangedCallback(PropertyNotification&);
643 } // namespace Internal
645 } // namespace Toolkit
649 #endif // DALI_TOOLKIT_CONTROL_DATA_IMPL_H