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