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