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

   1 #ifndef __DALI_TOOLKIT_CONTROL_H__
   2 #define __DALI_TOOLKIT_CONTROL_H__
   3
   4 /*
   5  * Copyright (c) 2015 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/actors/custom-actor.h>
  23 #include <dali/public-api/common/dali-common.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 #include <dali/public-api/events/tap-gesture-detector.h>
  29 #include <dali/public-api/images/image.h>
  30
  31 namespace Dali
  32 {
  33
  34 namespace Toolkit
  35 {
  36
  37 //Forward declarations.
  38
  39 namespace Internal
  40 {
  41 class Control;
  42 }
  43 /**
  44  * @addtogroup dali_toolkit_controls
  45  * @{
  46  */
  47
  48 /**
  49  * @brief Control is the base class for all controls.
  50  *
  51  * The implementation of the control must be supplied; see Internal::Control for more details.
  52  * @SINCE_1_0.0
  53  * @see Internal::Control
  54  *
  55  * Signals
  56  * | %Signal Name           | Method                                              |
  57  * |------------------------|-----------------------------------------------------|
  58  * | keyEvent               | @ref KeyEventSignal()                               |
  59  * | keyInputFocusGained    | @ref KeyInputFocusGainedSignal()                    |
  60  * | keyInputFocusLost      | @ref KeyInputFocusLostSignal()                      |
  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_IMPORT_API Control : public CustomActor
  72 {
  73 public:
  74
  75   /**
  76    * @brief The start and end property ranges for control.
  77    * @SINCE_1_0.0
  78    */
  79   enum PropertyRange
  80   {
  81     PROPERTY_START_INDEX = PROPERTY_REGISTRATION_START_INDEX,        ///< Start index is used by the property registration macro. @SINCE_1_0.0
  82     CONTROL_PROPERTY_START_INDEX = PROPERTY_START_INDEX,             ///< Start index of Control properties. @SINCE_1_0.0
  83     CONTROL_PROPERTY_END_INDEX = CONTROL_PROPERTY_START_INDEX + 1000 ///< Reserving 1000 property indices. @SINCE_1_0.0
  84   };
  85
  86   /**
  87    * @brief An enumeration of properties belonging to the Control class.
  88    * @SINCE_1_0.0
  89    */
  90   struct Property
  91   {
  92     enum
  93     {
  94       /**
  95        * @brief name "styleName", type std::string
  96        * @SINCE_1_0.0
  97        * @see SetStyleName
  98        */
  99       STYLE_NAME = PROPERTY_START_INDEX,
 100       /**
 101        * @DEPRECATED_1_1.3
 102        * @brief name "background-color", mutually exclusive with BACKGROUND_IMAGE & BACKGROUND,  type Vector4
 103        * @SINCE_1_0.0
 104        * @see SetStyleName
 105        */
 106       BACKGROUND_COLOR,
 107       /**
 108        * @DEPRECATED_1_1.3
 109        * @brief name "background-image", mutually exclusive with BACKGROUND_COLOR & BACKGROUND,  type Map
 110        * @SINCE_1_0.0
 111        */
 112       BACKGROUND_IMAGE,
 113       /**
 114        * @brief name "keyInputFocus", type bool
 115        * @SINCE_1_0.0
 116        * @see SetKeyInputFocus
 117        */
 118       KEY_INPUT_FOCUS,
 119       /**
 120        * @brief name "background",       mutually exclusive with BACKGROUND_COLOR & BACKGROUND_IMAGE,                   type Map
 121        * @SINCE_1_1.3
 122        */
 123       BACKGROUND,
 124     };
 125   };
 126
 127   /**
 128    * @brief Describes the direction to move the keyboard focus towards.
 129    * @SINCE_1_0.0
 130    */
 131   struct KeyboardFocus
 132   {
 133     enum Direction
 134     {
 135       LEFT,   ///< Move keyboard focus towards the left direction @SINCE_1_0.0
 136       RIGHT,  ///< Move keyboard focus towards the right direction @SINCE_1_0.0
 137       UP,     ///< Move keyboard focus towards the up direction @SINCE_1_0.0
 138       DOWN    ///< Move keyboard focus towards the down direction @SINCE_1_0.0
 139     };
 140   };
 141
 142   // Typedefs
 143
 144   /// @brief Key Event signal type;
 145   typedef Signal<bool ( Control, const KeyEvent& ) > KeyEventSignalType;
 146
 147   /// @brief Key InputFocusType signal type;
 148   typedef Signal<void ( Control ) > KeyInputFocusSignalType;
 149
 150 public: // Creation & Destruction
 151
 152   /**
 153    * @brief Create a new instance of a Control.
 154    *
 155    * @SINCE_1_0.0
 156    * @return A handle to a new Control.
 157    */
 158   static Control New();
 159
 160   /**
 161    * @brief Create an uninitialized Control handle.
 162    *
 163    * Only derived versions can be instantiated.  Calling member
 164    * functions with an uninitialized Dali::Object is not allowed.
 165    * @SINCE_1_0.0
 166    */
 167   Control();
 168
 169   /**
 170    * @brief Copy constructor.
 171    *
 172    * Creates another handle that points to the same real object
 173    * @SINCE_1_0.0
 174    * @param[in] uiControl Handle to copy
 175    */
 176   Control(const Control& uiControl);
 177
 178   /**
 179    * @brief Dali::Control is intended as a base class
 180    *
 181    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 182    * @SINCE_1_0.0
 183    */
 184   ~Control();
 185
 186 public: // operators
 187
 188   /**
 189    * @brief Assignment operator.
 190    *
 191    * Changes this handle to point to another real object
 192    * @SINCE_1_0.0
 193    * @param[in] handle Object to assign this to
 194    * @return reference to this
 195    */
 196   Control& operator=( const Control& handle );
 197
 198 public:
 199
 200   /**
 201    * @brief Downcast an Object handle to Control.
 202    *
 203    * If handle points to a Control the downcast produces valid
 204    * handle. If not the returned handle is left uninitialized.
 205    *
 206    * @SINCE_1_0.0
 207    * @param[in] handle Handle to an object
 208    * @return handle to a Control or an uninitialized handle
 209    */
 210   static Control DownCast( BaseHandle handle );
 211
 212   // Key Input
 213
 214   /**
 215    * @brief This sets the control to receive key events.
 216    *
 217    * The key event can originate from a virtual or physical keyboard.
 218    * @SINCE_1_0.0
 219    * @return True if the control has foucs, False otherwise.
 220    * @pre The Control has been initialized.
 221    * @pre The Control should be on the stage before setting keyboard focus.
 222    */
 223   void SetKeyInputFocus();
 224
 225   /**
 226    * @brief Quries whether the control has key input focus.
 227    *
 228    * 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.
 229    * As the key input focus mechanism works like a stack, the top most control receives all the key events, and passes on the
 230    * unhandled events to the controls below in the stack. A control in the stack will regain key input focus when there are no more
 231    * controls above it in the focus stack.
 232    * To query for the conrol which is on top of the focus stack use Dali::Toolkit::KeyInputFocusManager::GetCurrentKeyboardFocusActor()
 233    * @SINCE_1_0.0
 234    * @return true if this control has keyboard input focus
 235    * @pre The Control has been initialized.
 236    * @pre The Control should be on the stage before setting keyboard focus.
 237    */
 238   bool HasKeyInputFocus();
 239
 240   /**
 241    * @brief Once an actor is Set to receive key input focus this function is called to stop it receiving key events.
 242    *
 243    * A check is performed to ensure it was previously set, if this check fails then nothing is done.
 244    * @SINCE_1_0.0
 245    * @pre The Actor has been initialized.
 246    */
 247   void ClearKeyInputFocus();
 248
 249   // Gesture Detection
 250
 251   /**
 252    * @brief Retrieves the pinch gesture detector of the control.
 253    *
 254    * @SINCE_1_0.0
 255    * @return The pinch gesture detector.
 256    * @note Will return an empty handle if the control does not handle the gesture itself.
 257    */
 258   PinchGestureDetector GetPinchGestureDetector() const;
 259
 260   /**
 261    * @brief Retrieves the pan gesture detector of the control.
 262    *
 263    * @SINCE_1_0.0
 264    * @return The pan gesture detector.
 265    * @note Will return an empty handle if the control does not handle the gesture itself.
 266    */
 267   PanGestureDetector GetPanGestureDetector() const;
 268
 269   /**
 270    * @brief Retrieves the tap gesture detector of the control.
 271    *
 272    * @SINCE_1_0.0
 273    * @return The tap gesture detector.
 274    * @note Will return an empty handle if the control does not handle the gesture itself.
 275    */
 276   TapGestureDetector GetTapGestureDetector() const;
 277
 278   /**
 279    * @brief Retrieves the long press gesture detector of the control.
 280    *
 281    * @SINCE_1_0.0
 282    * @return The long press gesture detector.
 283    * @note Will return an empty handle if the control does not handle the gesture itself.
 284    */
 285   LongPressGestureDetector GetLongPressGestureDetector() const;
 286
 287   // Styling
 288
 289   /**
 290    * @brief Sets the name of the style to be applied to the control.
 291    *
 292    * @SINCE_1_0.0
 293    * @param[in] styleName A string matching a style described in a stylesheet.
 294    */
 295   void SetStyleName( const std::string& styleName );
 296
 297   /**
 298    * @brief Retrieves the name of the style to be applied to the control (if any).
 299    * @SINCE_1_0.0
 300    * @return A string matching a style or an empty string.
 301    */
 302   const std::string& GetStyleName() const;
 303
 304   // Background
 305
 306   /**
 307    * @brief Sets the background color of the control.
 308    *
 309    * @SINCE_1_0.0
 310    * @param[in] color The required background color of the control
 311    *
 312    * @note if SetBackgroundImage is called later, this background color is removed.
 313    *
 314    * @note The background color fully blends with the actor color.
 315    */
 316   void SetBackgroundColor( const Vector4& color );
 317
 318   /**
 319    * @DEPRECATED_1_1.3
 320    *
 321    * @brief Retrieves the background color of the control.
 322    *
 323    * @SINCE_1_0.0
 324    * @return The background color of the control.
 325    */
 326   Vector4 GetBackgroundColor() const;
 327
 328   /**
 329    * @brief Sets an image as the background of the control.
 330    *
 331    * @SINCE_1_0.0
 332    * @param[in] image The image to set as the background.
 333    */
 334   void SetBackgroundImage( Image image );
 335
 336   /**
 337    * @brief Clears the background.
 338    * @SINCE_1_0.0
 339    */
 340   void ClearBackground();
 341
 342   // Signals
 343
 344   /**
 345    * @brief This signal is emitted when key event is received.
 346    *
 347    * A callback of the following type may be connected:
 348    * @code
 349    *   bool YourCallbackName(Control control, const KeyEvent& event);
 350    * @endcode
 351    * The return value of True, indicates that the event should be consumed.
 352    * Otherwise the signal will be emitted on the next parent of the actor.
 353    * @SINCE_1_0.0
 354    * @return The signal to connect to.
 355    * @pre The Control has been initialized.
 356    */
 357   KeyEventSignalType& KeyEventSignal();
 358
 359   /**
 360    * @brief This signal is emitted when the control gets Key Input Focus
 361    *
 362    * A callback of the following type may be connected:
 363    * @code
 364    *   bool YourCallbackName( Control control );
 365    * @endcode
 366    * The return value of True, indicates that the event should be consumed.
 367    * Otherwise the signal will be emitted on the next parent of the actor.
 368    * @SINCE_1_0.0
 369    * @return The signal to connect to.
 370    * @pre The Control has been initialized.
 371    */
 372   KeyInputFocusSignalType& KeyInputFocusGainedSignal();
 373
 374   /**
 375    * @brief This signal is emitted when the control loses Key Input Focus
 376    * which could be due to it being gained by another Control or Actor or just cleared from
 377    * this control as no longer required.
 378    *
 379    * A callback of the following type may be connected:
 380    * @code
 381    *   bool YourCallbackName( Control control );
 382    * @endcode
 383    * The return value of True, indicates that the event should be consumed.
 384    * Otherwise the signal will be emitted on the next parent of the actor.
 385    * @SINCE_1_0.0
 386    * @return The signal to connect to.
 387    * @pre The Control has been initialized.
 388    */
 389   KeyInputFocusSignalType& KeyInputFocusLostSignal();
 390
 391 public: // Intended for control developers
 392
 393   /**
 394    * @brief Create an initialised Control.
 395    *
 396    * @SINCE_1_0.0
 397    * @param[in] implementation The implementation for this control.
 398    * @return A handle to a newly allocated Dali resource.
 399    *
 400    * @note Should NOT be called to create a handle from the implementation. As stated, this allocates a NEW Dali resource.
 401    */
 402   explicit Control(Internal::Control& implementation);
 403
 404   /**
 405    * @brief This constructor is used by CustomActor within Dali core to create additional Control handles
 406    * using an Internal CustomActor pointer.
 407    *
 408    * @SINCE_1_0.0
 409    * @param [in] internal A pointer to a newly allocated Dali resource
 410    */
 411   explicit Control(Dali::Internal::CustomActor* internal);
 412
 413 public: // Templates for Deriving Classes
 414
 415   /**
 416    * @brief Template to allow deriving controls to DownCast handles to deriving handle classes.
 417    *
 418    * @tparam     T       The handle class
 419    * @tparam     I       The implementation class
 420    * @SINCE_1_0.0
 421    * @param[in]  handle  Handle to an object
 422    * @return Handle to a class T or an uninitialized handle.
 423    * @see DownCast(BaseHandle)
 424    */
 425   template<typename T, typename I>
 426   DALI_INTERNAL static T DownCast( BaseHandle handle )
 427   {
 428     T result;
 429
 430     CustomActor custom = Dali::CustomActor::DownCast( handle );
 431     if ( custom )
 432     {
 433       CustomActorImpl& customImpl = custom.GetImplementation();
 434
 435       I* impl = dynamic_cast<I*>(&customImpl);
 436
 437       if (impl)
 438       {
 439         result = T(customImpl.GetOwner());
 440       }
 441     }
 442
 443     return result;
 444   }
 445
 446   /**
 447    * @brief Template to allow deriving controls to verify whether the Internal::CustomActor* is actually an
 448    * implementation of their class.
 449    *
 450    * @tparam     I         The implementation class
 451    * @SINCE_1_0.0
 452    * @param[in]  internal  Pointer to the Internal::CustomActor
 453    */
 454   template<typename I>
 455   DALI_INTERNAL void VerifyCustomActorPointer(Dali::Internal::CustomActor* internal)
 456   {
 457     // Can have a NULL pointer so we only need to check if the internal implementation is our class
 458     // when there is a value.
 459     if (internal)
 460     {
 461       DALI_ASSERT_DEBUG(dynamic_cast<I*>(&CustomActor(internal).GetImplementation()));
 462     }
 463   }
 464
 465 };
 466
 467 /**
 468  * @}
 469  */
 470 } // namespace Toolkit
 471
 472 } // namespace Dali
 473
 474 #endif // __DALI_TOOLKIT_CONTROL_H__