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   /**
 255    * @brief Called by the AccessibilityManager to activate the Control.
 256    * @SINCE_1_0.0
 257    */
 258   DALI_INTERNAL void AccessibilityActivate();
 259
 260   /**
 261    * @brief Called by the KeyboardFocusManager.
 262    * @SINCE_1_0.0
 263    */
 264   DALI_INTERNAL void KeyboardEnter();
 265
 266   // Signals
 267
 268   /**
 269    * @copydoc Dali::Toolkit::Control::KeyEventSignal()
 270    */
 271   Toolkit::Control::KeyEventSignalType& KeyEventSignal();
 272
 273   /**
 274    * @copydoc Dali::Toolkit::Control::KeyInputFocusGainedSignal()
 275    */
 276   Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusGainedSignal();
 277
 278   /**
 279    * @copydoc Dali::Toolkit::Control::KeyInputFocusLostSignal()
 280    */
 281   Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusLostSignal();
 282
 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
 292 protected: // For derived classes to call
 293
 294   /**
 295    * @brief Register a visual by Property Index, linking an Actor to controlRenderer when required.
 296    * In the case of the visual being an actor or control deeming controlRenderer not required then controlRenderer should be an empty handle.
 297    * No parenting is done during registration, this should be done by derived class.
 298    *
 299    * @SINCE_1_1.46
 300    *
 301    * @param[in] index The Property index of the visual, used to reference visual
 302    * @param[in] placementActor The actor used to by the visual.
 303    * @param[in] visual The visual to register
 304    */
 305    void RegisterVisual( Property::Index index, Actor placementActor, Toolkit::Visual::Base visual );
 306
 307    /**
 308     * @brief Erase the entry matching the given index from the list of registered visuals
 309     * @param[in] index The Property index of the visual, used to reference visual
 310     *
 311     * @SINCE_1_1.46
 312     */
 313    void UnregisterVisual( Property::Index index );
 314
 315   /**
 316    * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal
 317    *
 318    * Should be called last by the control after it acts on the Input Focus change.
 319    *
 320    * @SINCE_1_0.0
 321    * @param[in] focusGained True if gained, False if lost
 322    */
 323   void EmitKeyInputFocusSignal( bool focusGained );
 324
 325 protected: // From CustomActorImpl, not to be used by application developers
 326
 327   /**
 328    * @copydoc CustomActorImpl::OnStageConnection()
 329    * @note If overridden, then an up-call to Control::OnStageConnection MUST be made at the start.
 330    */
 331   virtual void OnStageConnection( int depth );
 332
 333   /**
 334    * @copydoc CustomActorImpl::OnStageDisconnection()
 335    * @note If overridden, then an up-call to Control::OnStageDisconnection MUST be made at the end.
 336    */
 337   virtual void OnStageDisconnection();
 338
 339   /**
 340    * @copydoc CustomActorImpl::OnChildAdd()
 341    * @note If overridden, then an up-call to Control::OnChildAdd MUST be made at the start.
 342    */
 343   virtual void OnChildAdd( Actor& child );
 344
 345   /**
 346    * @copydoc CustomActorImpl::OnChildRemove()
 347    * @note If overridden, then an up-call to Control::OnChildRemove MUST be made at the end.
 348    */
 349   virtual void OnChildRemove( Actor& child );
 350
 351   /**
 352    * @copydoc CustomActorImpl::OnSizeSet()
 353    * @note If overridden, then an up-call to Control::OnSizeSet MUST be made at the start.
 354    */
 355   virtual void OnSizeSet( const Vector3& targetSize );
 356
 357   /**
 358    * @copydoc CustomActorImpl::OnSizeAnimation()
 359    * @note If overridden, then an up-call to Control::OnSizeAnimation MUST be made at the start.
 360    */
 361   virtual void OnSizeAnimation( Animation& animation, const Vector3& targetSize );
 362
 363   /**
 364    * @copydoc CustomActorImpl::OnTouchEvent()
 365    */
 366   virtual bool OnTouchEvent( const TouchEvent& event );
 367
 368   /**
 369    * @copydoc CustomActorImpl::OnHoverEvent()
 370    */
 371   virtual bool OnHoverEvent( const HoverEvent& event );
 372
 373   /**
 374    * @copydoc CustomActorImpl::OnKeyEvent()
 375    */
 376   virtual bool OnKeyEvent( const KeyEvent& event );
 377
 378   /**
 379    * @copydoc CustomActorImpl::OnWheelEvent()
 380    */
 381   virtual bool OnWheelEvent( const WheelEvent& event );
 382
 383   /**
 384    * @copydoc CustomActorImpl::OnRelayout()
 385    */
 386   virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
 387
 388   /**
 389    * @copydoc CustomActorImpl::OnSetResizePolicy()
 390    */
 391   virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
 392
 393   /**
 394    * @copydoc CustomActorImpl::GetNaturalSize()
 395    */
 396   virtual Vector3 GetNaturalSize();
 397
 398   /**
 399    * @copydoc CustomActorImpl::CalculateChildSize()
 400    */
 401   virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension );
 402
 403   /**
 404    * @copydoc CustomActorImpl::GetHeightForWidth()
 405    */
 406   virtual float GetHeightForWidth( float width );
 407
 408   /**
 409    * @copydoc CustomActorImpl::GetWidthForHeight()
 410    */
 411   virtual float GetWidthForHeight( float height );
 412
 413   /**
 414    * @copydoc CustomActorImpl::RelayoutDependentOnChildren()
 415    */
 416   virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
 417
 418   /**
 419    * @copydoc CustomActorImpl::OnCalculateRelayoutSize()
 420    */
 421   virtual void OnCalculateRelayoutSize( Dimension::Type dimension );
 422
 423   /**
 424    * @copydoc CustomActorImpl::OnLayoutNegotiated()
 425    */
 426   virtual void OnLayoutNegotiated( float size, Dimension::Type dimension );
 427
 428 protected: // Helpers for deriving classes
 429
 430   // Construction
 431
 432   // Flags for the constructor
 433   enum ControlBehaviour
 434   {
 435     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
 436     REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 1 ),     ///< True if needs to support keyboard navigation @SINCE_1_0.0
 437
 438     LAST_CONTROL_BEHAVIOUR_FLAG
 439   };
 440
 441   static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log< LAST_CONTROL_BEHAVIOUR_FLAG - 1 >::value + 1;      ///< Total count of flags
 442
 443   /**
 444    * @brief Control constructor
 445    *
 446    * @SINCE_1_0.0
 447    * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum
 448    */
 449   Control( ControlBehaviour behaviourFlags );
 450
 451   /**
 452    * @brief Second phase initialization.
 453    * @SINCE_1_0.0
 454    */
 455   void Initialize();
 456
 457 public: // API for derived classes to override
 458
 459   // Lifecycle
 460
 461   /**
 462    * @brief This method is called after the Control has been initialized.
 463    *
 464    * Derived classes should do any second phase initialization by overriding this method.
 465    * @SINCE_1_0.0
 466    */
 467   virtual void OnInitialize();
 468
 469   /**
 470    * @DEPRECATED_1_1.30. Override OnChildAdd instead.
 471    *
 472    * @brief Called whenever an Actor is added to the control.
 473    *
 474    * Could be overridden by derived classes.
 475    *
 476    * @SINCE_1_0.0
 477    * @param[in] child The added actor.
 478    */
 479   virtual void OnControlChildAdd( Actor& child );
 480
 481   /**
 482    * @DEPRECATED_1_1.30. Override OnChildRemove instead.
 483    *
 484    * @brief Called whenever an Actor is removed from the control.
 485    *
 486    * Could be overridden by derived classes.
 487    *
 488    * @SINCE_1_0.0
 489    * @param[in] child The removed actor.
 490    */
 491   virtual void OnControlChildRemove( Actor& child );
 492
 493   // Styling
 494
 495   /**
 496    * @brief This method should be overridden by deriving classes requiring notifications when the style changes.
 497    *
 498    * @SINCE_1_0.0
 499    * @param[in] styleManager  The StyleManager object.
 500    * @param[in] change  Information denoting what has changed.
 501    */
 502   virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change );
 503
 504   // Accessibility
 505
 506   /**
 507    * @brief This method is called when the control is accessibility activated.
 508    *
 509    * Derived classes should override this to perform custom accessibility activation.
 510    * @SINCE_1_0.0
 511    * @return true if this control can perform accessibility activation.
 512    */
 513   virtual bool OnAccessibilityActivated();
 514
 515   /**
 516    * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
 517    * pan gesture.
 518    *
 519    * @SINCE_1_0.0
 520    * @param[in] gesture The pan gesture.
 521    * @return true if the pan gesture has been consumed by this control
 522    */
 523   virtual bool OnAccessibilityPan( PanGesture gesture );
 524
 525   /**
 526    * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
 527    * touch event.
 528    *
 529    * @SINCE_1_0.0
 530    * @param[in] touchEvent The touch event.
 531    * @return true if the touch event has been consumed by this control
 532    */
 533   virtual bool OnAccessibilityTouch( const TouchEvent& touchEvent );
 534
 535   /**
 536    * @brief This method should be overridden by deriving classes when they wish to respond
 537    * the accessibility up and down action (i.e. value change of slider control).
 538    *
 539    * @SINCE_1_0.0
 540    * @param[in] isIncrease Whether the value should be increased or decreased
 541    * @return true if the value changed action has been consumed by this control
 542    */
 543   virtual bool OnAccessibilityValueChange( bool isIncrease );
 544
 545   /**
 546    * @brief This method should be overridden by deriving classes when they wish to respond
 547    * the accessibility zoom action.
 548    *
 549    * @SINCE_1_0.0
 550    * @return true if the zoom action has been consumed by this control
 551    */
 552   virtual bool OnAccessibilityZoom();
 553
 554   // Keyboard focus
 555
 556   /**
 557    * @brief Called when the control gains key input focus.
 558    *
 559    * Should be overridden by derived classes if they need to customize what happens when focus is gained.
 560    * @SINCE_1_0.0
 561    */
 562   virtual void OnKeyInputFocusGained();
 563
 564   /**
 565    * @brief Called when the control loses key input focus.
 566    *
 567    * Should be overridden by derived classes if they need to customize what happens when focus is lost.
 568    * @SINCE_1_0.0
 569    */
 570   virtual void OnKeyInputFocusLost();
 571
 572   /**
 573    * @brief Gets the next keyboard focusable actor in this control towards the given direction.
 574    *
 575    * A control needs to override this function in order to support two dimensional keyboard navigation.
 576    * @SINCE_1_0.0
 577    * @param[in] currentFocusedActor The current focused actor.
 578    * @param[in] direction The direction to move the focus towards.
 579    * @param[in] loopEnabled Whether the focus movement should be looped within the control.
 580    * @return the next keyboard focusable actor in this control or an empty handle if no actor can be focused.
 581    */
 582   virtual Actor GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled );
 583
 584   /**
 585    * @brief Informs this control that its chosen focusable actor will be focused.
 586    *
 587    * This allows the application to preform any actions if wishes
 588    * before the focus is actually moved to the chosen actor.
 589    *
 590    * @SINCE_1_0.0
 591    * @param[in] commitedFocusableActor The commited focusable actor.
 592    */
 593   virtual void OnKeyboardFocusChangeCommitted( Actor commitedFocusableActor );
 594
 595   /**
 596    * @brief This method is called when the control has enter pressed on it.
 597    *
 598    * Derived classes should override this to perform custom actions.
 599    * @SINCE_1_0.0
 600    * @return true if this control supported this action.
 601    */
 602   virtual bool OnKeyboardEnter();
 603
 604   // Gestures
 605
 606   /**
 607    * @brief Called whenever a pinch gesture is detected on this control.
 608    *
 609    * This can be overridden by deriving classes when pinch detection
 610    * is enabled.  The default behaviour is to scale the control by the
 611    * pinch scale.
 612    *
 613    * @SINCE_1_0.0
 614    * @param[in]  pinch  The pinch gesture.
 615    * @note If overridden, then the default behaviour will not occur.
 616    * @note Pinch detection should be enabled via EnableGestureDetection().
 617    * @see EnableGestureDetection
 618    */
 619   virtual void OnPinch( const PinchGesture& pinch );
 620
 621   /**
 622    * @brief Called whenever a pan gesture is detected on this control.
 623    *
 624    * This should be overridden by deriving classes when pan detection
 625    * is enabled.
 626    *
 627    * @SINCE_1_0.0
 628    * @param[in]  pan  The pan gesture.
 629    * @note There is no default behaviour with panning.
 630    * @note Pan detection should be enabled via EnableGestureDetection().
 631    * @see EnableGestureDetection
 632    */
 633   virtual void OnPan( const PanGesture& pan );
 634
 635   /**
 636    * @brief Called whenever a tap gesture is detected on this control.
 637    *
 638    * This should be overridden by deriving classes when tap detection
 639    * is enabled.
 640    *
 641    * @SINCE_1_0.0
 642    * @param[in]  tap  The tap gesture.
 643    * @note There is no default behaviour with a tap.
 644    * @note Tap detection should be enabled via EnableGestureDetection().
 645    * @see EnableGestureDetection
 646    */
 647   virtual void OnTap( const TapGesture& tap );
 648
 649   /**
 650    * @brief Called whenever a long press gesture is detected on this control.
 651    *
 652    * This should be overridden by deriving classes when long press
 653    * detection is enabled.
 654    *
 655    * @SINCE_1_0.0
 656    * @param[in]  longPress  The long press gesture.
 657    * @note There is no default behaviour associated with a long press.
 658    * @note Long press detection should be enabled via EnableGestureDetection().
 659    * @see EnableGestureDetection
 660    */
 661   virtual void OnLongPress( const LongPressGesture& longPress );
 662
 663   // From ConnectionTrackerInterface
 664
 665   /**
 666    * @copydoc ConnectionTrackerInterface::SignalConnected
 667    */
 668   virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback );
 669
 670   /**
 671    * @copydoc ConnectionTrackerInterface::SignalDisconnected
 672    */
 673   virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback );
 674
 675   /**
 676    * @brief Retrieve the extension for this control
 677    *
 678    * @SINCE_1_0.0
 679    * @return The extension if available, NULL otherwise
 680    */
 681   virtual Extension* GetControlExtension()
 682   {
 683     return NULL;
 684   }
 685
 686 private:
 687
 688   // Undefined
 689   DALI_INTERNAL Control( const Control& );
 690   DALI_INTERNAL Control& operator=( const Control& );
 691
 692   class Impl;
 693   Impl* mImpl;
 694
 695 };
 696
 697 /**
 698  * @brief Get 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_IMPORT_API Internal::Control& GetImplementation( Dali::Toolkit::Control& handle );
 706
 707 /**
 708  * @brief Get 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_IMPORT_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