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) 2021 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  * @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   class Extension; ///< Forward declare future extension interface
  60
  61   // Creation & Destruction
  62
  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 protected: // Helpers for deriving classes
 385   // Construction
 386
 387   /**
 388    * @brief Flags for the constructor.
 389    * @SINCE_1_0.0
 390    */
 391   enum ControlBehaviour
 392   {
 393     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
 394     NOT_IN_USE_1                         = 1 << (CustomActorImpl::ACTOR_FLAG_COUNT + 0),
 395     REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << (CustomActorImpl::ACTOR_FLAG_COUNT + 1), ///< True if needs to support keyboard navigation @SINCE_1_0.0
 396     DISABLE_STYLE_CHANGE_SIGNALS         = 1 << (CustomActorImpl::ACTOR_FLAG_COUNT + 2), ///< True if control should not monitor style change signals @SINCE_1_2_10
 397
 398     LAST_CONTROL_BEHAVIOUR_FLAG
 399   };
 400
 401   static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log<LAST_CONTROL_BEHAVIOUR_FLAG - 1>::value + 1; ///< Total count of flags
 402
 403   /**
 404    * @brief Control constructor.
 405    *
 406    * @SINCE_1_0.0
 407    * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum
 408    */
 409   Control(ControlBehaviour behaviourFlags);
 410
 411   /**
 412    * @brief Second phase initialization.
 413    * @SINCE_1_0.0
 414    */
 415   void Initialize();
 416
 417 public: // API for derived classes to override
 418   // Lifecycle
 419
 420   /**
 421    * @brief This method is called after the Control has been initialized.
 422    *
 423    * Derived classes should do any second phase initialization by overriding this method.
 424    * @SINCE_1_0.0
 425    */
 426   virtual void OnInitialize();
 427
 428   // Styling
 429
 430   /**
 431    * @brief This method should be overridden by deriving classes requiring notifications when the style changes.
 432    *
 433    * @SINCE_1_0.0
 434    * @param[in] styleManager The StyleManager object
 435    * @param[in] change Information denoting what has changed
 436    */
 437   virtual void OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change);
 438
 439   // Accessibility
 440
 441   /**
 442    * @brief This method is called when the control is accessibility activated.
 443    *
 444    * Derived classes should override this to perform custom accessibility activation.
 445    * @SINCE_1_0.0
 446    * @return true if this control can perform accessibility activation
 447    */
 448   virtual bool OnAccessibilityActivated();
 449
 450   /**
 451    * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
 452    * pan gesture.
 453    *
 454    * @SINCE_1_0.0
 455    * @param[in] gesture The pan gesture
 456    * @return true if the pan gesture has been consumed by this control
 457    */
 458   virtual bool OnAccessibilityPan(PanGesture gesture);
 459
 460   /**
 461    * @brief This method should be overridden by deriving classes when they wish to respond
 462    * the accessibility up and down action (i.e. value change of slider control).
 463    *
 464    * @SINCE_1_0.0
 465    * @param[in] isIncrease Whether the value should be increased or decreased
 466    * @return true if the value changed action has been consumed by this control
 467    */
 468   virtual bool OnAccessibilityValueChange(bool isIncrease);
 469
 470   /**
 471    * @brief This method should be overridden by deriving classes when they wish to respond
 472    * the accessibility zoom action.
 473    *
 474    * @SINCE_1_0.0
 475    * @return true if the zoom action has been consumed by this control
 476    */
 477   virtual bool OnAccessibilityZoom();
 478
 479   // Keyboard focus
 480
 481   /**
 482    * @brief Called when the control gains key input focus.
 483    *
 484    * Should be overridden by derived classes if they need to customize what happens when focus is gained.
 485    * @SINCE_1_0.0
 486    */
 487   virtual void OnKeyInputFocusGained();
 488
 489   /**
 490    * @brief Called when the control loses key input focus.
 491    *
 492    * Should be overridden by derived classes if they need to customize what happens when focus is lost.
 493    * @SINCE_1_0.0
 494    */
 495   virtual void OnKeyInputFocusLost();
 496
 497   /**
 498    * @brief Gets the next keyboard focusable actor in this control towards the given direction.
 499    *
 500    * A control needs to override this function in order to support two dimensional keyboard navigation.
 501    * @SINCE_1_0.0
 502    * @param[in] currentFocusedActor The current focused actor
 503    * @param[in] direction The direction to move the focus towards
 504    * @param[in] loopEnabled Whether the focus movement should be looped within the control
 505    * @return The next keyboard focusable actor in this control or an empty handle if no actor can be focused
 506    */
 507   virtual Actor GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled);
 508
 509   /**
 510    * @brief Informs this control that its chosen focusable actor will be focused.
 511    *
 512    * This allows the application to perform any actions if wishes
 513    * before the focus is actually moved to the chosen actor.
 514    *
 515    * @SINCE_1_0.0
 516    * @param[in] commitedFocusableActor The commited focusable actor
 517    */
 518   virtual void OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor);
 519
 520   /**
 521    * @brief This method is called when the control has enter pressed on it.
 522    *
 523    * Derived classes should override this to perform custom actions.
 524    * @SINCE_1_0.0
 525    * @return true if this control supported this action
 526    */
 527   virtual bool OnKeyboardEnter();
 528
 529   /**
 530    * @brief Called after a key-event is received by the actor that has had its focus set.
 531    *
 532    * @SINCE_1_0.0
 533    * @param[in] event The Key Event
 534    * @return True if the event should be consumed
 535    */
 536   virtual bool OnKeyEvent(const KeyEvent& event);
 537
 538   // Gestures
 539
 540   /**
 541    * @brief Called whenever a pinch gesture is detected on this control.
 542    *
 543    * This can be overridden by deriving classes when pinch detection
 544    * is enabled.  The default behaviour is to scale the control by the
 545    * pinch scale.
 546    *
 547    * @SINCE_1_0.0
 548    * @param[in] pinch The pinch gesture
 549    * @note If overridden, then the default behavior will not occur.
 550    * @note Pinch detection should be enabled via EnableGestureDetection().
 551    * @see EnableGestureDetection
 552    */
 553   virtual void OnPinch(const PinchGesture& pinch);
 554
 555   /**
 556    * @brief Called whenever a pan gesture is detected on this control.
 557    *
 558    * This should be overridden by deriving classes when pan detection
 559    * is enabled.
 560    *
 561    * @SINCE_1_0.0
 562    * @param[in] pan The pan gesture
 563    * @note There is no default behavior with panning.
 564    * @note Pan detection should be enabled via EnableGestureDetection().
 565    * @see EnableGestureDetection
 566    */
 567   virtual void OnPan(const PanGesture& pan);
 568
 569   /**
 570    * @brief Called whenever a tap gesture is detected on this control.
 571    *
 572    * This should be overridden by deriving classes when tap detection
 573    * is enabled.
 574    *
 575    * @SINCE_1_0.0
 576    * @param[in] tap The tap gesture
 577    * @note There is no default behavior with a tap.
 578    * @note Tap detection should be enabled via EnableGestureDetection().
 579    * @see EnableGestureDetection
 580    */
 581   virtual void OnTap(const TapGesture& tap);
 582
 583   /**
 584    * @brief Called whenever a long press gesture is detected on this control.
 585    *
 586    * This should be overridden by deriving classes when long press
 587    * detection is enabled.
 588    *
 589    * @SINCE_1_0.0
 590    * @param[in] longPress The long press gesture
 591    * @note There is no default behaviour associated with a long press.
 592    * @note Long press detection should be enabled via EnableGestureDetection().
 593    * @see EnableGestureDetection
 594    */
 595   virtual void OnLongPress(const LongPressGesture& longPress);
 596
 597   // From ConnectionTrackerInterface
 598
 599   /**
 600    * @copydoc ConnectionTrackerInterface::SignalConnected
 601    */
 602   void SignalConnected(SlotObserver* slotObserver, CallbackBase* callback) override;
 603
 604   /**
 605    * @copydoc ConnectionTrackerInterface::SignalDisconnected
 606    */
 607   void SignalDisconnected(SlotObserver* slotObserver, CallbackBase* callback) override;
 608
 609   /**
 610    * @brief Retrieves the extension for this control.
 611    *
 612    * @SINCE_1_0.0
 613    * @return The extension if available, NULL otherwise
 614    */
 615   virtual Extension* GetControlExtension()
 616   {
 617     return NULL;
 618   }
 619
 620   // Transition
 621
 622   /**
 623    * @brief Retrieve visual property animations.
 624    * This Control is a destination.
 625    *
 626    * @param[in] animation generated animation
 627    * @param[in] source source control of the animation.
 628    * @param[in] alphaFunction AlphaFunction of the animation
 629    * @param[in] timePeriod TimePeriod of the animation
 630    */
 631   virtual void OnCreateTransitions(Dali::Animation& animation, Dali::Toolkit::Control source, AlphaFunction alphaFunction, TimePeriod timePeriod)
 632   {
 633   }
 634
 635 private:
 636   /// @cond internal
 637
 638   // Not copyable or movable
 639   DALI_INTERNAL Control(const Control&) = delete;            ///< Deleted copy constructor.
 640   DALI_INTERNAL Control(Control&&)      = delete;            ///< Deleted move constructor.
 641   DALI_INTERNAL Control& operator=(const Control&) = delete; ///< Deleted copy assignment operator.
 642   DALI_INTERNAL Control& operator=(Control&&) = delete;      ///< Deleted move assignment operator.
 643
 644 public:
 645   class DALI_INTERNAL Impl; // Class declaration is public so we can internally add devel API's to the Controls Impl
 646
 647 private:
 648   Impl* mImpl;
 649   /// @endcond
 650 };
 651
 652 /**
 653  * @brief Gets implementation from the handle.
 654  *
 655  * @SINCE_1_0.0
 656  * @param handle
 657  * @return Implementation
 658  * @pre handle is initialized and points to a control
 659  */
 660 DALI_TOOLKIT_API Internal::Control& GetImplementation(Dali::Toolkit::Control& handle);
 661
 662 /**
 663  * @brief Gets implementation from the handle.
 664  *
 665  * @SINCE_1_0.0
 666  * @param handle
 667  * @return Implementation
 668  * @pre Handle is initialized and points to a control.
 669  */
 670 DALI_TOOLKIT_API const Internal::Control& GetImplementation(const Dali::Toolkit::Control& handle);
 671
 672 } // namespace Internal
 673
 674 /**
 675  * @}
 676  */
 677 } // namespace Toolkit
 678
 679 } // namespace Dali
 680
 681 #endif // DALI_TOOLKIT_CONTROL_IMPL_H