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