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 visual when required.
 300    * In the case of the visual being an actor or control deeming visual not required then visual 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 should not call visual.SetOnStage(placementActor). It is the responsibility of the base class to connect/disconnect registered visual to stage.
 309    *       Use below API with enabled set to false if derived class wishes to control when visual is staged.
 310    */
 311    void RegisterVisual( Property::Index index, Actor& placementActor, Toolkit::Visual::Base& visual );
 312
 313    /**
 314     * @brief Register a visual by Property Index, linking an Actor to visual when required.
 315     * In the case of the visual being an actor or control deeming visual not required then visual should be an empty handle.
 316     * If enabled is false then the visual is not set on stage until enabled by the derived class.
 317     * @see EnableVisual
 318     *
 319     * @SINCE_1_2.11
 320     *
 321     * @param[in] index The Property index of the visual, used to reference visual
 322     * @param[in] placementActor The actor used to by the visual.
 323     * @param[in] visual The visual to register
 324     * @param[in] enabled false if derived class wants to control when visual is set on stage.
 325     *
 326     */
 327    void RegisterVisual( Property::Index index, Actor& placementActor, Toolkit::Visual::Base& visual, bool enabled );
 328
 329    /**
 330     * @brief Erase the entry matching the given index from the list of registered visuals
 331     * @param[in] index The Property index of the visual, used to reference visual
 332     *
 333     * @SINCE_1_2.0
 334     */
 335    void UnregisterVisual( Property::Index index );
 336
 337    /**
 338     * @brief Retrieve the visual associated with the given property index.
 339     *
 340     * @SINCE_1_2.2
 341     *
 342     * @param[in] index The Property index of the visual.
 343     * @return The registered visual if exist, otherwise empty handle.
 344     * @note For managing object life-cycle, do not store the returned visual as a member which increments its reference count.
 345     */
 346    Toolkit::Visual::Base GetVisual( Property::Index index ) const;
 347
 348    /**
 349     * @brief Sets the given visual to be displayed or not when parent staged.
 350     *
 351     * @SINCE_1_2.11
 352     *
 353     * @param[in] index The Property index of the visual
 354     * @param[in] enable flag to set enabled or disabled.
 355     */
 356    void EnableVisual( Property::Index index, bool enable );
 357
 358    /**
 359     * @brief Queries if the given visual is to be displayed when parent staged.
 360     *
 361     * @SINCE_1_2.11
 362     *
 363     * @param[in] index The Property index of the visual
 364     * @return bool whether visual is enabled or not
 365     */
 366    bool IsVisualEnabled( Property::Index index ) const;
 367
 368    /**
 369     * @brief Retrieve the placement actor associated with the given index.
 370     *
 371     * @SINCE_1_2.2
 372     *
 373     * @@param[in] index The Property index of the visual.
 374     * @return Then placement actor if exist, otherwise empty handle.
 375     * @note For managing object life-cycle, do not store the returned placement actor as a member which increments its reference count.
 376     */
 377    Actor GetPlacementActor( Property::Index index ) const;
 378
 379   /**
 380    * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal
 381    *
 382    * Should be called last by the control after it acts on the Input Focus change.
 383    *
 384    * @SINCE_1_0.0
 385    * @param[in] focusGained True if gained, False if lost
 386    */
 387   void EmitKeyInputFocusSignal( bool focusGained );
 388
 389 protected: // From CustomActorImpl, not to be used by application developers
 390
 391   /**
 392    * @copydoc CustomActorImpl::OnStageConnection()
 393    * @note If overridden, then an up-call to Control::OnStageConnection MUST be made at the start.
 394    */
 395   virtual void OnStageConnection( int depth );
 396
 397   /**
 398    * @copydoc CustomActorImpl::OnStageDisconnection()
 399    * @note If overridden, then an up-call to Control::OnStageDisconnection MUST be made at the end.
 400    */
 401   virtual void OnStageDisconnection();
 402
 403   /**
 404    * @copydoc CustomActorImpl::OnChildAdd()
 405    * @note If overridden, then an up-call to Control::OnChildAdd MUST be made at the start.
 406    */
 407   virtual void OnChildAdd( Actor& child );
 408
 409   /**
 410    * @copydoc CustomActorImpl::OnChildRemove()
 411    * @note If overridden, then an up-call to Control::OnChildRemove MUST be made at the end.
 412    */
 413   virtual void OnChildRemove( Actor& child );
 414
 415   /**
 416    * @copydoc CustomActorImpl::OnSizeSet()
 417    * @note If overridden, then an up-call to Control::OnSizeSet MUST be made at the start.
 418    */
 419   virtual void OnSizeSet( const Vector3& targetSize );
 420
 421   /**
 422    * @copydoc CustomActorImpl::OnSizeAnimation()
 423    * @note If overridden, then an up-call to Control::OnSizeAnimation MUST be made at the start.
 424    */
 425   virtual void OnSizeAnimation( Animation& animation, const Vector3& targetSize );
 426
 427   /**
 428    * @copydoc CustomActorImpl::OnTouchEvent()
 429    */
 430   virtual bool OnTouchEvent( const TouchEvent& event );
 431
 432   /**
 433    * @copydoc CustomActorImpl::OnHoverEvent()
 434    */
 435   virtual bool OnHoverEvent( const HoverEvent& event );
 436
 437   /**
 438    * @copydoc CustomActorImpl::OnKeyEvent()
 439    */
 440   virtual bool OnKeyEvent( const KeyEvent& event );
 441
 442   /**
 443    * @copydoc CustomActorImpl::OnWheelEvent()
 444    */
 445   virtual bool OnWheelEvent( const WheelEvent& event );
 446
 447   /**
 448    * @copydoc CustomActorImpl::OnRelayout()
 449    */
 450   virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
 451
 452   /**
 453    * @copydoc CustomActorImpl::OnSetResizePolicy()
 454    */
 455   virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
 456
 457   /**
 458    * @copydoc CustomActorImpl::GetNaturalSize()
 459    */
 460   virtual Vector3 GetNaturalSize();
 461
 462   /**
 463    * @copydoc CustomActorImpl::CalculateChildSize()
 464    */
 465   virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension );
 466
 467   /**
 468    * @copydoc CustomActorImpl::GetHeightForWidth()
 469    */
 470   virtual float GetHeightForWidth( float width );
 471
 472   /**
 473    * @copydoc CustomActorImpl::GetWidthForHeight()
 474    */
 475   virtual float GetWidthForHeight( float height );
 476
 477   /**
 478    * @copydoc CustomActorImpl::RelayoutDependentOnChildren()
 479    */
 480   virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
 481
 482   /**
 483    * @copydoc CustomActorImpl::OnCalculateRelayoutSize()
 484    */
 485   virtual void OnCalculateRelayoutSize( Dimension::Type dimension );
 486
 487   /**
 488    * @copydoc CustomActorImpl::OnLayoutNegotiated()
 489    */
 490   virtual void OnLayoutNegotiated( float size, Dimension::Type dimension );
 491
 492 protected: // Helpers for deriving classes
 493
 494   // Construction
 495
 496   /**
 497    * @brief Flags for the constructor
 498    * @SINCE_1_0.0
 499    */
 500   enum ControlBehaviour
 501   {
 502     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
 503     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
 504     REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 1 ),     ///< True if needs to support keyboard navigation @SINCE_1_0.0
 505
 506     DISABLE_STYLE_CHANGE_SIGNALS         = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 2 ),     ///< True if control should not monitor style change signals @SINCE_1_2_10
 507
 508     LAST_CONTROL_BEHAVIOUR_FLAG
 509   };
 510
 511   static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log< LAST_CONTROL_BEHAVIOUR_FLAG - 1 >::value + 1;      ///< Total count of flags
 512
 513   /**
 514    * @brief Control constructor
 515    *
 516    * @SINCE_1_0.0
 517    * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum
 518    */
 519   Control( ControlBehaviour behaviourFlags );
 520
 521   /**
 522    * @brief Second phase initialization.
 523    * @SINCE_1_0.0
 524    */
 525   void Initialize();
 526
 527 public: // API for derived classes to override
 528
 529   // Lifecycle
 530
 531   /**
 532    * @brief This method is called after the Control has been initialized.
 533    *
 534    * Derived classes should do any second phase initialization by overriding this method.
 535    * @SINCE_1_0.0
 536    */
 537   virtual void OnInitialize();
 538
 539   /**
 540    * @DEPRECATED_1_1.30. Override OnChildAdd instead.
 541    *
 542    * @brief Called whenever an Actor is added to the control.
 543    *
 544    * Could be overridden by derived classes.
 545    *
 546    * @SINCE_1_0.0
 547    * @param[in] child The added actor.
 548    */
 549   virtual void OnControlChildAdd( Actor& child );
 550
 551   /**
 552    * @DEPRECATED_1_1.30. Override OnChildRemove instead.
 553    *
 554    * @brief Called whenever an Actor is removed from the control.
 555    *
 556    * Could be overridden by derived classes.
 557    *
 558    * @SINCE_1_0.0
 559    * @param[in] child The removed actor.
 560    */
 561   virtual void OnControlChildRemove( Actor& child );
 562
 563   // Styling
 564
 565   /**
 566    * @brief This method should be overridden by deriving classes requiring notifications when the style changes.
 567    *
 568    * @SINCE_1_0.0
 569    * @param[in] styleManager  The StyleManager object.
 570    * @param[in] change  Information denoting what has changed.
 571    */
 572   virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change );
 573
 574   // Accessibility
 575
 576   /**
 577    * @brief This method is called when the control is accessibility activated.
 578    *
 579    * Derived classes should override this to perform custom accessibility activation.
 580    * @SINCE_1_0.0
 581    * @return true if this control can perform accessibility activation.
 582    */
 583   virtual bool OnAccessibilityActivated();
 584
 585   /**
 586    * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
 587    * pan gesture.
 588    *
 589    * @SINCE_1_0.0
 590    * @param[in] gesture The pan gesture.
 591    * @return true if the pan gesture has been consumed by this control
 592    */
 593   virtual bool OnAccessibilityPan( PanGesture gesture );
 594
 595   /**
 596    * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
 597    * touch event.
 598    *
 599    * @SINCE_1_0.0
 600    * @param[in] touchEvent The touch event.
 601    * @return true if the touch event has been consumed by this control
 602    */
 603   virtual bool OnAccessibilityTouch( const TouchEvent& touchEvent );
 604
 605   /**
 606    * @brief This method should be overridden by deriving classes when they wish to respond
 607    * the accessibility up and down action (i.e. value change of slider control).
 608    *
 609    * @SINCE_1_0.0
 610    * @param[in] isIncrease Whether the value should be increased or decreased
 611    * @return true if the value changed action has been consumed by this control
 612    */
 613   virtual bool OnAccessibilityValueChange( bool isIncrease );
 614
 615   /**
 616    * @brief This method should be overridden by deriving classes when they wish to respond
 617    * the accessibility zoom action.
 618    *
 619    * @SINCE_1_0.0
 620    * @return true if the zoom action has been consumed by this control
 621    */
 622   virtual bool OnAccessibilityZoom();
 623
 624   // Keyboard focus
 625
 626   /**
 627    * @brief Called when the control gains key input focus.
 628    *
 629    * Should be overridden by derived classes if they need to customize what happens when focus is gained.
 630    * @SINCE_1_0.0
 631    */
 632   virtual void OnKeyInputFocusGained();
 633
 634   /**
 635    * @brief Called when the control loses key input focus.
 636    *
 637    * Should be overridden by derived classes if they need to customize what happens when focus is lost.
 638    * @SINCE_1_0.0
 639    */
 640   virtual void OnKeyInputFocusLost();
 641
 642   /**
 643    * @brief Gets the next keyboard focusable actor in this control towards the given direction.
 644    *
 645    * A control needs to override this function in order to support two dimensional keyboard navigation.
 646    * @SINCE_1_0.0
 647    * @param[in] currentFocusedActor The current focused actor.
 648    * @param[in] direction The direction to move the focus towards.
 649    * @param[in] loopEnabled Whether the focus movement should be looped within the control.
 650    * @return the next keyboard focusable actor in this control or an empty handle if no actor can be focused.
 651    */
 652   virtual Actor GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled );
 653
 654   /**
 655    * @brief Informs this control that its chosen focusable actor will be focused.
 656    *
 657    * This allows the application to preform any actions if wishes
 658    * before the focus is actually moved to the chosen actor.
 659    *
 660    * @SINCE_1_0.0
 661    * @param[in] commitedFocusableActor The commited focusable actor.
 662    */
 663   virtual void OnKeyboardFocusChangeCommitted( Actor commitedFocusableActor );
 664
 665   /**
 666    * @brief This method is called when the control has enter pressed on it.
 667    *
 668    * Derived classes should override this to perform custom actions.
 669    * @SINCE_1_0.0
 670    * @return true if this control supported this action.
 671    */
 672   virtual bool OnKeyboardEnter();
 673
 674   // Gestures
 675
 676   /**
 677    * @brief Called whenever a pinch gesture is detected on this control.
 678    *
 679    * This can be overridden by deriving classes when pinch detection
 680    * is enabled.  The default behaviour is to scale the control by the
 681    * pinch scale.
 682    *
 683    * @SINCE_1_0.0
 684    * @param[in]  pinch  The pinch gesture.
 685    * @note If overridden, then the default behaviour will not occur.
 686    * @note Pinch detection should be enabled via EnableGestureDetection().
 687    * @see EnableGestureDetection
 688    */
 689   virtual void OnPinch( const PinchGesture& pinch );
 690
 691   /**
 692    * @brief Called whenever a pan gesture is detected on this control.
 693    *
 694    * This should be overridden by deriving classes when pan detection
 695    * is enabled.
 696    *
 697    * @SINCE_1_0.0
 698    * @param[in]  pan  The pan gesture.
 699    * @note There is no default behaviour with panning.
 700    * @note Pan detection should be enabled via EnableGestureDetection().
 701    * @see EnableGestureDetection
 702    */
 703   virtual void OnPan( const PanGesture& pan );
 704
 705   /**
 706    * @brief Called whenever a tap gesture is detected on this control.
 707    *
 708    * This should be overridden by deriving classes when tap detection
 709    * is enabled.
 710    *
 711    * @SINCE_1_0.0
 712    * @param[in]  tap  The tap gesture.
 713    * @note There is no default behaviour with a tap.
 714    * @note Tap detection should be enabled via EnableGestureDetection().
 715    * @see EnableGestureDetection
 716    */
 717   virtual void OnTap( const TapGesture& tap );
 718
 719   /**
 720    * @brief Called whenever a long press gesture is detected on this control.
 721    *
 722    * This should be overridden by deriving classes when long press
 723    * detection is enabled.
 724    *
 725    * @SINCE_1_0.0
 726    * @param[in]  longPress  The long press gesture.
 727    * @note There is no default behaviour associated with a long press.
 728    * @note Long press detection should be enabled via EnableGestureDetection().
 729    * @see EnableGestureDetection
 730    */
 731   virtual void OnLongPress( const LongPressGesture& longPress );
 732
 733   // From ConnectionTrackerInterface
 734
 735   /**
 736    * @copydoc ConnectionTrackerInterface::SignalConnected
 737    */
 738   virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback );
 739
 740   /**
 741    * @copydoc ConnectionTrackerInterface::SignalDisconnected
 742    */
 743   virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback );
 744
 745   /**
 746    * @brief Retrieve the extension for this control
 747    *
 748    * @SINCE_1_0.0
 749    * @return The extension if available, NULL otherwise
 750    */
 751   virtual Extension* GetControlExtension()
 752   {
 753     return NULL;
 754   }
 755
 756 private:
 757
 758   /// @cond internal
 759   // Undefined
 760   DALI_INTERNAL Control( const Control& );
 761   DALI_INTERNAL Control& operator=( const Control& );
 762
 763   class Impl;
 764   Impl* mImpl;
 765   /// @endcond
 766
 767 };
 768
 769 /**
 770  * @brief Get implementation from the handle.
 771  *
 772  * @SINCE_1_0.0
 773  * @param handle
 774  * @return implementation
 775  * @pre handle is initialized and points to a control
 776  */
 777 DALI_IMPORT_API Internal::Control& GetImplementation( Dali::Toolkit::Control& handle );
 778
 779 /**
 780  * @brief Get implementation from the handle.
 781  *
 782  * @SINCE_1_0.0
 783  * @param handle
 784  * @return implementation
 785  * @pre handle is initialized and points to a control
 786  */
 787 DALI_IMPORT_API const Internal::Control& GetImplementation( const Dali::Toolkit::Control& handle );
 788
 789 } // namespace Internal
 790
 791 /**
 792  * @}
 793  */
 794 } // namespace Toolkit
 795
 796 } // namespace Dali
 797
 798 #endif // DALI_TOOLKIT_CONTROL_IMPL_H