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) 2019 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
  45 namespace Internal
  46 {
  47
  48 /**
  49  * @brief This is the internal base class for all controls.
  50  *
  51  * It will provide some common functionality required by all controls.
  52  * Implements ConnectionTrackerInterface so that signals (typically connected to member functions) will
  53  * be disconnected automatically when the control is destroyed.
  54  * @SINCE_1_0.0
  55  */
  56 class DALI_TOOLKIT_API Control : public CustomActorImpl, public ConnectionTrackerInterface
  57 {
  58 public:
  59
  60   class Extension; ///< Forward declare future extension interface
  61
  62   // Creation & Destruction
  63
  64   /**
  65    * @brief Creates a new ControlImpl instance that does not require touch by default.
  66    *
  67    * If touch is required, then the user can connect to this class' touch signal.
  68    * @SINCE_1_0.0
  69    * @return A handle to the ControlImpl instance
  70    */
  71   static Toolkit::Control New();
  72
  73 protected:
  74   /**
  75    * @brief Virtual destructor.
  76    * @SINCE_1_0.0
  77    */
  78   virtual ~Control();
  79
  80 public:
  81   // Styling
  82
  83   /**
  84    * @copydoc Dali::Toolkit::Control::SetStyleName
  85    */
  86   void SetStyleName( const std::string& styleName );
  87
  88   /**
  89    * @copydoc Dali::Toolkit::Control::GetStyleName
  90    */
  91   const std::string& GetStyleName() const;
  92
  93   // Background
  94
  95   /**
  96    * @copydoc Dali::Toolkit::Control::SetBackgroundColor
  97    */
  98   void SetBackgroundColor( const Vector4& color );
  99
 100   /**
 101    * @brief Sets the background with a property map.
 102    *
 103    * @SINCE_1_0.0
 104    * @param[in] map The background property map
 105    */
 106   void SetBackground(const Property::Map& map);
 107
 108   /**
 109    * @copydoc Dali::Toolkit::Control::ClearBackground
 110    */
 111   void ClearBackground();
 112
 113   /**
 114    * @brief Sets the shadow with a property map.
 115    * @param[in] map The shadow property map
 116    */
 117   void SetShadow(const Property::Map& map);
 118
 119   /**
 120    * @brief Clear the shadow.
 121    */
 122   void ClearShadow();
 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 limited 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 Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal.
 300    *
 301    * Should be called last by the control after it acts on the Input Focus change.
 302    *
 303    * @SINCE_1_0.0
 304    * @param[in] focusGained True if gained, False if lost
 305    */
 306   void EmitKeyInputFocusSignal( bool focusGained );
 307
 308 protected: // From CustomActorImpl, not to be used by application developers
 309
 310   /**
 311    * @copydoc CustomActorImpl::OnStageConnection()
 312    * @note If overridden, then an up-call to Control::OnStageConnection MUST be made at the end.
 313    */
 314   virtual void OnStageConnection( int depth );
 315
 316   /**
 317    * @copydoc CustomActorImpl::OnStageDisconnection()
 318    * @note If overridden, then an up-call to Control::OnStageDisconnection MUST be made at the end.
 319    */
 320   virtual void OnStageDisconnection();
 321
 322   /**
 323    * @copydoc CustomActorImpl::OnChildAdd()
 324    * @note If overridden, then an up-call to Control::OnChildAdd MUST be made at the end.
 325    */
 326   virtual void OnChildAdd( Actor& child );
 327
 328   /**
 329    * @copydoc CustomActorImpl::OnChildRemove()
 330    * @note If overridden, then an up-call to Control::OnChildRemove MUST be made at the end.
 331    */
 332   virtual void OnChildRemove( Actor& child );
 333
 334   /**
 335    * @copydoc CustomActorImpl::OnPropertySet()
 336    * @note If overridden, then an up-call to Control::OnChildRemove MUST be made at the end.
 337    */
 338   virtual void OnPropertySet( Property::Index index, Property::Value propertyValue );
 339
 340   /**
 341    * @copydoc CustomActorImpl::OnSizeSet()
 342    * @note If overridden, then an up-call to Control::OnSizeSet MUST be made at the end.
 343    */
 344   virtual void OnSizeSet( const Vector3& targetSize );
 345
 346   /**
 347    * @copydoc CustomActorImpl::OnSizeAnimation()
 348    * @note If overridden, then an up-call to Control::OnSizeAnimation MUST be made at the end.
 349    */
 350   virtual void OnSizeAnimation( Animation& animation, const Vector3& targetSize );
 351
 352   /**
 353    * @copydoc CustomActorImpl::OnTouchEvent()
 354    */
 355   virtual bool OnTouchEvent( const TouchEvent& event );
 356
 357   /**
 358    * @copydoc CustomActorImpl::OnHoverEvent()
 359    */
 360   virtual bool OnHoverEvent( const HoverEvent& event );
 361
 362   /**
 363    * @copydoc CustomActorImpl::OnKeyEvent()
 364    */
 365   virtual bool OnKeyEvent( const KeyEvent& event );
 366
 367   /**
 368    * @copydoc CustomActorImpl::OnWheelEvent()
 369    */
 370   virtual bool OnWheelEvent( const WheelEvent& event );
 371
 372   /**
 373    * @copydoc CustomActorImpl::OnRelayout()
 374    */
 375   virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
 376
 377   /**
 378    * @copydoc CustomActorImpl::OnSetResizePolicy()
 379    */
 380   virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
 381
 382   /**
 383    * @copydoc CustomActorImpl::GetNaturalSize()
 384    */
 385   virtual Vector3 GetNaturalSize();
 386
 387   /**
 388    * @copydoc CustomActorImpl::CalculateChildSize()
 389    */
 390   virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension );
 391
 392   /**
 393    * @copydoc CustomActorImpl::GetHeightForWidth()
 394    */
 395   virtual float GetHeightForWidth( float width );
 396
 397   /**
 398    * @copydoc CustomActorImpl::GetWidthForHeight()
 399    */
 400   virtual float GetWidthForHeight( float height );
 401
 402   /**
 403    * @copydoc CustomActorImpl::RelayoutDependentOnChildren()
 404    */
 405   virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
 406
 407   /**
 408    * @copydoc CustomActorImpl::OnCalculateRelayoutSize()
 409    */
 410   virtual void OnCalculateRelayoutSize( Dimension::Type dimension );
 411
 412   /**
 413    * @copydoc CustomActorImpl::OnLayoutNegotiated()
 414    */
 415   virtual void OnLayoutNegotiated( float size, Dimension::Type dimension );
 416
 417 protected: // Helpers for deriving classes
 418
 419   // Construction
 420
 421   /**
 422    * @brief Flags for the constructor.
 423    * @SINCE_1_0.0
 424    */
 425   enum ControlBehaviour
 426   {
 427     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
 428     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
 429     REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 1 ),     ///< True if needs to support keyboard navigation @SINCE_1_0.0
 430
 431     DISABLE_STYLE_CHANGE_SIGNALS         = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 2 ),     ///< True if control should not monitor style change signals @SINCE_1_2_10
 432
 433     LAST_CONTROL_BEHAVIOUR_FLAG
 434   };
 435
 436   static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log< LAST_CONTROL_BEHAVIOUR_FLAG - 1 >::value + 1;      ///< Total count of flags
 437
 438   /**
 439    * @brief Control constructor.
 440    *
 441    * @SINCE_1_0.0
 442    * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum
 443    */
 444   Control( ControlBehaviour behaviourFlags );
 445
 446   /**
 447    * @brief Second phase initialization.
 448    * @SINCE_1_0.0
 449    */
 450   void Initialize();
 451
 452 public: // API for derived classes to override
 453
 454   // Lifecycle
 455
 456   /**
 457    * @brief This method is called after the Control has been initialized.
 458    *
 459    * Derived classes should do any second phase initialization by overriding this method.
 460    * @SINCE_1_0.0
 461    */
 462   virtual void OnInitialize();
 463
 464   /**
 465    * @DEPRECATED_1_1.30. Override OnChildAdd instead.
 466    *
 467    * @brief Called whenever an Actor is added to the control.
 468    *
 469    * Could be overridden by derived classes.
 470    *
 471    * @SINCE_1_0.0
 472    * @param[in] child The added actor
 473    */
 474   virtual void OnControlChildAdd( Actor& child ) DALI_DEPRECATED_API;
 475
 476   /**
 477    * @DEPRECATED_1_1.30. Override OnChildRemove instead.
 478    *
 479    * @brief Called whenever an Actor is removed from the control.
 480    *
 481    * Could be overridden by derived classes.
 482    *
 483    * @SINCE_1_0.0
 484    * @param[in] child The removed actor
 485    */
 486   virtual void OnControlChildRemove( Actor& child ) DALI_DEPRECATED_API;
 487
 488   // Styling
 489
 490   /**
 491    * @brief This method should be overridden by deriving classes requiring notifications when the style changes.
 492    *
 493    * @SINCE_1_0.0
 494    * @param[in] styleManager The StyleManager object
 495    * @param[in] change Information denoting what has changed
 496    */
 497   virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change );
 498
 499   // Accessibility
 500
 501   /**
 502    * @brief This method is called when the control is accessibility activated.
 503    *
 504    * Derived classes should override this to perform custom accessibility activation.
 505    * @SINCE_1_0.0
 506    * @return true if this control can perform accessibility activation
 507    */
 508   virtual bool OnAccessibilityActivated();
 509
 510   /**
 511    * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
 512    * pan gesture.
 513    *
 514    * @SINCE_1_0.0
 515    * @param[in] gesture The pan gesture
 516    * @return true if the pan gesture has been consumed by this control
 517    */
 518   virtual bool OnAccessibilityPan( PanGesture gesture );
 519
 520   /**
 521    * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
 522    * touch event.
 523    *
 524    * @SINCE_1_0.0
 525    * @param[in] touchEvent The touch event
 526    * @return true if the touch event has been consumed by this control
 527    */
 528   virtual bool OnAccessibilityTouch( const TouchEvent& touchEvent );
 529
 530   /**
 531    * @brief This method should be overridden by deriving classes when they wish to respond
 532    * the accessibility up and down action (i.e. value change of slider control).
 533    *
 534    * @SINCE_1_0.0
 535    * @param[in] isIncrease Whether the value should be increased or decreased
 536    * @return true if the value changed action has been consumed by this control
 537    */
 538   virtual bool OnAccessibilityValueChange( bool isIncrease );
 539
 540   /**
 541    * @brief This method should be overridden by deriving classes when they wish to respond
 542    * the accessibility zoom action.
 543    *
 544    * @SINCE_1_0.0
 545    * @return true if the zoom action has been consumed by this control
 546    */
 547   virtual bool OnAccessibilityZoom();
 548
 549   // Keyboard focus
 550
 551   /**
 552    * @brief Called when the control gains key input focus.
 553    *
 554    * Should be overridden by derived classes if they need to customize what happens when focus is gained.
 555    * @SINCE_1_0.0
 556    */
 557   virtual void OnKeyInputFocusGained();
 558
 559   /**
 560    * @brief Called when the control loses key input focus.
 561    *
 562    * Should be overridden by derived classes if they need to customize what happens when focus is lost.
 563    * @SINCE_1_0.0
 564    */
 565   virtual void OnKeyInputFocusLost();
 566
 567   /**
 568    * @brief Gets the next keyboard focusable actor in this control towards the given direction.
 569    *
 570    * A control needs to override this function in order to support two dimensional keyboard navigation.
 571    * @SINCE_1_0.0
 572    * @param[in] currentFocusedActor The current focused actor
 573    * @param[in] direction The direction to move the focus towards
 574    * @param[in] loopEnabled Whether the focus movement should be looped within the control
 575    * @return The next keyboard focusable actor in this control or an empty handle if no actor can be focused
 576    */
 577   virtual Actor GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled );
 578
 579   /**
 580    * @brief Informs this control that its chosen focusable actor will be focused.
 581    *
 582    * This allows the application to perform any actions if wishes
 583    * before the focus is actually moved to the chosen actor.
 584    *
 585    * @SINCE_1_0.0
 586    * @param[in] commitedFocusableActor The commited focusable actor
 587    */
 588   virtual void OnKeyboardFocusChangeCommitted( Actor commitedFocusableActor );
 589
 590   /**
 591    * @brief This method is called when the control has enter pressed on it.
 592    *
 593    * Derived classes should override this to perform custom actions.
 594    * @SINCE_1_0.0
 595    * @return true if this control supported this action
 596    */
 597   virtual bool OnKeyboardEnter();
 598
 599   // Gestures
 600
 601   /**
 602    * @brief Called whenever a pinch gesture is detected on this control.
 603    *
 604    * This can be overridden by deriving classes when pinch detection
 605    * is enabled.  The default behaviour is to scale the control by the
 606    * pinch scale.
 607    *
 608    * @SINCE_1_0.0
 609    * @param[in] pinch The pinch gesture
 610    * @note If overridden, then the default behavior will not occur.
 611    * @note Pinch detection should be enabled via EnableGestureDetection().
 612    * @see EnableGestureDetection
 613    */
 614   virtual void OnPinch( const PinchGesture& pinch );
 615
 616   /**
 617    * @brief Called whenever a pan gesture is detected on this control.
 618    *
 619    * This should be overridden by deriving classes when pan detection
 620    * is enabled.
 621    *
 622    * @SINCE_1_0.0
 623    * @param[in] pan The pan gesture
 624    * @note There is no default behavior with panning.
 625    * @note Pan detection should be enabled via EnableGestureDetection().
 626    * @see EnableGestureDetection
 627    */
 628   virtual void OnPan( const PanGesture& pan );
 629
 630   /**
 631    * @brief Called whenever a tap gesture is detected on this control.
 632    *
 633    * This should be overridden by deriving classes when tap detection
 634    * is enabled.
 635    *
 636    * @SINCE_1_0.0
 637    * @param[in] tap The tap gesture
 638    * @note There is no default behavior with a tap.
 639    * @note Tap detection should be enabled via EnableGestureDetection().
 640    * @see EnableGestureDetection
 641    */
 642   virtual void OnTap( const TapGesture& tap );
 643
 644   /**
 645    * @brief Called whenever a long press gesture is detected on this control.
 646    *
 647    * This should be overridden by deriving classes when long press
 648    * detection is enabled.
 649    *
 650    * @SINCE_1_0.0
 651    * @param[in] longPress The long press gesture
 652    * @note There is no default behaviour associated with a long press.
 653    * @note Long press detection should be enabled via EnableGestureDetection().
 654    * @see EnableGestureDetection
 655    */
 656   virtual void OnLongPress( const LongPressGesture& longPress );
 657
 658   // From ConnectionTrackerInterface
 659
 660   /**
 661    * @copydoc ConnectionTrackerInterface::SignalConnected
 662    */
 663   virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback );
 664
 665   /**
 666    * @copydoc ConnectionTrackerInterface::SignalDisconnected
 667    */
 668   virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback );
 669
 670   /**
 671    * @brief Retrieves the extension for this control.
 672    *
 673    * @SINCE_1_0.0
 674    * @return The extension if available, NULL otherwise
 675    */
 676   virtual Extension* GetControlExtension()
 677   {
 678     return NULL;
 679   }
 680
 681 private:
 682
 683   /// @cond internal
 684   // Undefined
 685   DALI_INTERNAL Control( const Control& );
 686   DALI_INTERNAL Control& operator=( const Control& );
 687
 688 public:
 689   class DALI_INTERNAL Impl; // Class declaration is public so we can internally add devel API's to the Controls Impl
 690
 691 private:
 692   Impl* mImpl;
 693   /// @endcond
 694
 695 };
 696
 697 /**
 698  * @brief Gets implementation from the handle.
 699  *
 700  * @SINCE_1_0.0
 701  * @param handle
 702  * @return Implementation
 703  * @pre handle is initialized and points to a control
 704  */
 705 DALI_TOOLKIT_API Internal::Control& GetImplementation( Dali::Toolkit::Control& handle );
 706
 707 /**
 708  * @brief Gets implementation from the handle.
 709  *
 710  * @SINCE_1_0.0
 711  * @param handle
 712  * @return Implementation
 713  * @pre Handle is initialized and points to a control.
 714  */
 715 DALI_TOOLKIT_API const Internal::Control& GetImplementation( const Dali::Toolkit::Control& handle );
 716
 717 } // namespace Internal
 718
 719 /**
 720  * @}
 721  */
 722 } // namespace Toolkit
 723
 724 } // namespace Dali
 725
 726 #endif // DALI_TOOLKIT_CONTROL_IMPL_H