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