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