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