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