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