dali-toolkit/public-api/controls/control.h

   1 #ifndef DALI_TOOLKIT_CONTROL_H
   2 #define DALI_TOOLKIT_CONTROL_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-toolkit/public-api/dali-toolkit-common.h>
  23 #include <dali/public-api/actors/custom-actor.h>
  24 #include <dali/public-api/events/long-press-gesture-detector.h>
  25 #include <dali/public-api/events/pan-gesture-detector.h>
  26 #include <dali/public-api/events/pinch-gesture-detector.h>
  27 #include <dali/public-api/events/tap-gesture-detector.h>
  28
  29 // INTERNAL INCLUDES
  30 #include <dali-toolkit/public-api/visuals/visual-properties.h>
  31
  32 namespace Dali
  33 {
  34 namespace Toolkit
  35 {
  36 //Forward declarations.
  37
  38 namespace Internal
  39 {
  40 class Control;
  41 }
  42 /**
  43  * @addtogroup dali_toolkit_controls
  44  * @{
  45  */
  46
  47 /**
  48  * @brief Control is the base class for all controls.
  49  *
  50  * The implementation of the control must be supplied; see Internal::Control for more details.
  51  * @SINCE_1_0.0
  52  * @see Internal::Control
  53  *
  54  * Signals
  55  * | %Signal Name           | Method                                              |
  56  * |------------------------|-----------------------------------------------------|
  57  * | keyEvent               | @ref KeyEventSignal()                               |
  58  * | keyInputFocusGained    | @ref KeyInputFocusGainedSignal()                    |
  59  * | keyInputFocusLost      | @ref KeyInputFocusLostSignal()                      |
  60  * | resourceReady          | @ref ResourceReadySignal()                          |
  61  * | tapped                 | @ref GetTapGestureDetector().DetectedSignal()       |
  62  * | panned                 | @ref GetPanGestureDetector().DetectedSignal()       |
  63  * | pinched                | @ref GetPinchGestureDetector().DetectedSignal()     |
  64  * | longPressed            | @ref GetLongPressGestureDetector().DetectedSignal() |
  65  *
  66  * Actions
  67  * | %Action Name           | %Control method called                             |
  68  * |------------------------|----------------------------------------------------|
  69  * | accessibilityActivated | %OnAccessibilityActivated()                        |
  70  */
  71 class DALI_TOOLKIT_API Control : public CustomActor
  72 {
  73 public:
  74   /**
  75    * @brief Enumeration for the start and end property ranges for control.
  76    * @SINCE_1_0.0
  77    */
  78   enum PropertyRange
  79   {
  80     PROPERTY_START_INDEX         = PROPERTY_REGISTRATION_START_INDEX,  ///< Start index is used by the property registration macro. @SINCE_1_0.0
  81     CONTROL_PROPERTY_START_INDEX = PROPERTY_START_INDEX,               ///< Start index of Control properties. @SINCE_1_0.0
  82     CONTROL_PROPERTY_END_INDEX   = CONTROL_PROPERTY_START_INDEX + 1000 ///< Reserving 1000 property indices. @SINCE_1_0.0
  83   };
  84
  85   /**
  86    * @brief Enumeration for the instance of properties belonging to the Control class.
  87    * @SINCE_1_0.0
  88    */
  89   struct Property
  90   {
  91     /**
  92      * @brief Enumeration for the instance of properties belonging to the Control class.
  93      * @SINCE_1_0.0
  94      */
  95     enum
  96     {
  97       /**
  98        * @brief The name of the style to be applied to the control.
  99        * @details Name "styleName", type Property::STRING.
 100        * @see Toolkit::Control::SetStyleName()
 101        * @SINCE_1_0.0
 102        */
 103       STYLE_NAME = PROPERTY_START_INDEX,
 104
 105       /**
 106        * @brief Receives key events to the control.
 107        * @details Name "keyInputFocus", type Property::BOOLEAN.
 108        * @see Toolkit::Control::SetKeyInputFocus()
 109        * @SINCE_1_0.0
 110        */
 111       KEY_INPUT_FOCUS,
 112
 113       /**
 114        * @brief The background of the control.
 115        *
 116        * @details Name "background", type Property::MAP or std::string for URL or Property::VECTOR4 for Color.
 117        * @SINCE_1_1.3
 118        */
 119       BACKGROUND,
 120
 121       /**
 122        * @brief The outer space around the control.
 123        * @details Name "margin", type Property::EXTENTS.
 124        * @SINCE_1_2.62
 125        * @note Margin property is to be supported by Layout algorithms and containers in future.
 126        */
 127       MARGIN,
 128
 129       /**
 130        * @brief The inner space of the control.
 131        * @details Name "padding", type Property::EXTENTS.
 132        * @SINCE_1_2.62
 133        */
 134       PADDING
 135     };
 136   };
 137
 138   /**
 139    * @brief Describes the direction to move the keyboard focus towards.
 140    * @SINCE_1_0.0
 141    */
 142   struct KeyboardFocus
 143   {
 144     /**
 145      * @brief Keyboard focus direction.
 146      * @SINCE_1_0.0
 147      */
 148     enum Direction
 149     {
 150       LEFT,      ///< Move keyboard focus towards the left direction @SINCE_1_0.0
 151       RIGHT,     ///< Move keyboard focus towards the right direction @SINCE_1_0.0
 152       UP,        ///< Move keyboard focus towards the up direction @SINCE_1_0.0
 153       DOWN,      ///< Move keyboard focus towards the down direction @SINCE_1_0.0
 154       PAGE_UP,   ///< Move keyboard focus towards the previous page direction @SINCE_1_2.14
 155       PAGE_DOWN, ///< Move keyboard focus towards the next page direction @SINCE_1_2.14
 156       FORWARD,   ///< Move keyboard focus towards the forward direction @SINCE_2_1.10
 157       BACKWARD,  ///< Move keyboard focus towards the backward direction @SINCE_2_1.10
 158       CLOCKWISE,  ///< Move keyboard focus towards the clockwise direction @SINCE_2_1.14
 159       COUNTER_CLOCKWISE,  ///< Move keyboard focus towards the counter clockwise direction @SINCE_2_1.14
 160     };
 161   };
 162
 163   // Typedefs
 164
 165   /// @brief Key Event signal type. @SINCE_1_0.0
 166   typedef Signal<bool(Control, const KeyEvent&)> KeyEventSignalType;
 167
 168   /// @brief Key InputFocusType signal type. @SINCE_1_0.0
 169   typedef Signal<void(Control)> KeyInputFocusSignalType;
 170
 171   /// @brief ResourceReady signal type. @SINCE_1_2.60
 172   typedef Signal<void(Control)> ResourceReadySignalType;
 173
 174 public: // Creation & Destruction
 175
 176   /**
 177    * @brief Additional control behaviour flags for the control constructor.
 178    * @note TODO : Currunt code is hard-coded. We Should sync type values as
 179    * CustomActorImpl::ActorFlag and Internal::Control::ControlBehaviour in future.
 180    * @SINCE_2_1.8
 181    */
 182   enum ControlBehaviour
 183   {
 184     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
 185     DISABLE_SIZE_NEGOTIATION             = 1 << (0 + 0), ///< True if control does not need size negotiation, i.e. it can be skipped in the algorithm @SINCE_1_0.0
 186     REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << (4 + 1), ///< True if needs to support keyboard navigation @SINCE_1_0.0
 187     DISABLE_STYLE_CHANGE_SIGNALS         = 1 << (4 + 2), ///< True if control should not monitor style change signals @SINCE_1_2_10
 188   };
 189
 190   /**
 191    * @brief Creates a new instance of a Control.
 192    *
 193    * @SINCE_1_0.0
 194    * @return A handle to a new Control
 195    */
 196   static Control New();
 197
 198   /**
 199    * @brief Creates a new instance of a Control with additional behaviour.
 200    *
 201    * @SINCE_2_1.8
 202    * @param[in] additionalBehaviour Additional control behaviour
 203    * @return A handle to a new Control
 204    */
 205   static Control New(ControlBehaviour additionalBehaviour);
 206
 207   /**
 208    * @brief Creates an uninitialized Control handle.
 209    *
 210    * Only derived versions can be instantiated.  Calling member
 211    * functions with an uninitialized Dali::Object is not allowed.
 212    * @SINCE_1_0.0
 213    */
 214   Control();
 215
 216   /**
 217    * @brief Copy constructor.
 218    *
 219    * Creates another handle that points to the same real object.
 220    * @SINCE_1_0.0
 221    * @param[in] uiControl Handle to copy
 222    */
 223   Control(const Control& uiControl);
 224
 225   /**
 226    * @brief Move constructor.
 227    *
 228    * @SINCE_1_9.23
 229    * @param[in] rhs Handle to move
 230    */
 231   Control(Control&& rhs);
 232
 233   /**
 234    * @brief Dali::Control is intended as a base class.
 235    *
 236    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 237    * @SINCE_1_0.0
 238    */
 239   ~Control();
 240
 241 public: // operators
 242   /**
 243    * @brief Copy assignment operator.
 244    *
 245    * Changes this handle to point to another real object.
 246    * @SINCE_1_0.0
 247    * @param[in] handle Object to assign this to
 248    * @return Reference to this
 249    */
 250   Control& operator=(const Control& handle);
 251
 252   /**
 253    * @brief Move assignment operator.
 254    *
 255    * @SINCE_1_9.23
 256    * @param[in] rhs Object to assign this to
 257    * @return Reference to this
 258    */
 259   Control& operator=(Control&& rhs);
 260
 261 public:
 262   /**
 263    * @brief Downcasts a handle to Control handle.
 264    *
 265    * If handle points to a Control, the downcast produces valid handle.
 266    * If not, the returned handle is left uninitialized.
 267    *
 268    * @SINCE_1_0.0
 269    * @param[in] handle Handle to an object
 270    * @return A handle to a Control or an uninitialized handle
 271    */
 272   static Control DownCast(BaseHandle handle);
 273
 274   // Key Input
 275
 276   /**
 277    * @brief This sets the control to receive key events.
 278    *
 279    * The key event can originate from a virtual or physical keyboard.
 280    * @SINCE_1_0.0
 281    * @pre The Control has been initialized.
 282    * @pre The Control should be on the stage before setting keyboard focus.
 283    */
 284   void SetKeyInputFocus();
 285
 286   /**
 287    * @brief Quries whether the control has key input focus.
 288    *
 289    * @SINCE_1_0.0
 290    * @return true if this control has keyboard input focus
 291    * @pre The Control has been initialized.
 292    * @pre The Control should be on the stage before setting keyboard focus.
 293    * @note The control can be set to have the focus and still not receive all the key events if another control has over ridden it.
 294    * As the key input focus mechanism works like a stack, the top most control receives all the key events, and passes on the
 295    * unhandled events to the controls below in the stack. A control in the stack will regain key input focus when there are no more
 296    * controls above it in the focus stack.
 297    * To query for the control which is on top of the focus stack use Dali::Toolkit::KeyInputFocusManager::GetCurrentKeyboardFocusActor().
 298    */
 299   bool HasKeyInputFocus();
 300
 301   /**
 302    * @brief Once an actor is Set to receive key input focus this function is called to stop it receiving key events.
 303    *
 304    * A check is performed to ensure it was previously set, if this check fails then nothing is done.
 305    * @SINCE_1_0.0
 306    * @pre The Actor has been initialized.
 307    */
 308   void ClearKeyInputFocus();
 309
 310   // Gesture Detection
 311
 312   /**
 313    * @brief Retrieves the pinch gesture detector of the control.
 314    *
 315    * @SINCE_1_0.0
 316    * @return The pinch gesture detector
 317    * @note Will return an empty handle if the control does not handle the gesture itself.
 318    */
 319   PinchGestureDetector GetPinchGestureDetector() const;
 320
 321   /**
 322    * @brief Retrieves the pan gesture detector of the control.
 323    *
 324    * @SINCE_1_0.0
 325    * @return The pan gesture detector
 326    * @note Will return an empty handle if the control does not handle the gesture itself.
 327    */
 328   PanGestureDetector GetPanGestureDetector() const;
 329
 330   /**
 331    * @brief Retrieves the tap gesture detector of the control.
 332    *
 333    * @SINCE_1_0.0
 334    * @return The tap gesture detector
 335    * @note Will return an empty handle if the control does not handle the gesture itself.
 336    */
 337   TapGestureDetector GetTapGestureDetector() const;
 338
 339   /**
 340    * @brief Retrieves the long press gesture detector of the control.
 341    *
 342    * @SINCE_1_0.0
 343    * @return The long press gesture detector
 344    * @note Will return an empty handle if the control does not handle the gesture itself.
 345    */
 346   LongPressGestureDetector GetLongPressGestureDetector() const;
 347
 348   // Styling
 349
 350   /**
 351    * @brief Sets the name of the style to be applied to the control.
 352    *
 353    * @SINCE_1_0.0
 354    * @param[in] styleName A string matching a style described in a stylesheet
 355    */
 356   void SetStyleName(const std::string& styleName);
 357
 358   /**
 359    * @brief Retrieves the name of the style to be applied to the control (if any).
 360    * @SINCE_1_0.0
 361    * @return A string matching a style, or an empty string
 362    */
 363   const std::string& GetStyleName() const;
 364
 365   // Background
 366
 367   /**
 368    * @brief Sets the background color of the control.
 369    *
 370    * @SINCE_1_0.0
 371    * @param[in] color The required background color of the control
 372    *
 373    * @note If SetBackgroundImage is called later, this background color is removed.
 374    *
 375    * @note The background color fully blends with the actor color.
 376    */
 377   void SetBackgroundColor(const Vector4& color);
 378
 379   /**
 380    * @brief Clears the background.
 381    * @SINCE_1_0.0
 382    */
 383   void ClearBackground();
 384
 385   // Resources
 386
 387   /**
 388    * @brief Query if all resources required by a control are loaded and ready.
 389    *
 390    * Most resources are only loaded when the control is placed on stage.
 391    * @SINCE_1_2.60
 392    * @return true if the resources are loaded and ready, false otherwise
 393    */
 394   bool IsResourceReady() const;
 395
 396   /**
 397    * @brief Get the loading state of the visual resource.
 398    *
 399    * @SINCE_1_3_5
 400    * @param[in] index The Property index of the visual
 401    * @return Return the loading status (PREPARING, READY and FAILED) of visual resource
 402    */
 403   Visual::ResourceStatus GetVisualResourceStatus(const Dali::Property::Index index);
 404
 405   // Signals
 406
 407   /**
 408    * @brief This signal is emitted when key event is received.
 409    *
 410    * A callback of the following type may be connected:
 411    * @code
 412    *   bool YourCallbackName(Control control, const KeyEvent& event);
 413    * @endcode
 414    * The return value of True, indicates that the event should be consumed.
 415    * Otherwise the signal will be emitted on the next parent of the actor.
 416    * @SINCE_1_0.0
 417    * @return The signal to connect to
 418    * @pre The Control has been initialized.
 419    */
 420   KeyEventSignalType& KeyEventSignal();
 421
 422   /**
 423    * @brief This signal is emitted when the control gets Key Input Focus.
 424    *
 425    * A callback of the following type may be connected:
 426    * @code
 427    *   bool YourCallbackName( Control control );
 428    * @endcode
 429    * The return value of True, indicates that the event should be consumed.
 430    * Otherwise the signal will be emitted on the next parent of the actor.
 431    * @SINCE_1_0.0
 432    * @return The signal to connect to
 433    * @pre The Control has been initialized.
 434    */
 435   KeyInputFocusSignalType& KeyInputFocusGainedSignal();
 436
 437   /**
 438    * @brief This signal is emitted when the control loses Key Input Focus.
 439    *
 440    * This could be due to it being gained by another Control or Actor or just cleared from
 441    * this control as no longer required.
 442    *
 443    * A callback of the following type may be connected:
 444    * @code
 445    *   bool YourCallbackName( Control control );
 446    * @endcode
 447    * The return value of True, indicates that the event should be consumed.
 448    * Otherwise the signal will be emitted on the next parent of the actor.
 449    * @SINCE_1_0.0
 450    * @return The signal to connect to
 451    * @pre The Control has been initialized.
 452    */
 453   KeyInputFocusSignalType& KeyInputFocusLostSignal();
 454
 455   /**
 456    * @brief This signal is emitted after all resources required by a control are loaded and ready.
 457    *
 458    * Most resources are only loaded when the control is placed on stage.
 459    *
 460    * If resources are shared between ImageViews, they are cached.
 461    * In this case, the ResourceReady signal may be sent before there is an object to connect to.
 462    * To protect against this, IsResourceReady() can be checked first.
 463    *
 464    * @code
 465    *    auto newControl = Control::New();
 466    *    newControl.SetResource( resourceUrl );
 467    *    if ( newControl.IsResourceReady() )
 468    *    {
 469    *       // do something
 470    *    }
 471    *    else
 472    *    {
 473    *      newControl.ResourceReadySignal.Connect( .... )
 474    *    }
 475    * @endcode
 476    *
 477    * A callback of the following type may be connected:
 478    * @code
 479    *   void YourCallbackName( Control control );
 480    * @endcode
 481    *
 482    * @SINCE_1_2.60
 483    * @return The signal to connect to
 484    * @note A RelayoutRequest is queued by Control before this signal is emitted
 485    */
 486   ResourceReadySignalType& ResourceReadySignal();
 487
 488 public: // Intended for control developers
 489   /**
 490    * @brief Creates an initialized Control.
 491    *
 492    * @SINCE_1_0.0
 493    * @param[in] implementation The implementation for this control
 494    * @note Should NOT be called to create a handle from the implementation. As stated, this allocates a NEW Dali resource.
 495    */
 496   explicit Control(Internal::Control& implementation);
 497
 498   /**
 499    * @brief This constructor is used by CustomActor within Dali core to create additional Control handles
 500    * using an Internal CustomActor pointer.
 501    *
 502    * @SINCE_1_0.0
 503    * @param[in] internal A pointer to a newly allocated Dali resource
 504    */
 505   explicit Control(Dali::Internal::CustomActor* internal);
 506
 507 public: // Templates for Deriving Classes
 508   /**
 509    * @brief Template to allow deriving controls to DownCast handles to deriving handle classes.
 510    *
 511    * @tparam     T      The handle class
 512    * @tparam     I      The implementation class
 513    * @SINCE_1_0.0
 514    * @param[in] handle Handle to an object
 515    * @return Handle to a class T or an uninitialized handle
 516    * @see DownCast(BaseHandle)
 517    */
 518   template<typename T, typename I>
 519   DALI_INTERNAL static T DownCast(BaseHandle handle)
 520   {
 521     T result;
 522
 523     CustomActor custom = Dali::CustomActor::DownCast(handle);
 524     if(custom)
 525     {
 526       CustomActorImpl& customImpl = custom.GetImplementation();
 527
 528       I* impl = dynamic_cast<I*>(&customImpl);
 529
 530       if(impl)
 531       {
 532         result = T(customImpl.GetOwner());
 533       }
 534     }
 535
 536     return result;
 537   }
 538
 539   /**
 540    * @brief Template to allow deriving controls to verify whether the Internal::CustomActor* is actually an
 541    * implementation of their class.
 542    *
 543    * @tparam     I       The implementation class
 544    * @SINCE_1_0.0
 545    * @param[in] internal Pointer to the Internal::CustomActor
 546    */
 547   template<typename I>
 548   DALI_INTERNAL void VerifyCustomActorPointer(Dali::Internal::CustomActor* internal)
 549   {
 550     // Can have a NULL pointer so we only need to check if the internal implementation is our class
 551     // when there is a value.
 552     if(internal)
 553     {
 554       DALI_ASSERT_DEBUG(dynamic_cast<I*>(&CustomActor(internal).GetImplementation()));
 555     }
 556   }
 557 };
 558
 559 /**
 560  * @}
 561  */
 562 } // namespace Toolkit
 563
 564 } // namespace Dali
 565
 566 #endif // DALI_TOOLKIT_CONTROL_H