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

   1 #ifndef DALI_TOOLKIT_CONTROL_H
   2 #define DALI_TOOLKIT_CONTROL_H
   3
   4 /*
   5  * Copyright (c) 2020 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     };
 157   };
 158
 159   // Typedefs
 160
 161   /// @brief Key Event signal type. @SINCE_1_0.0
 162   typedef Signal<bool(Control, const KeyEvent&)> KeyEventSignalType;
 163
 164   /// @brief Key InputFocusType signal type. @SINCE_1_0.0
 165   typedef Signal<void(Control)> KeyInputFocusSignalType;
 166
 167   /// @brief ResourceReady signal type. @SINCE_1_2.60
 168   typedef Signal<void(Control)> ResourceReadySignalType;
 169
 170 public: // Creation & Destruction
 171   /**
 172    * @brief Creates a new instance of a Control.
 173    *
 174    * @SINCE_1_0.0
 175    * @return A handle to a new Control
 176    */
 177   static Control New();
 178
 179   /**
 180    * @brief Creates an uninitialized Control handle.
 181    *
 182    * Only derived versions can be instantiated.  Calling member
 183    * functions with an uninitialized Dali::Object is not allowed.
 184    * @SINCE_1_0.0
 185    */
 186   Control();
 187
 188   /**
 189    * @brief Copy constructor.
 190    *
 191    * Creates another handle that points to the same real object.
 192    * @SINCE_1_0.0
 193    * @param[in] uiControl Handle to copy
 194    */
 195   Control(const Control& uiControl);
 196
 197   /**
 198    * @brief Move constructor.
 199    *
 200    * @SINCE_1_9.23
 201    * @param[in] rhs Handle to move
 202    */
 203   Control(Control&& rhs);
 204
 205   /**
 206    * @brief Dali::Control is intended as a base class.
 207    *
 208    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 209    * @SINCE_1_0.0
 210    */
 211   ~Control();
 212
 213 public: // operators
 214   /**
 215    * @brief Copy assignment operator.
 216    *
 217    * Changes this handle to point to another real object.
 218    * @SINCE_1_0.0
 219    * @param[in] handle Object to assign this to
 220    * @return Reference to this
 221    */
 222   Control& operator=(const Control& handle);
 223
 224   /**
 225    * @brief Move assignment operator.
 226    *
 227    * @SINCE_1_9.23
 228    * @param[in] rhs Object to assign this to
 229    * @return Reference to this
 230    */
 231   Control& operator=(Control&& rhs);
 232
 233 public:
 234   /**
 235    * @brief Downcasts a handle to Control handle.
 236    *
 237    * If handle points to a Control, the downcast produces valid handle.
 238    * If not, the returned handle is left uninitialized.
 239    *
 240    * @SINCE_1_0.0
 241    * @param[in] handle Handle to an object
 242    * @return A handle to a Control or an uninitialized handle
 243    */
 244   static Control DownCast(BaseHandle handle);
 245
 246   // Key Input
 247
 248   /**
 249    * @brief This sets the control to receive key events.
 250    *
 251    * The key event can originate from a virtual or physical keyboard.
 252    * @SINCE_1_0.0
 253    * @pre The Control has been initialized.
 254    * @pre The Control should be on the stage before setting keyboard focus.
 255    */
 256   void SetKeyInputFocus();
 257
 258   /**
 259    * @brief Quries whether the control has key input focus.
 260    *
 261    * @SINCE_1_0.0
 262    * @return true if this control has keyboard input focus
 263    * @pre The Control has been initialized.
 264    * @pre The Control should be on the stage before setting keyboard focus.
 265    * @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.
 266    * As the key input focus mechanism works like a stack, the top most control receives all the key events, and passes on the
 267    * unhandled events to the controls below in the stack. A control in the stack will regain key input focus when there are no more
 268    * controls above it in the focus stack.
 269    * To query for the control which is on top of the focus stack use Dali::Toolkit::KeyInputFocusManager::GetCurrentKeyboardFocusActor().
 270    */
 271   bool HasKeyInputFocus();
 272
 273   /**
 274    * @brief Once an actor is Set to receive key input focus this function is called to stop it receiving key events.
 275    *
 276    * A check is performed to ensure it was previously set, if this check fails then nothing is done.
 277    * @SINCE_1_0.0
 278    * @pre The Actor has been initialized.
 279    */
 280   void ClearKeyInputFocus();
 281
 282   // Gesture Detection
 283
 284   /**
 285    * @brief Retrieves the pinch gesture detector of the control.
 286    *
 287    * @SINCE_1_0.0
 288    * @return The pinch gesture detector
 289    * @note Will return an empty handle if the control does not handle the gesture itself.
 290    */
 291   PinchGestureDetector GetPinchGestureDetector() const;
 292
 293   /**
 294    * @brief Retrieves the pan gesture detector of the control.
 295    *
 296    * @SINCE_1_0.0
 297    * @return The pan gesture detector
 298    * @note Will return an empty handle if the control does not handle the gesture itself.
 299    */
 300   PanGestureDetector GetPanGestureDetector() const;
 301
 302   /**
 303    * @brief Retrieves the tap gesture detector of the control.
 304    *
 305    * @SINCE_1_0.0
 306    * @return The tap gesture detector
 307    * @note Will return an empty handle if the control does not handle the gesture itself.
 308    */
 309   TapGestureDetector GetTapGestureDetector() const;
 310
 311   /**
 312    * @brief Retrieves the long press gesture detector of the control.
 313    *
 314    * @SINCE_1_0.0
 315    * @return The long press gesture detector
 316    * @note Will return an empty handle if the control does not handle the gesture itself.
 317    */
 318   LongPressGestureDetector GetLongPressGestureDetector() const;
 319
 320   // Styling
 321
 322   /**
 323    * @brief Sets the name of the style to be applied to the control.
 324    *
 325    * @SINCE_1_0.0
 326    * @param[in] styleName A string matching a style described in a stylesheet
 327    */
 328   void SetStyleName(const std::string& styleName);
 329
 330   /**
 331    * @brief Retrieves the name of the style to be applied to the control (if any).
 332    * @SINCE_1_0.0
 333    * @return A string matching a style, or an empty string
 334    */
 335   const std::string& GetStyleName() const;
 336
 337   // Background
 338
 339   /**
 340    * @brief Sets the background color of the control.
 341    *
 342    * @SINCE_1_0.0
 343    * @param[in] color The required background color of the control
 344    *
 345    * @note If SetBackgroundImage is called later, this background color is removed.
 346    *
 347    * @note The background color fully blends with the actor color.
 348    */
 349   void SetBackgroundColor(const Vector4& color);
 350
 351   /**
 352    * @brief Clears the background.
 353    * @SINCE_1_0.0
 354    */
 355   void ClearBackground();
 356
 357   // Resources
 358
 359   /**
 360    * @brief Query if all resources required by a control are loaded and ready.
 361    *
 362    * Most resources are only loaded when the control is placed on stage.
 363    * @SINCE_1_2.60
 364    * @return true if the resources are loaded and ready, false otherwise
 365    */
 366   bool IsResourceReady() const;
 367
 368   /**
 369    * @brief Get the loading state of the visual resource.
 370    *
 371    * @SINCE_1_3_5
 372    * @param[in] index The Property index of the visual
 373    * @return Return the loading status (PREPARING, READY and FAILED) of visual resource
 374    */
 375   Visual::ResourceStatus GetVisualResourceStatus(const Dali::Property::Index index);
 376
 377   // Signals
 378
 379   /**
 380    * @brief This signal is emitted when key event is received.
 381    *
 382    * A callback of the following type may be connected:
 383    * @code
 384    *   bool YourCallbackName(Control control, const KeyEvent& event);
 385    * @endcode
 386    * The return value of True, indicates that the event should be consumed.
 387    * Otherwise the signal will be emitted on the next parent of the actor.
 388    * @SINCE_1_0.0
 389    * @return The signal to connect to
 390    * @pre The Control has been initialized.
 391    */
 392   KeyEventSignalType& KeyEventSignal();
 393
 394   /**
 395    * @brief This signal is emitted when the control gets Key Input Focus.
 396    *
 397    * A callback of the following type may be connected:
 398    * @code
 399    *   bool YourCallbackName( Control control );
 400    * @endcode
 401    * The return value of True, indicates that the event should be consumed.
 402    * Otherwise the signal will be emitted on the next parent of the actor.
 403    * @SINCE_1_0.0
 404    * @return The signal to connect to
 405    * @pre The Control has been initialized.
 406    */
 407   KeyInputFocusSignalType& KeyInputFocusGainedSignal();
 408
 409   /**
 410    * @brief This signal is emitted when the control loses Key Input Focus.
 411    *
 412    * This could be due to it being gained by another Control or Actor or just cleared from
 413    * this control as no longer required.
 414    *
 415    * A callback of the following type may be connected:
 416    * @code
 417    *   bool YourCallbackName( Control control );
 418    * @endcode
 419    * The return value of True, indicates that the event should be consumed.
 420    * Otherwise the signal will be emitted on the next parent of the actor.
 421    * @SINCE_1_0.0
 422    * @return The signal to connect to
 423    * @pre The Control has been initialized.
 424    */
 425   KeyInputFocusSignalType& KeyInputFocusLostSignal();
 426
 427   /**
 428    * @brief This signal is emitted after all resources required by a control are loaded and ready.
 429    *
 430    * Most resources are only loaded when the control is placed on stage.
 431    *
 432    * If resources are shared between ImageViews, they are cached.
 433    * In this case, the ResourceReady signal may be sent before there is an object to connect to.
 434    * To protect against this, IsResourceReady() can be checked first.
 435    *
 436    * @code
 437    *    auto newControl = Control::New();
 438    *    newControl.SetResource( resourceUrl );
 439    *    if ( newControl.IsResourceReady() )
 440    *    {
 441    *       // do something
 442    *    }
 443    *    else
 444    *    {
 445    *      newControl.ResourceReadySignal.Connect( .... )
 446    *    }
 447    * @endcode
 448    *
 449    * A callback of the following type may be connected:
 450    * @code
 451    *   void YourCallbackName( Control control );
 452    * @endcode
 453    *
 454    * @SINCE_1_2.60
 455    * @return The signal to connect to
 456    * @note A RelayoutRequest is queued by Control before this signal is emitted
 457    */
 458   ResourceReadySignalType& ResourceReadySignal();
 459
 460 public: // Intended for control developers
 461   /**
 462    * @brief Creates an initialized Control.
 463    *
 464    * @SINCE_1_0.0
 465    * @param[in] implementation The implementation for this control
 466    * @return A handle to a newly allocated Dali resource
 467    * @note Should NOT be called to create a handle from the implementation. As stated, this allocates a NEW Dali resource.
 468    */
 469   explicit Control(Internal::Control& implementation);
 470
 471   /**
 472    * @brief This constructor is used by CustomActor within Dali core to create additional Control handles
 473    * using an Internal CustomActor pointer.
 474    *
 475    * @SINCE_1_0.0
 476    * @param[in] internal A pointer to a newly allocated Dali resource
 477    */
 478   explicit Control(Dali::Internal::CustomActor* internal);
 479
 480 public: // Templates for Deriving Classes
 481   /**
 482    * @brief Template to allow deriving controls to DownCast handles to deriving handle classes.
 483    *
 484    * @tparam     T      The handle class
 485    * @tparam     I      The implementation class
 486    * @SINCE_1_0.0
 487    * @param[in] handle Handle to an object
 488    * @return Handle to a class T or an uninitialized handle
 489    * @see DownCast(BaseHandle)
 490    */
 491   template<typename T, typename I>
 492   DALI_INTERNAL static T DownCast(BaseHandle handle)
 493   {
 494     T result;
 495
 496     CustomActor custom = Dali::CustomActor::DownCast(handle);
 497     if(custom)
 498     {
 499       CustomActorImpl& customImpl = custom.GetImplementation();
 500
 501       I* impl = dynamic_cast<I*>(&customImpl);
 502
 503       if(impl)
 504       {
 505         result = T(customImpl.GetOwner());
 506       }
 507     }
 508
 509     return result;
 510   }
 511
 512   /**
 513    * @brief Template to allow deriving controls to verify whether the Internal::CustomActor* is actually an
 514    * implementation of their class.
 515    *
 516    * @tparam     I       The implementation class
 517    * @SINCE_1_0.0
 518    * @param[in] internal Pointer to the Internal::CustomActor
 519    */
 520   template<typename I>
 521   DALI_INTERNAL void VerifyCustomActorPointer(Dali::Internal::CustomActor* internal)
 522   {
 523     // Can have a NULL pointer so we only need to check if the internal implementation is our class
 524     // when there is a value.
 525     if(internal)
 526     {
 527       DALI_ASSERT_DEBUG(dynamic_cast<I*>(&CustomActor(internal).GetImplementation()));
 528     }
 529   }
 530 };
 531
 532 /**
 533  * @}
 534  */
 535 } // namespace Toolkit
 536
 537 } // namespace Dali
 538
 539 #endif // DALI_TOOLKIT_CONTROL_H