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