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