Revert "[3.0] Version downgrade (1.2.0 to 1.1.45)"
[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   /**
255    * @internal
256    * @brief Called by the AccessibilityManager to activate the Control.
257    * @SINCE_1_0.0
258    */
259   DALI_INTERNAL void AccessibilityActivate();
260
261   /**
262    * @internal
263    * @brief Called by the KeyboardFocusManager.
264    * @SINCE_1_0.0
265    */
266   DALI_INTERNAL void KeyboardEnter();
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   /**
286    * @internal
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
295 protected: // For derived classes to call
296
297   /**
298    * @brief Register a visual by Property Index, linking an Actor to controlRenderer when required.
299    * In the case of the visual being an actor or control deeming controlRenderer not required then controlRenderer should be an empty handle.
300    * No parenting is done during registration, this should be done by derived class.
301    *
302    * @SINCE_1_2.0
303    *
304    * @param[in] index The Property index of the visual, used to reference visual
305    * @param[in] placementActor The actor used to by the visual.
306    * @param[in] visual The visual to register
307    */
308    void RegisterVisual( Property::Index index, Actor placementActor, Toolkit::Visual::Base visual );
309
310    /**
311     * @brief Erase the entry matching the given index from the list of registered visuals
312     * @param[in] index The Property index of the visual, used to reference visual
313     *
314     * @SINCE_1_2.0
315     */
316    void UnregisterVisual( Property::Index index );
317
318   /**
319    * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal
320    *
321    * Should be called last by the control after it acts on the Input Focus change.
322    *
323    * @SINCE_1_0.0
324    * @param[in] focusGained True if gained, False if lost
325    */
326   void EmitKeyInputFocusSignal( bool focusGained );
327
328 protected: // From CustomActorImpl, not to be used by application developers
329
330   /**
331    * @copydoc CustomActorImpl::OnStageConnection()
332    * @note If overridden, then an up-call to Control::OnStageConnection MUST be made at the start.
333    */
334   virtual void OnStageConnection( int depth );
335
336   /**
337    * @copydoc CustomActorImpl::OnStageDisconnection()
338    * @note If overridden, then an up-call to Control::OnStageDisconnection MUST be made at the end.
339    */
340   virtual void OnStageDisconnection();
341
342   /**
343    * @copydoc CustomActorImpl::OnChildAdd()
344    * @note If overridden, then an up-call to Control::OnChildAdd MUST be made at the start.
345    */
346   virtual void OnChildAdd( Actor& child );
347
348   /**
349    * @copydoc CustomActorImpl::OnChildRemove()
350    * @note If overridden, then an up-call to Control::OnChildRemove MUST be made at the end.
351    */
352   virtual void OnChildRemove( Actor& child );
353
354   /**
355    * @copydoc CustomActorImpl::OnSizeSet()
356    * @note If overridden, then an up-call to Control::OnSizeSet MUST be made at the start.
357    */
358   virtual void OnSizeSet( const Vector3& targetSize );
359
360   /**
361    * @copydoc CustomActorImpl::OnSizeAnimation()
362    * @note If overridden, then an up-call to Control::OnSizeAnimation MUST be made at the start.
363    */
364   virtual void OnSizeAnimation( Animation& animation, const Vector3& targetSize );
365
366   /**
367    * @copydoc CustomActorImpl::OnTouchEvent()
368    */
369   virtual bool OnTouchEvent( const TouchEvent& event );
370
371   /**
372    * @copydoc CustomActorImpl::OnHoverEvent()
373    */
374   virtual bool OnHoverEvent( const HoverEvent& event );
375
376   /**
377    * @copydoc CustomActorImpl::OnKeyEvent()
378    */
379   virtual bool OnKeyEvent( const KeyEvent& event );
380
381   /**
382    * @copydoc CustomActorImpl::OnWheelEvent()
383    */
384   virtual bool OnWheelEvent( const WheelEvent& event );
385
386   /**
387    * @copydoc CustomActorImpl::OnRelayout()
388    */
389   virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
390
391   /**
392    * @copydoc CustomActorImpl::OnSetResizePolicy()
393    */
394   virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
395
396   /**
397    * @copydoc CustomActorImpl::GetNaturalSize()
398    */
399   virtual Vector3 GetNaturalSize();
400
401   /**
402    * @copydoc CustomActorImpl::CalculateChildSize()
403    */
404   virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension );
405
406   /**
407    * @copydoc CustomActorImpl::GetHeightForWidth()
408    */
409   virtual float GetHeightForWidth( float width );
410
411   /**
412    * @copydoc CustomActorImpl::GetWidthForHeight()
413    */
414   virtual float GetWidthForHeight( float height );
415
416   /**
417    * @copydoc CustomActorImpl::RelayoutDependentOnChildren()
418    */
419   virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
420
421   /**
422    * @copydoc CustomActorImpl::OnCalculateRelayoutSize()
423    */
424   virtual void OnCalculateRelayoutSize( Dimension::Type dimension );
425
426   /**
427    * @copydoc CustomActorImpl::OnLayoutNegotiated()
428    */
429   virtual void OnLayoutNegotiated( float size, Dimension::Type dimension );
430
431 protected: // Helpers for deriving classes
432
433   // Construction
434
435   // Flags for the constructor
436   enum ControlBehaviour
437   {
438     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
439     REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 1 ),     ///< True if needs to support keyboard navigation @SINCE_1_0.0
440
441     LAST_CONTROL_BEHAVIOUR_FLAG
442   };
443
444   static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log< LAST_CONTROL_BEHAVIOUR_FLAG - 1 >::value + 1;      ///< Total count of flags
445
446   /**
447    * @brief Control constructor
448    *
449    * @SINCE_1_0.0
450    * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum
451    */
452   Control( ControlBehaviour behaviourFlags );
453
454   /**
455    * @brief Second phase initialization.
456    * @SINCE_1_0.0
457    */
458   void Initialize();
459
460 public: // API for derived classes to override
461
462   // Lifecycle
463
464   /**
465    * @brief This method is called after the Control has been initialized.
466    *
467    * Derived classes should do any second phase initialization by overriding this method.
468    * @SINCE_1_0.0
469    */
470   virtual void OnInitialize();
471
472   /**
473    * @DEPRECATED_1_1.30. Override OnChildAdd instead.
474    *
475    * @brief Called whenever an Actor is added to the control.
476    *
477    * Could be overridden by derived classes.
478    *
479    * @SINCE_1_0.0
480    * @param[in] child The added actor.
481    */
482   virtual void OnControlChildAdd( Actor& child );
483
484   /**
485    * @DEPRECATED_1_1.30. Override OnChildRemove instead.
486    *
487    * @brief Called whenever an Actor is removed from the control.
488    *
489    * Could be overridden by derived classes.
490    *
491    * @SINCE_1_0.0
492    * @param[in] child The removed actor.
493    */
494   virtual void OnControlChildRemove( Actor& child );
495
496   // Styling
497
498   /**
499    * @brief This method should be overridden by deriving classes requiring notifications when the style changes.
500    *
501    * @SINCE_1_0.0
502    * @param[in] styleManager  The StyleManager object.
503    * @param[in] change  Information denoting what has changed.
504    */
505   virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change );
506
507   // Accessibility
508
509   /**
510    * @brief This method is called when the control is accessibility activated.
511    *
512    * Derived classes should override this to perform custom accessibility activation.
513    * @SINCE_1_0.0
514    * @return true if this control can perform accessibility activation.
515    */
516   virtual bool OnAccessibilityActivated();
517
518   /**
519    * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
520    * pan gesture.
521    *
522    * @SINCE_1_0.0
523    * @param[in] gesture The pan gesture.
524    * @return true if the pan gesture has been consumed by this control
525    */
526   virtual bool OnAccessibilityPan( PanGesture gesture );
527
528   /**
529    * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
530    * touch event.
531    *
532    * @SINCE_1_0.0
533    * @param[in] touchEvent The touch event.
534    * @return true if the touch event has been consumed by this control
535    */
536   virtual bool OnAccessibilityTouch( const TouchEvent& touchEvent );
537
538   /**
539    * @brief This method should be overridden by deriving classes when they wish to respond
540    * the accessibility up and down action (i.e. value change of slider control).
541    *
542    * @SINCE_1_0.0
543    * @param[in] isIncrease Whether the value should be increased or decreased
544    * @return true if the value changed action has been consumed by this control
545    */
546   virtual bool OnAccessibilityValueChange( bool isIncrease );
547
548   /**
549    * @brief This method should be overridden by deriving classes when they wish to respond
550    * the accessibility zoom action.
551    *
552    * @SINCE_1_0.0
553    * @return true if the zoom action has been consumed by this control
554    */
555   virtual bool OnAccessibilityZoom();
556
557   // Keyboard focus
558
559   /**
560    * @brief Called when the control gains key input focus.
561    *
562    * Should be overridden by derived classes if they need to customize what happens when focus is gained.
563    * @SINCE_1_0.0
564    */
565   virtual void OnKeyInputFocusGained();
566
567   /**
568    * @brief Called when the control loses key input focus.
569    *
570    * Should be overridden by derived classes if they need to customize what happens when focus is lost.
571    * @SINCE_1_0.0
572    */
573   virtual void OnKeyInputFocusLost();
574
575   /**
576    * @brief Gets the next keyboard focusable actor in this control towards the given direction.
577    *
578    * A control needs to override this function in order to support two dimensional keyboard navigation.
579    * @SINCE_1_0.0
580    * @param[in] currentFocusedActor The current focused actor.
581    * @param[in] direction The direction to move the focus towards.
582    * @param[in] loopEnabled Whether the focus movement should be looped within the control.
583    * @return the next keyboard focusable actor in this control or an empty handle if no actor can be focused.
584    */
585   virtual Actor GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled );
586
587   /**
588    * @brief Informs this control that its chosen focusable actor will be focused.
589    *
590    * This allows the application to preform any actions if wishes
591    * before the focus is actually moved to the chosen actor.
592    *
593    * @SINCE_1_0.0
594    * @param[in] commitedFocusableActor The commited focusable actor.
595    */
596   virtual void OnKeyboardFocusChangeCommitted( Actor commitedFocusableActor );
597
598   /**
599    * @brief This method is called when the control has enter pressed on it.
600    *
601    * Derived classes should override this to perform custom actions.
602    * @SINCE_1_0.0
603    * @return true if this control supported this action.
604    */
605   virtual bool OnKeyboardEnter();
606
607   // Gestures
608
609   /**
610    * @brief Called whenever a pinch gesture is detected on this control.
611    *
612    * This can be overridden by deriving classes when pinch detection
613    * is enabled.  The default behaviour is to scale the control by the
614    * pinch scale.
615    *
616    * @SINCE_1_0.0
617    * @param[in]  pinch  The pinch gesture.
618    * @note If overridden, then the default behaviour will not occur.
619    * @note Pinch detection should be enabled via EnableGestureDetection().
620    * @see EnableGestureDetection
621    */
622   virtual void OnPinch( const PinchGesture& pinch );
623
624   /**
625    * @brief Called whenever a pan gesture is detected on this control.
626    *
627    * This should be overridden by deriving classes when pan detection
628    * is enabled.
629    *
630    * @SINCE_1_0.0
631    * @param[in]  pan  The pan gesture.
632    * @note There is no default behaviour with panning.
633    * @note Pan detection should be enabled via EnableGestureDetection().
634    * @see EnableGestureDetection
635    */
636   virtual void OnPan( const PanGesture& pan );
637
638   /**
639    * @brief Called whenever a tap gesture is detected on this control.
640    *
641    * This should be overridden by deriving classes when tap detection
642    * is enabled.
643    *
644    * @SINCE_1_0.0
645    * @param[in]  tap  The tap gesture.
646    * @note There is no default behaviour with a tap.
647    * @note Tap detection should be enabled via EnableGestureDetection().
648    * @see EnableGestureDetection
649    */
650   virtual void OnTap( const TapGesture& tap );
651
652   /**
653    * @brief Called whenever a long press gesture is detected on this control.
654    *
655    * This should be overridden by deriving classes when long press
656    * detection is enabled.
657    *
658    * @SINCE_1_0.0
659    * @param[in]  longPress  The long press gesture.
660    * @note There is no default behaviour associated with a long press.
661    * @note Long press detection should be enabled via EnableGestureDetection().
662    * @see EnableGestureDetection
663    */
664   virtual void OnLongPress( const LongPressGesture& longPress );
665
666   // From ConnectionTrackerInterface
667
668   /**
669    * @copydoc ConnectionTrackerInterface::SignalConnected
670    */
671   virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback );
672
673   /**
674    * @copydoc ConnectionTrackerInterface::SignalDisconnected
675    */
676   virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback );
677
678   /**
679    * @brief Retrieve the extension for this control
680    *
681    * @SINCE_1_0.0
682    * @return The extension if available, NULL otherwise
683    */
684   virtual Extension* GetControlExtension()
685   {
686     return NULL;
687   }
688
689 private:
690
691   // Undefined
692   DALI_INTERNAL Control( const Control& );
693   DALI_INTERNAL Control& operator=( const Control& );
694
695   class Impl;
696   Impl* mImpl;
697
698 };
699
700 /**
701  * @brief Get implementation from the handle.
702  *
703  * @SINCE_1_0.0
704  * @param handle
705  * @return implementation
706  * @pre handle is initialized and points to a control
707  */
708 DALI_IMPORT_API Internal::Control& GetImplementation( Dali::Toolkit::Control& handle );
709
710 /**
711  * @brief Get implementation from the handle.
712  *
713  * @SINCE_1_0.0
714  * @param handle
715  * @return implementation
716  * @pre handle is initialized and points to a control
717  */
718 DALI_IMPORT_API const Internal::Control& GetImplementation( const Dali::Toolkit::Control& handle );
719
720 } // namespace Internal
721
722 /**
723  * @}
724  */
725 } // namespace Toolkit
726
727 } // namespace Dali
728
729 #endif // DALI_TOOLKIT_CONTROL_IMPL_H