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