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