dali-toolkit/public-api/controls/buttons/button.h

   1 #ifndef __DALI_TOOLKIT_BUTTON_H__
   2 #define __DALI_TOOLKIT_BUTTON_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 // INTERNAL INCLUDES
  22 #include <dali-toolkit/public-api/controls/control.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Toolkit
  28 {
  29
  30 namespace Internal DALI_INTERNAL
  31 {
  32 class Button;
  33 }
  34 /**
  35  * @addtogroup dali_toolkit_controls_buttons
  36  * @{
  37  */
  38
  39 /**
  40  * @brief Button is a base class for different kind of buttons.
  41  *
  42  * This class provides the disabled property and the clicked signal.
  43  *
  44  * A ClickedSignal() is emitted when the button is touched and the touch point doesn't leave the boundary of the button.
  45  *
  46  * When the \e disabled property is set to \e true, no signal is emitted.
  47  *
  48  * Button provides the following properties which modify the signals emitted:
  49  * <ul>
  50  *   <li>\e autorepeating
  51  *       When \e autorepeating is set to \e true, a Button::PressedSignal(), Button::ReleasedSignal() and Button::ClickedSignal() signals are emitted at regular
  52  *       intervals while the button is touched.
  53  *       The intervals could be modified with the Button::SetInitialAutoRepeatingDelay and Button::SetNextAutoRepeatingDelay methods.
  54  *
  55  *       A \e togglable button can't be \e autorepeating. If the \e autorepeating property is set to \e true, then the \e togglable property is set to
  56  *       false but no signal is emitted.
  57  *
  58  *   <li>\e togglable
  59  *       When \e togglable is set to \e true, a Button::StateChangedSignal() signal is emitted, with the selected state.
  60  * </ul>
  61  *
  62  * The button's appearance can be modified by setting properties for the various image filenames.
  63  *
  64  * The \e background is always shown and doesn't change if the button is pressed or released. The \e button image is shown over the \e background image when the
  65  * button is not pressed and is replaced by the \e selected image when the button is pressed. The text label is placed always on the top of all images.
  66  *
  67  * When the button is disabled, \e background, \e button and \e selected images are replaced by their \e disabled images.
  68  *
  69  * Is not mandatory to set all images. A button could be defined only by setting its \e background image or by setting its \e background and \e selected images.
  70  *
  71  * Signals
  72  * | %Signal Name     | Method                      |
  73  * |------------------|-----------------------------|
  74  * | pressed          | @ref PressedSignal()        |
  75  * | released         | @ref ReleasedSignal()       |
  76  * | clicked          | @ref ClickedSignal()        |
  77  * | stateChanged     | @ref StateChangedSignal()   |
  78  *
  79  * Actions
  80  * | %Action Name     | Attributes              | Description                                   |
  81  * |------------------|-------------------------|-----------------------------------------------|
  82  * | buttonClick      | Doesn't have attributes | Simulates a button click. See @ref DoAction() |
  83  * @SINCE_1_0.0
  84  */
  85 class DALI_IMPORT_API Button : public Control
  86 {
  87 public:
  88
  89   /**
  90    * @brief The start and end property ranges for this control.
  91    * @SINCE_1_0.0
  92    */
  93   enum PropertyRange
  94   {
  95     PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< @SINCE_1_0.0
  96     PROPERTY_END_INDEX =   PROPERTY_START_INDEX + 1000              ///< Reserve property indices @SINCE_1_0.0
  97   };
  98
  99   /**
 100    * @brief An enumeration of properties belonging to the Button class.
 101    * @SINCE_1_0.0
 102    */
 103   struct Property
 104   {
 105     /**
 106      * @brief An enumeration of properties belonging to the Button class.
 107      * @SINCE_1_0.0
 108      */
 109     enum
 110     {
 111       DISABLED = PROPERTY_START_INDEX, ///< name "disabled",                     @see SetDisabled(),                  type bool @SINCE_1_0.0
 112       AUTO_REPEATING,                  ///< name "autoRepeating",                @see SetAutoRepeating(),             type bool @SINCE_1_0.0
 113       INITIAL_AUTO_REPEATING_DELAY,    ///< name "initialAutoRepeatingDelay",    @see SetInitialAutoRepeatingDelay(), type float @SINCE_1_0.0
 114       NEXT_AUTO_REPEATING_DELAY,       ///< name "nextAutoRepeatingDelay",       @see SetNextAutoRepeatingDelay(),    type float @SINCE_1_0.0
 115       TOGGLABLE,                       ///< name "togglable",                    @see SetTogglableButton(),           type bool @SINCE_1_0.0
 116       SELECTED,                        ///< name "selected",                     @see SetSelected(),                  type bool @SINCE_1_0.0
 117       UNSELECTED_STATE_IMAGE,          ///< name "unselectedStateImage",         @see SetUnselectedImage(),           type std::string @SINCE_1_0.0
 118       SELECTED_STATE_IMAGE,            ///< name "selectedStateImage",           @see SetSelectedImage(),             type std::string @SINCE_1_0.0
 119       DISABLED_STATE_IMAGE,            ///< name "disabledStateImage",           @see SetDisabledImage(),             type std::string @SINCE_1_0.0
 120       UNSELECTED_COLOR,                ///< name "unselectedColor",                                                   type Vector4 @SINCE_1_0.0
 121       SELECTED_COLOR,                  ///< name "selectedColor",                                                     type Vector4 @SINCE_1_0.0
 122       LABEL,                           ///< name "label",                                                             type Property::Map @SINCE_1_0.0
 123
 124       // Deprecated properties:
 125       LABEL_TEXT,                      ///< name "labelText",                    @see SetLabelText(),                 type std::string @SINCE_1_0.0
 126     };
 127   };
 128
 129 public:
 130
 131   /**
 132    * @brief Create an uninitialized Button.
 133    *
 134    * Only derived versions can be instantiated.  Calling member
 135    * functions with an uninitialized Dali::Object is not allowed.
 136    * @SINCE_1_0.0
 137    */
 138   Button();
 139
 140   /**
 141    * @brief Copy constructor.
 142    * @SINCE_1_0.0
 143    * @param[in] button Handle to an object
 144    */
 145   Button( const Button& button );
 146
 147   /**
 148    * @brief Assignment operator.
 149    * @SINCE_1_0.0
 150    * @param[in] button Handle to an object
 151    * @return A reference to this
 152    */
 153   Button& operator=( const Button& button );
 154
 155   /**
 156    * @brief Downcast a handle to Button handle.
 157    *
 158    * If handle points to a Button the downcast produces valid
 159    * handle. If not the returned handle is left uninitialized.
 160    *
 161    * @SINCE_1_0.0
 162    * @param[in] handle Handle to an object
 163    * @return A handle to a Button or an uninitialized handle
 164    */
 165   static Button DownCast( BaseHandle handle );
 166
 167   /**
 168    * @brief Destructor
 169    *
 170    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 171    * @SINCE_1_0.0
 172    */
 173   ~Button();
 174
 175   // Deprecated API
 176
 177   /**
 178    * @DEPRECATED_1_1.32 Use SetProperty DISABLED or Styling file
 179    *
 180    * @brief Sets the button as \e disabled.
 181    *
 182    * No signals are emitted when the \e disabled property is set.
 183    *
 184    * @SINCE_1_0.0
 185    * @param[in] disabled property.
 186    */
 187   void SetDisabled( bool disabled );
 188
 189   /**
 190    * @DEPRECATED_1_1.32 Use GetProperty DISABLED
 191    *
 192    * @brief Returns if the button is disabled.
 193    * @SINCE_1_0.0
 194    * @return \e true if the button is \e disabled.
 195    */
 196   bool IsDisabled() const;
 197
 198   /**
 199    * @DEPRECATED_1_1.32 SetProperty AUTO_REPEATING or Styling file
 200    *
 201    * @brief Sets the \e autorepeating property.
 202    *
 203    * If the \e autorepeating property is set to \e true, then the \e togglable property is set to false
 204    * but no signal is emitted.
 205    *
 206    * @SINCE_1_0.0
 207    * @param[in] autoRepeating \e autorepeating property.
 208    */
 209   void SetAutoRepeating( bool autoRepeating );
 210
 211   /**
 212    * @DEPRECATED_1_1.32 GetProperty AUTO_REPEATING
 213    *
 214    * @brief Returns if the autorepeating property is set.
 215    * @SINCE_1_0.0
 216    * @return \e true if the \e autorepeating property is set.
 217    */
 218   bool IsAutoRepeating() const;
 219
 220   /**
 221    * @DEPRECATED_1_1.32 SetProperty INITIAL_AUTO_REPEATING_DELAY or Styling file
 222    *
 223    * @brief Sets the initial autorepeating delay.
 224    *
 225    * By default this value is set to 0.15 seconds.
 226    *
 227    * @SINCE_1_0.0
 228    * @param[in] initialAutoRepeatingDelay in seconds.
 229    * @pre initialAutoRepeatingDelay must be greater than zero.
 230    */
 231   void SetInitialAutoRepeatingDelay( float initialAutoRepeatingDelay );
 232
 233   /**
 234    * @DEPRECATED_1_1.32 GetProperty INITIAL_AUTO_REPEATING_DELAY
 235    *
 236    * @brief Gets the initial autorepeating delay in seconds.
 237    * @SINCE_1_0.0
 238    * @return the initial autorepeating delay in seconds.
 239    */
 240   float GetInitialAutoRepeatingDelay() const;
 241
 242   /**
 243    * @DEPRECATED_1_1.32 SetProperty NEXT_AUTO_REPEATING_DELAY or Styling file
 244    *
 245    * @brief Sets the next autorepeating delay.
 246    *
 247    * By default this value is set to 0.05 seconds.
 248    *
 249    * @SINCE_1_0.0
 250    * @param[in] nextAutoRepeatingDelay in seconds.
 251    * @pre nextAutoRepeatingDelay must be greater than zero.
 252    */
 253   void SetNextAutoRepeatingDelay( float nextAutoRepeatingDelay );
 254
 255   /**
 256    * @DEPRECATED_1_1.32 GetProperty NEXT_AUTO_REPEATING_DELAY
 257    *
 258    * @brief Gets the next autorepeating delay in seconds.
 259    * @SINCE_1_0.0
 260    * @return the next autorepeating delay in seconds.
 261    */
 262   float GetNextAutoRepeatingDelay() const;
 263
 264   /**
 265    * @DEPRECATED_1_1.32 SetProperty TOGGLABLE or Styling file
 266    *
 267    * @brief Sets the \e togglable property.
 268    *
 269    * If the \e togglable property is set to \e true, then the \e autorepeating property is set to false.
 270    *
 271    * @SINCE_1_0.0
 272    * @param[in] togglable property.
 273    */
 274   void SetTogglableButton( bool togglable );
 275
 276   /**
 277    * @DEPRECATED_1_1.32 GetProperty TOGGLABLE
 278    *
 279    * @brief Returns if the togglable property is set.
 280    * @SINCE_1_0.0
 281    * @return \e true if the \e togglable property is set.
 282    */
 283   bool IsTogglableButton() const;
 284
 285   /**
 286    * @DEPRECATED_1_1.32 SetProperty SELECTED
 287    *
 288    * @brief Sets the button as selected or unselected.
 289    *
 290    * \e togglable property must be set to \e true.
 291    *
 292    * Emits a Button::StateChangedSignal() signal.
 293    *
 294    * @SINCE_1_0.0
 295    * @param[in] selected property.
 296    */
 297   void SetSelected( bool selected );
 298
 299   /**
 300    * DEPRECATED_1_1.32  SetProperty SELECTED
 301    *
 302    * @brief Returns if the selected property is set and the button is togglable.
 303    * @SINCE_1_0.0
 304    * @return \e true if the button is \e selected.
 305    */
 306   bool IsSelected() const;
 307
 308   /**
 309    * @DEPRECATED_1_1.32 Use Styling file to set animation
 310    *
 311    * @brief Sets the animation time.
 312    *
 313    * @SINCE_1_0.0
 314    * @param[in] animationTime The animation time in seconds.
 315    */
 316   void SetAnimationTime( float animationTime );
 317
 318   /**
 319    * DEPRECATED_1_1.32 Use Styling file to set animation
 320    *
 321    * @brief Retrieves button's animation time.
 322    *
 323    * @SINCE_1_0.0
 324    * @return The animation time in seconds.
 325    */
 326   float GetAnimationTime() const;
 327
 328   /**
 329    * @DEPRECATED_1_1.32 SetProperty LABEL or Styling file
 330    *
 331    * @brief Sets the button's label.
 332    *
 333    * @SINCE_1_0.0
 334    * @param[in] label The label text.
 335    */
 336   void SetLabelText( const std::string& label );
 337
 338   /**
 339    * DEPRECATED_1_1.32 GetProperty LABEL
 340    *
 341    * @brief Gets the label.
 342    *
 343    * @SINCE_1_0.0
 344    * @return The label text.
 345    */
 346   std::string GetLabelText() const;
 347
 348   /**
 349    * @DEPRECATED_1_1.32 Use Styling file
 350    *
 351    * @brief Sets the unselected button image.
 352    *
 353    * @SINCE_1_0.0
 354    * @param[in] filename The button image.
 355    */
 356   void SetUnselectedImage( const std::string& filename );
 357
 358   /**
 359    * @DEPRECATED_1_1.32 Use styling
 360    *
 361    * @brief Sets the background image.
 362    *
 363    * @SINCE_1_0.0
 364    * @param[in] filename The background image.
 365    */
 366   void SetBackgroundImage( const std::string& filename );
 367
 368   /**
 369    * @DEPRECATED_1_1.32 Use styling file
 370    *
 371    * @brief Sets the selected image.
 372    *
 373    * @SINCE_1_0.0
 374    * @param[in] filename The selected image.
 375    */
 376   void SetSelectedImage( const std::string& filename );
 377
 378   /**
 379    * @DEPRECATED_1_1.32 Use styling file
 380    *
 381    * @brief Sets the selected background image.
 382    *
 383    * @SINCE_1_0.0
 384    * @param[in] filename The selected background image.
 385    */
 386   void SetSelectedBackgroundImage( const std::string& filename );
 387
 388   /**
 389    * @DEPRECATED_1_1.32 Use styling file
 390    *
 391    * @brief Sets the disabled background image.
 392    *
 393    * @SINCE_1_0.0
 394    * @param[in] filename The disabled background image.
 395    */
 396   void SetDisabledBackgroundImage( const std::string& filename );
 397
 398   /**
 399    * @DEPRECATED_1_1.32 Use styling file
 400    *
 401    * @brief Sets the disabled button image.
 402    *
 403    * @SINCE_1_0.0
 404    * @param[in] filename The disabled button image.
 405    */
 406   void SetDisabledImage( const std::string& filename );
 407
 408   /**
 409    * @DEPRECATED_1_1.32 Use styling file
 410    *
 411    * @brief Sets the disabled selected button image.
 412    *
 413    * @SINCE_1_0.0
 414    * @param[in] filename The disabled selected button image.
 415    */
 416   void SetDisabledSelectedImage( const std::string& filename );
 417
 418   /**
 419    * @DEPRECATED_1_0.50. Instead, use SetLabelText.
 420    *
 421    * @brief Sets the label with an actor.
 422    *
 423    * @SINCE_1_0.0
 424    * @param[in]  label The actor to use as a label
 425    */
 426   void SetLabel( Actor label );
 427
 428   /**
 429    * @DEPRECATED_1_0.50. Instead, use SetUnselectedImage.
 430    *
 431    * @brief Sets the button image.
 432    *
 433    * @SINCE_1_0.0
 434    * @param[in]  image The button image.
 435    */
 436   void SetButtonImage( Image image );
 437
 438   /**
 439    * @DEPRECATED_1_0.50. Instead, use SetSelectedImage( const std::string& filename ).
 440    *
 441    * @brief Sets the selected image.
 442    *
 443    * @SINCE_1_0.0
 444    * @param[in]  image The selected image.
 445    */
 446   void SetSelectedImage( Image image );
 447
 448   /**
 449    * @DEPRECATED_1_0.50
 450    *
 451    * @brief Gets the button image.
 452    *
 453    * @SINCE_1_0.0
 454    * @remarks Avoid using this method as it's a legacy code.
 455    * @return     An actor with the button image.
 456    */
 457   Actor GetButtonImage() const;
 458
 459   /**
 460    * @DEPRECATED_1_0.50
 461    *
 462    * @brief Gets the selected image.
 463    *
 464    * @SINCE_1_0.0
 465    * @remarks Avoid using this method as it's a legacy code.
 466    * @return     An actor with the selected image.
 467    */
 468   Actor GetSelectedImage() const;
 469
 470 public: //Signals
 471
 472   /**
 473    * @brief Button signal type
 474    * @SINCE_1_0.0
 475    */
 476   typedef Signal< bool ( Button ) > ButtonSignalType;
 477
 478   /**
 479    * @brief This signal is emitted when the button is touched.
 480    *
 481    * A callback of the following type may be connected:
 482    * @code
 483    *   bool YourCallbackName( Button button );
 484    * @endcode
 485    * @SINCE_1_0.0
 486    * @return The signal to connect to.
 487    */
 488   ButtonSignalType& PressedSignal();
 489
 490   /**
 491    * @brief This signal is emitted when the button is touched and the touch point leaves the boundary of the button.
 492    *
 493    * A callback of the following type may be connected:
 494    * @code
 495    *   bool YourCallbackName( Button button );
 496    * @endcode
 497    * @SINCE_1_0.0
 498    * @return The signal to connect to.
 499    */
 500   ButtonSignalType& ReleasedSignal();
 501
 502   /**
 503    * @brief This signal is emitted when the button is touched and the touch point doesn't leave the boundary of the button.
 504    *
 505    * A callback of the following type may be connected:
 506    * @code
 507    *   bool YourCallbackName( Button button );
 508    * @endcode
 509    * @SINCE_1_0.0
 510    * @return The signal to connect to.
 511    */
 512   ButtonSignalType& ClickedSignal();
 513
 514   /**
 515    * @brief This signal is emitted when the button's state is changed.
 516    *
 517    * The application can get the state by calling IsSelected().
 518    *
 519    * A callback of the following type may be connected:
 520    * @code
 521    *   bool YourCallbackName( Button button );
 522    * @endcode
 523    * @SINCE_1_0.0
 524    * @return The signal to connect to.
 525    */
 526   ButtonSignalType& StateChangedSignal();
 527
 528 public: // Not intended for application developers
 529
 530   /// @cond internal
 531   /**
 532    * @brief Creates a handle using the Toolkit::Internal implementation.
 533    *
 534    * @SINCE_1_0.0
 535    * @param[in]  implementation  The Control implementation.
 536    */
 537   DALI_INTERNAL Button( Internal::Button& implementation );
 538
 539   /**
 540    * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
 541    *
 542    * @SINCE_1_0.0
 543    * @param[in]  internal  A pointer to the internal CustomActor.
 544    */
 545   DALI_INTERNAL Button( Dali::Internal::CustomActor* internal );
 546   /// @endcond
 547 };
 548
 549 /**
 550  * @}
 551  */
 552 } // namespace Toolkit
 553
 554 } // namespace Dali
 555
 556 #endif // __DALI_TOOLKIT_BUTTON_H__