Add RelayoutRequest on Control
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / public-api / controls / control-impl.h
1 #ifndef DALI_TOOLKIT_CONTROL_IMPL_H
2 #define DALI_TOOLKIT_CONTROL_IMPL_H
3
4 /*
5  * Copyright (c) 2021 Samsung Electronics Co., Ltd.
6  *
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
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
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.
18  *
19  */
20
21 // EXTERNAL INCLUDES
22 #include <dali/public-api/adaptor-framework/style-change.h>
23 #include <dali/public-api/animation/alpha-function.h>
24 #include <dali/public-api/animation/time-period.h>
25 #include <dali/public-api/events/long-press-gesture.h>
26 #include <dali/public-api/events/pan-gesture.h>
27 #include <dali/public-api/events/pinch-gesture.h>
28 #include <dali/public-api/events/tap-gesture.h>
29 #include <dali/public-api/object/property-index-ranges.h>
30 #include <dali/public-api/object/type-info.h>
31
32 // INTERNAL INCLUDES
33 #include <dali-toolkit/public-api/controls/control.h>
34
35 namespace Dali
36 {
37 namespace Toolkit
38 {
39 /**
40  * @addtogroup dali_toolkit_controls
41  * @{
42  */
43
44 class StyleManager;
45
46 namespace Internal
47 {
48 /**
49  * @brief This is the internal base class for all controls.
50  *
51  * It will provide some common functionality required by all controls.
52  * Implements ConnectionTrackerInterface so that signals (typically connected to member functions) will
53  * be disconnected automatically when the control is destroyed.
54  * @SINCE_1_0.0
55  */
56 class DALI_TOOLKIT_API Control : public CustomActorImpl, public ConnectionTrackerInterface
57 {
58 public:
59   class Extension; ///< Forward declare future extension interface
60
61   // Creation & Destruction
62
63   /**
64    * @brief Creates a new ControlImpl instance that does not require touch by default.
65    *
66    * If touch is required, then the user can connect to this class' touch signal.
67    * @SINCE_1_0.0
68    * @return A handle to the ControlImpl instance
69    */
70   static Toolkit::Control New();
71
72 protected:
73   /**
74    * @brief Virtual destructor.
75    * @SINCE_1_0.0
76    */
77   virtual ~Control();
78
79 public:
80   // Styling
81
82   /**
83    * @copydoc Dali::Toolkit::Control::SetStyleName
84    */
85   void SetStyleName(const std::string& styleName);
86
87   /**
88    * @copydoc Dali::Toolkit::Control::GetStyleName
89    */
90   const std::string& GetStyleName() const;
91
92   // Background
93
94   /**
95    * @copydoc Dali::Toolkit::Control::SetBackgroundColor
96    */
97   void SetBackgroundColor(const Vector4& color);
98
99   /**
100    * @brief Sets the background with a property map.
101    *
102    * @SINCE_1_0.0
103    * @param[in] map The background property map
104    */
105   void SetBackground(const Property::Map& map);
106
107   /**
108    * @copydoc Dali::CustomActorImpl::RelayoutRequest()
109    */
110   void RelayoutRequest();
111
112   /**
113    * @copydoc Dali::Toolkit::Control::ClearBackground
114    */
115   void ClearBackground();
116
117   // Gesture Detection
118
119   /**
120    * @brief Allows deriving classes to enable any of the gesture detectors that are available.
121    *
122    * Gesture detection can be enabled one at a time or in bitwise format as shown:
123    * @code
124    * EnableGestureDetection(GestureType::Value(GestureType::PINCH | GestureType::TAP | GestureType::PAN));
125    * @endcode
126    * @SINCE_1_0.0
127    * @param[in] type The gesture type(s) to enable
128    */
129   void EnableGestureDetection(GestureType::Value type);
130
131   /**
132    * @brief Allows deriving classes to disable any of the gesture detectors.
133    *
134    * Like EnableGestureDetection, this can also be called using bitwise or.
135    * @SINCE_1_0.0
136    * @param[in] type The gesture type(s) to disable
137    * @see EnableGetureDetection
138    */
139   void DisableGestureDetection(GestureType::Value type);
140
141   /**
142    * @brief If deriving classes wish to fine tune pinch gesture
143    * detection, then they can access the gesture detector through this
144    * API and modify the detection.
145    *
146    * @SINCE_1_0.0
147    * @return The pinch gesture detector
148    * @pre Pinch detection should have been enabled via EnableGestureDetection().
149    * @see EnableGestureDetection
150    */
151   PinchGestureDetector GetPinchGestureDetector() const;
152
153   /**
154    * @brief If deriving classes wish to fine tune pan gesture
155    * detection, then they can access the gesture detector through this
156    * API and modify the detection.
157    *
158    * @SINCE_1_0.0
159    * @return The pan gesture detector
160    * @pre Pan detection should have been enabled via EnableGestureDetection().
161    * @see EnableGestureDetection
162    */
163   PanGestureDetector GetPanGestureDetector() const;
164
165   /**
166    * @brief If deriving classes wish to fine tune tap gesture
167    * detection, then they can access the gesture detector through this
168    * API and modify the detection.
169    *
170    * @SINCE_1_0.0
171    * @return The tap gesture detector
172    * @pre Tap detection should have been enabled via EnableGestureDetection().
173    * @see EnableGestureDetection
174    */
175   TapGestureDetector GetTapGestureDetector() const;
176
177   /**
178    * @brief If deriving classes wish to fine tune long press gesture
179    * detection, then they can access the gesture detector through this
180    * API and modify the detection.
181    *
182    * @SINCE_1_0.0
183    * @return The long press gesture detector
184    * @pre Long press detection should have been enabled via EnableGestureDetection().
185    * @see EnableGestureDetection
186    */
187   LongPressGestureDetector GetLongPressGestureDetector() const;
188
189   // Keyboard Navigation
190
191   /**
192    * @brief Sets whether this control supports two dimensional
193    * keyboard navigation (i.e. whether it knows how to handle the
194    * keyboard focus movement between its child actors).
195    *
196    * The control doesn't support it by default.
197    * @SINCE_1_0.0
198    * @param[in] isSupported Whether this control supports two dimensional keyboard navigation
199    */
200   void SetKeyboardNavigationSupport(bool isSupported);
201
202   /**
203    * @brief Gets whether this control supports two dimensional keyboard navigation.
204    *
205    * @SINCE_1_0.0
206    * @return true if this control supports two dimensional keyboard navigation
207    */
208   bool IsKeyboardNavigationSupported();
209
210   // Key Input
211
212   /**
213    * @copydoc Toolkit::Control::SetKeyInputFocus()
214    */
215   void SetKeyInputFocus();
216
217   /**
218    * @copydoc Toolkit::Control::HasKeyInputFocus()
219    */
220   bool HasKeyInputFocus();
221
222   /**
223    * @copydoc Toolkit::Control::ClearKeyInputFocus()
224    */
225   void ClearKeyInputFocus();
226
227   // Keyboard Focus
228
229   /**
230    * @brief Sets whether this control is a focus group for keyboard navigation.
231    *
232    * (i.e. the scope of keyboard focus movement
233    * can be limited to its child actors). The control is not a focus group by default.
234    * @SINCE_1_0.0
235    * @param[in] isFocusGroup Whether this control is set as a focus group for keyboard navigation
236    */
237   void SetAsKeyboardFocusGroup(bool isFocusGroup);
238
239   /**
240    * @brief Gets whether this control is a focus group for keyboard navigation.
241    *
242    * @SINCE_1_0.0
243    * @return true if this control is set as a focus group for keyboard navigation
244    */
245   bool IsKeyboardFocusGroup();
246
247   /// @cond internal
248   /**
249    * @brief Called by the AccessibilityManager to activate the Control.
250    * @SINCE_1_0.0
251    */
252   DALI_INTERNAL void AccessibilityActivate();
253
254   /**
255    * @brief Called by the KeyboardFocusManager.
256    * @SINCE_1_0.0
257    */
258   DALI_INTERNAL void KeyboardEnter();
259   /// @endcond
260
261
262   // Signals
263
264   /**
265    * @copydoc Dali::Toolkit::Control::KeyEventSignal()
266    */
267   Toolkit::Control::KeyEventSignalType& KeyEventSignal();
268
269   /**
270    * @copydoc Dali::Toolkit::Control::KeyInputFocusGainedSignal()
271    */
272   Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusGainedSignal();
273
274   /**
275    * @copydoc Dali::Toolkit::Control::KeyInputFocusLostSignal()
276    */
277   Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusLostSignal();
278
279   /// @cond internal
280   /**
281    * @brief Called by the KeyInputFocusManager to emit key event signals.
282    *
283    * @SINCE_1_0.0
284    * @param[in] event The key event
285    * @return True if the event was consumed
286    */
287   DALI_INTERNAL bool EmitKeyEventSignal(const KeyEvent& event);
288   /// @endcond
289
290 protected: // For derived classes to call
291   /**
292    * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal.
293    *
294    * Should be called last by the control after it acts on the Input Focus change.
295    *
296    * @SINCE_1_0.0
297    * @param[in] focusGained True if gained, False if lost
298    */
299   void EmitKeyInputFocusSignal(bool focusGained);
300
301 protected: // From CustomActorImpl
302   /**
303    * @copydoc CustomActorImpl::OnSceneConnection()
304    * @note If overridden, then an up-call to Control::OnSceneConnection MUST be made at the end.
305    */
306   void OnSceneConnection(int depth) override;
307
308   /**
309    * @copydoc CustomActorImpl::OnSceneDisconnection()
310    * @note If overridden, then an up-call to Control::OnSceneDisconnection MUST be made at the end.
311    */
312   void OnSceneDisconnection() override;
313
314   /**
315    * @copydoc CustomActorImpl::OnChildAdd()
316    * @note If overridden, then an up-call to Control::OnChildAdd MUST be made at the end.
317    */
318   void OnChildAdd(Actor& child) override;
319
320   /**
321    * @copydoc CustomActorImpl::OnChildRemove()
322    * @note If overridden, then an up-call to Control::OnChildRemove MUST be made at the end.
323    */
324   void OnChildRemove(Actor& child) override;
325
326   /**
327    * @copydoc CustomActorImpl::OnPropertySet()
328    * @note If overridden, then an up-call to Control::OnChildRemove MUST be made at the end.
329    */
330   void OnPropertySet(Property::Index index, const Property::Value& propertyValue) override;
331
332   /**
333    * @copydoc CustomActorImpl::OnSizeSet()
334    * @note If overridden, then an up-call to Control::OnSizeSet MUST be made at the end.
335    */
336   void OnSizeSet(const Vector3& targetSize) override;
337
338   /**
339    * @copydoc CustomActorImpl::OnSizeAnimation()
340    * @note If overridden, then an up-call to Control::OnSizeAnimation MUST be made at the end.
341    */
342   void OnSizeAnimation(Animation& animation, const Vector3& targetSize) override;
343
344   /**
345    * @copydoc CustomActorImpl::OnRelayout()
346    */
347   void OnRelayout(const Vector2& size, RelayoutContainer& container) override;
348
349   /**
350    * @copydoc CustomActorImpl::OnSetResizePolicy()
351    */
352   void OnSetResizePolicy(ResizePolicy::Type policy, Dimension::Type dimension) override;
353
354   /**
355    * @copydoc CustomActorImpl::GetNaturalSize()
356    */
357   Vector3 GetNaturalSize() override;
358
359   /**
360    * @copydoc CustomActorImpl::CalculateChildSize()
361    */
362   float CalculateChildSize(const Dali::Actor& child, Dimension::Type dimension) override;
363
364   /**
365    * @copydoc CustomActorImpl::GetHeightForWidth()
366    */
367   float GetHeightForWidth(float width) override;
368
369   /**
370    * @copydoc CustomActorImpl::GetWidthForHeight()
371    */
372   float GetWidthForHeight(float height) override;
373
374   /**
375    * @copydoc CustomActorImpl::RelayoutDependentOnChildren()
376    */
377   bool RelayoutDependentOnChildren(Dimension::Type dimension = Dimension::ALL_DIMENSIONS) override;
378
379   /**
380    * @copydoc CustomActorImpl::OnCalculateRelayoutSize()
381    */
382   void OnCalculateRelayoutSize(Dimension::Type dimension) override;
383
384   /**
385    * @copydoc CustomActorImpl::OnLayoutNegotiated()
386    */
387   void OnLayoutNegotiated(float size, Dimension::Type dimension) override;
388
389 protected: // Helpers for deriving classes
390   // Construction
391
392   /**
393    * @brief Flags for the constructor.
394    * @SINCE_1_0.0
395    */
396   enum ControlBehaviour
397   {
398     CONTROL_BEHAVIOUR_DEFAULT            = 0, ///< Default behaviour: Size negotiation is enabled & listens to Style Change signal, but doesn't receive event callbacks. @SINCE_1_2_10
399     NOT_IN_USE_1                         = 1 << (CustomActorImpl::ACTOR_FLAG_COUNT + 0),
400     REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << (CustomActorImpl::ACTOR_FLAG_COUNT + 1), ///< True if needs to support keyboard navigation @SINCE_1_0.0
401     DISABLE_STYLE_CHANGE_SIGNALS         = 1 << (CustomActorImpl::ACTOR_FLAG_COUNT + 2), ///< True if control should not monitor style change signals @SINCE_1_2_10
402
403     LAST_CONTROL_BEHAVIOUR_FLAG
404   };
405
406   static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log<LAST_CONTROL_BEHAVIOUR_FLAG - 1>::value + 1; ///< Total count of flags
407
408   /**
409    * @brief Control constructor.
410    *
411    * @SINCE_1_0.0
412    * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum
413    */
414   Control(ControlBehaviour behaviourFlags);
415
416   /**
417    * @brief Second phase initialization.
418    * @SINCE_1_0.0
419    */
420   void Initialize();
421
422 public: // API for derived classes to override
423   // Lifecycle
424
425   /**
426    * @brief This method is called after the Control has been initialized.
427    *
428    * Derived classes should do any second phase initialization by overriding this method.
429    * @SINCE_1_0.0
430    */
431   virtual void OnInitialize();
432
433   // Styling
434
435   /**
436    * @brief This method should be overridden by deriving classes requiring notifications when the style changes.
437    *
438    * @SINCE_1_0.0
439    * @param[in] styleManager The StyleManager object
440    * @param[in] change Information denoting what has changed
441    */
442   virtual void OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change);
443
444   // Accessibility
445
446   /**
447    * @brief This method is called when the control is accessibility activated.
448    *
449    * Derived classes should override this to perform custom accessibility activation.
450    * @SINCE_1_0.0
451    * @return true if this control can perform accessibility activation
452    */
453   virtual bool OnAccessibilityActivated();
454
455   /**
456    * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
457    * pan gesture.
458    *
459    * @SINCE_1_0.0
460    * @param[in] gesture The pan gesture
461    * @return true if the pan gesture has been consumed by this control
462    */
463   virtual bool OnAccessibilityPan(PanGesture gesture);
464
465   /**
466    * @brief This method should be overridden by deriving classes when they wish to respond
467    * the accessibility up and down action (i.e. value change of slider control).
468    *
469    * @SINCE_1_0.0
470    * @param[in] isIncrease Whether the value should be increased or decreased
471    * @return true if the value changed action has been consumed by this control
472    */
473   virtual bool OnAccessibilityValueChange(bool isIncrease);
474
475   /**
476    * @brief This method should be overridden by deriving classes when they wish to respond
477    * the accessibility zoom action.
478    *
479    * @SINCE_1_0.0
480    * @return true if the zoom action has been consumed by this control
481    */
482   virtual bool OnAccessibilityZoom();
483
484   // Keyboard focus
485
486   /**
487    * @brief Called when the control gains key input focus.
488    *
489    * Should be overridden by derived classes if they need to customize what happens when focus is gained.
490    * @SINCE_1_0.0
491    */
492   virtual void OnKeyInputFocusGained();
493
494   /**
495    * @brief Called when the control loses key input focus.
496    *
497    * Should be overridden by derived classes if they need to customize what happens when focus is lost.
498    * @SINCE_1_0.0
499    */
500   virtual void OnKeyInputFocusLost();
501
502   /**
503    * @brief Gets the next keyboard focusable actor in this control towards the given direction.
504    *
505    * A control needs to override this function in order to support two dimensional keyboard navigation.
506    * @SINCE_1_0.0
507    * @param[in] currentFocusedActor The current focused actor
508    * @param[in] direction The direction to move the focus towards
509    * @param[in] loopEnabled Whether the focus movement should be looped within the control
510    * @return The next keyboard focusable actor in this control or an empty handle if no actor can be focused
511    */
512   virtual Actor GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled);
513
514   /**
515    * @brief Informs this control that its chosen focusable actor will be focused.
516    *
517    * This allows the application to perform any actions if wishes
518    * before the focus is actually moved to the chosen actor.
519    *
520    * @SINCE_1_0.0
521    * @param[in] commitedFocusableActor The commited focusable actor
522    */
523   virtual void OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor);
524
525   /**
526    * @brief This method is called when the control has enter pressed on it.
527    *
528    * Derived classes should override this to perform custom actions.
529    * @SINCE_1_0.0
530    * @return true if this control supported this action
531    */
532   virtual bool OnKeyboardEnter();
533
534   /**
535    * @brief Called after a key-event is received by the actor that has had its focus set.
536    *
537    * @SINCE_1_0.0
538    * @param[in] event The Key Event
539    * @return True if the event should be consumed
540    */
541   virtual bool OnKeyEvent(const KeyEvent& event);
542
543   // Gestures
544
545   /**
546    * @brief Called whenever a pinch gesture is detected on this control.
547    *
548    * This can be overridden by deriving classes when pinch detection
549    * is enabled.  The default behaviour is to scale the control by the
550    * pinch scale.
551    *
552    * @SINCE_1_0.0
553    * @param[in] pinch The pinch gesture
554    * @note If overridden, then the default behavior will not occur.
555    * @note Pinch detection should be enabled via EnableGestureDetection().
556    * @see EnableGestureDetection
557    */
558   virtual void OnPinch(const PinchGesture& pinch);
559
560   /**
561    * @brief Called whenever a pan gesture is detected on this control.
562    *
563    * This should be overridden by deriving classes when pan detection
564    * is enabled.
565    *
566    * @SINCE_1_0.0
567    * @param[in] pan The pan gesture
568    * @note There is no default behavior with panning.
569    * @note Pan detection should be enabled via EnableGestureDetection().
570    * @see EnableGestureDetection
571    */
572   virtual void OnPan(const PanGesture& pan);
573
574   /**
575    * @brief Called whenever a tap gesture is detected on this control.
576    *
577    * This should be overridden by deriving classes when tap detection
578    * is enabled.
579    *
580    * @SINCE_1_0.0
581    * @param[in] tap The tap gesture
582    * @note There is no default behavior with a tap.
583    * @note Tap detection should be enabled via EnableGestureDetection().
584    * @see EnableGestureDetection
585    */
586   virtual void OnTap(const TapGesture& tap);
587
588   /**
589    * @brief Called whenever a long press gesture is detected on this control.
590    *
591    * This should be overridden by deriving classes when long press
592    * detection is enabled.
593    *
594    * @SINCE_1_0.0
595    * @param[in] longPress The long press gesture
596    * @note There is no default behaviour associated with a long press.
597    * @note Long press detection should be enabled via EnableGestureDetection().
598    * @see EnableGestureDetection
599    */
600   virtual void OnLongPress(const LongPressGesture& longPress);
601
602   // From ConnectionTrackerInterface
603
604   /**
605    * @copydoc ConnectionTrackerInterface::SignalConnected
606    */
607   void SignalConnected(SlotObserver* slotObserver, CallbackBase* callback) override;
608
609   /**
610    * @copydoc ConnectionTrackerInterface::SignalDisconnected
611    */
612   void SignalDisconnected(SlotObserver* slotObserver, CallbackBase* callback) override;
613
614   /**
615    * @brief Retrieves the extension for this control.
616    *
617    * @SINCE_1_0.0
618    * @return The extension if available, NULL otherwise
619    */
620   virtual Extension* GetControlExtension()
621   {
622     return NULL;
623   }
624
625   // Transition
626
627   /**
628    * @brief Retrieve visual property animations.
629    * This Control is a destination.
630    *
631    * @param[in] animation generated animation
632    * @param[in] source source control of the animation.
633    * @param[in] alphaFunction AlphaFunction of the animation
634    * @param[in] timePeriod TimePeriod of the animation
635    */
636   virtual void OnCreateTransitions(Dali::Animation& animation, Dali::Toolkit::Control source, AlphaFunction alphaFunction, TimePeriod timePeriod)
637   {
638   }
639
640 private:
641   /// @cond internal
642
643   // Not copyable or movable
644   DALI_INTERNAL Control(const Control&) = delete;            ///< Deleted copy constructor.
645   DALI_INTERNAL Control(Control&&)      = delete;            ///< Deleted move constructor.
646   DALI_INTERNAL Control& operator=(const Control&) = delete; ///< Deleted copy assignment operator.
647   DALI_INTERNAL Control& operator=(Control&&) = delete;      ///< Deleted move assignment operator.
648
649 public:
650   class DALI_INTERNAL Impl; // Class declaration is public so we can internally add devel API's to the Controls Impl
651
652 private:
653   Impl* mImpl;
654   /// @endcond
655 };
656
657 /**
658  * @brief Gets implementation from the handle.
659  *
660  * @SINCE_1_0.0
661  * @param handle
662  * @return Implementation
663  * @pre handle is initialized and points to a control
664  */
665 DALI_TOOLKIT_API Internal::Control& GetImplementation(Dali::Toolkit::Control& handle);
666
667 /**
668  * @brief Gets implementation from the handle.
669  *
670  * @SINCE_1_0.0
671  * @param handle
672  * @return Implementation
673  * @pre Handle is initialized and points to a control.
674  */
675 DALI_TOOLKIT_API const Internal::Control& GetImplementation(const Dali::Toolkit::Control& handle);
676
677 } // namespace Internal
678
679 /**
680  * @}
681  */
682 } // namespace Toolkit
683
684 } // namespace Dali
685
686 #endif // DALI_TOOLKIT_CONTROL_IMPL_H