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