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