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   /**
 226    * @brief Called by the AccessibilityManager to activate the Control.
 227    */
 228   DALI_INTERNAL void AccessibilityActivate();
 229
 230   /**
 231    * @brief Called by the KeyboardFocusManager.
 232    */
 233   DALI_INTERNAL void KeyboardEnter();
 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( int depth );
 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   /**
 472    * @brief This method should be overridden by deriving classes when they wish to respond
 473    * the accessibility zoom action
 474    *
 475    * @return true if the zoom action has been consumed by this control
 476    */
 477   virtual bool OnAccessibilityZoom();
 478
 479   // Keyboard focus
 480
 481   /**
 482    * @brief Called when the control gains key input focus.
 483    *
 484    * Should be overridden by derived classes if they need to customize what happens when focus is gained.
 485    */
 486   virtual void OnKeyInputFocusGained();
 487
 488   /**
 489    * @brief Called when the control loses key input focus.
 490    *
 491    * Should be overridden by derived classes if they need to customize what happens when focus is lost.
 492    */
 493   virtual void OnKeyInputFocusLost();
 494
 495   /**
 496    * @brief Gets the next keyboard focusable actor in this control towards the given direction.
 497    *
 498    * A control needs to override this function in order to support two dimensional keyboard navigation.
 499    * @param[in] currentFocusedActor The current focused actor.
 500    * @param[in] direction The direction to move the focus towards.
 501    * @param[in] loopEnabled Whether the focus movement should be looped within the control.
 502    * @return the next keyboard focusable actor in this control or an empty handle if no actor can be focused.
 503    */
 504   virtual Actor GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled );
 505
 506   /**
 507    * @brief Informs this control that its chosen focusable actor will be focused.
 508    *
 509    * This allows the application to preform any actions if wishes
 510    * before the focus is actually moved to the chosen actor.
 511    *
 512    * @param[in] commitedFocusableActor The commited focusable actor.
 513    */
 514   virtual void OnKeyboardFocusChangeCommitted( Actor commitedFocusableActor );
 515
 516   /**
 517    * @brief This method is called when the control has enter pressed on it.
 518    *
 519    * Derived classes should override this to perform custom actions.
 520    * @return true if this control supported this action.
 521    */
 522   virtual bool OnKeyboardEnter();
 523
 524   // Gestures
 525
 526   /**
 527    * @brief Called whenever a pinch gesture is detected on this control.
 528    *
 529    * This can be overridden by deriving classes when pinch detection
 530    * is enabled.  The default behaviour is to scale the control by the
 531    * pinch scale.
 532    *
 533    * @note If overridden, then the default behaviour will not occur.
 534    * @note Pinch detection should be enabled via EnableGestureDetection().
 535    * @param[in]  pinch  The pinch gesture.
 536    * @see EnableGestureDetection
 537    */
 538   virtual void OnPinch( const PinchGesture& pinch );
 539
 540   /**
 541    * @brief Called whenever a pan gesture is detected on this control.
 542    *
 543    * This should be overridden by deriving classes when pan detection
 544    * is enabled.
 545    *
 546    * @note There is no default behaviour with panning.
 547    * @note Pan detection should be enabled via EnableGestureDetection().
 548    * @param[in]  pan  The pan gesture.
 549    * @see EnableGestureDetection
 550    */
 551   virtual void OnPan( const PanGesture& pan );
 552
 553   /**
 554    * @brief Called whenever a tap gesture is detected on this control.
 555    *
 556    * This should be overridden by deriving classes when tap detection
 557    * is enabled.
 558    *
 559    * @note There is no default behaviour with a tap.
 560    * @note Tap detection should be enabled via EnableGestureDetection().
 561    * @param[in]  tap  The tap gesture.
 562    * @see EnableGestureDetection
 563    */
 564   virtual void OnTap( const TapGesture& tap );
 565
 566   /**
 567    * @brief Called whenever a long press gesture is detected on this control.
 568    *
 569    * This should be overridden by deriving classes when long press
 570    * detection is enabled.
 571    *
 572    * @note There is no default behaviour associated with a long press.
 573    * @note Long press detection should be enabled via EnableGestureDetection().
 574    * @param[in]  longPress  The long press gesture.
 575    * @see EnableGestureDetection
 576    */
 577   virtual void OnLongPress( const LongPressGesture& longPress );
 578
 579   // From ConnectionTrackerInterface
 580
 581   /**
 582    * @copydoc ConnectionTrackerInterface::SignalConnected
 583    */
 584   virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback );
 585
 586   /**
 587    * @copydoc ConnectionTrackerInterface::SignalDisconnected
 588    */
 589   virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback );
 590
 591   /**
 592    * Retrieve the extension for this control
 593    *
 594    * @return The extension if available, NULL otherwise
 595    */
 596   virtual Extension* GetControlExtension()
 597   {
 598     return NULL;
 599   }
 600
 601 private:
 602
 603   // Undefined
 604   DALI_INTERNAL Control( const Control& );
 605   DALI_INTERNAL Control& operator=( const Control& );
 606
 607   class Impl;
 608   Impl* mImpl;
 609
 610 };
 611
 612 /**
 613  * @brief Get implementation from the handle
 614  *
 615  * @pre handle is initialized and points to a control
 616  * @param handle
 617  * @return implementation
 618  */
 619 DALI_IMPORT_API Internal::Control& GetImplementation( Dali::Toolkit::Control& handle );
 620
 621 /**
 622  * @brief Get implementation from the handle
 623  *
 624  * @pre handle is initialized and points to a control
 625  * @param handle
 626  * @return implementation
 627  */
 628 DALI_IMPORT_API const Internal::Control& GetImplementation( const Dali::Toolkit::Control& handle );
 629
 630 } // namespace Internal
 631
 632 } // namespace Toolkit
 633
 634 } // namespace Dali
 635
 636 #endif // __DALI_TOOLKIT_CONTROL_IMPL_H__