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 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     | %Button method called       |
  81  * |------------------|-----------------------------|
  82  * | buttonClick      | %DoClickAction()            |
  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     enum
 106     {
 107       DISABLED = PROPERTY_START_INDEX, ///< name "disabled",                     @see SetDisabled(),                  type bool @SINCE_1_0.0
 108       AUTO_REPEATING,                  ///< name "autoRepeating",                @see SetAutoRepeating(),             type bool @SINCE_1_0.0
 109       INITIAL_AUTO_REPEATING_DELAY,    ///< name "initialAutoRepeatingDelay",    @see SetInitialAutoRepeatingDelay(), type float @SINCE_1_0.0
 110       NEXT_AUTO_REPEATING_DELAY,       ///< name "nextAutoRepeatingDelay",       @see SetNextAutoRepeatingDelay(),    type float @SINCE_1_0.0
 111       TOGGLABLE,                       ///< name "togglable",                    @see SetTogglableButton(),           type bool @SINCE_1_0.0
 112       SELECTED,                        ///< name "selected",                     @see SetSelected(),                  type bool @SINCE_1_0.0
 113       UNSELECTED_STATE_IMAGE,          ///< name "unselectedStateImage",         @see SetUnselectedImage(),           type std::string @SINCE_1_0.0
 114       SELECTED_STATE_IMAGE,            ///< name "selectedStateImage",           @see SetSelectedImage(),             type std::string @SINCE_1_0.0
 115       DISABLED_STATE_IMAGE,            ///< name "disabledStateImage",           @see SetDisabledImage(),             type std::string @SINCE_1_0.0
 116       UNSELECTED_COLOR,                ///< name "unselectedColor",                                                   type Vector4 @SINCE_1_0.0
 117       SELECTED_COLOR,                  ///< name "selectedColor",                                                     type Vector4 @SINCE_1_0.0
 118       LABEL,                           ///< name "label",                                                             type Property::Map @SINCE_1_0.0
 119
 120       // Deprecated properties:
 121       LABEL_TEXT,                      ///< name "labelText",                    @see SetLabelText(),                 type std::string @SINCE_1_0.0
 122     };
 123   };
 124
 125 public:
 126
 127   /**
 128    * @brief Create an uninitialized Button.
 129    *
 130    * Only derived versions can be instantiated.  Calling member
 131    * functions with an uninitialized Dali::Object is not allowed.
 132    * @SINCE_1_0.0
 133    */
 134   Button();
 135
 136   /**
 137    * @brief Copy constructor.
 138    * @SINCE_1_0.0
 139    */
 140   Button( const Button& button );
 141
 142   /**
 143    * @brief Assignment operator.
 144    * @SINCE_1_0.0
 145    */
 146   Button& operator=( const Button& button );
 147
 148   /**
 149    * @brief Downcast an Object handle to Button.
 150    *
 151    * If handle points to a Button the downcast produces valid
 152    * handle. If not the returned handle is left uninitialized.
 153    *
 154    * @SINCE_1_0.0
 155    * @param[in] handle Handle to an object
 156    * @return handle to a Button or an uninitialized handle
 157    */
 158   static Button DownCast( BaseHandle handle );
 159
 160   /**
 161    * @brief Destructor
 162    *
 163    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 164    * @SINCE_1_0.0
 165    */
 166   ~Button();
 167
 168   /**
 169    * @brief Sets the button as \e disabled.
 170    *
 171    * No signals are emitted when the \e disabled property is set.
 172    *
 173    * @SINCE_1_0.0
 174    * @param[in] disabled property.
 175    */
 176   void SetDisabled( bool disabled );
 177
 178   /**
 179    * @SINCE_1_0.0
 180    * @return \e true if the button is \e disabled.
 181    */
 182   bool IsDisabled() const;
 183
 184   /**
 185    * @brief Sets the \e autorepeating property.
 186    *
 187    * If the \e autorepeating property is set to \e true, then the \e togglable property is set to false
 188    * but no signal is emitted.
 189    *
 190    * @SINCE_1_0.0
 191    * @param[in] autoRepeating \e autorepeating property.
 192    */
 193   void SetAutoRepeating( bool autoRepeating );
 194
 195   /**
 196    * @SINCE_1_0.0
 197    * @return \e true if the \e autorepeating property is set.
 198    */
 199   bool IsAutoRepeating() const;
 200
 201   /**
 202    * @brief Sets the initial autorepeating delay.
 203    *
 204    * By default this value is set to 0.15 seconds.
 205    *
 206    * @SINCE_1_0.0
 207    * @param[in] initialAutoRepeatingDelay in seconds.
 208    * @pre initialAutoRepeatingDelay must be greater than zero.
 209    */
 210   void SetInitialAutoRepeatingDelay( float initialAutoRepeatingDelay );
 211
 212   /**
 213    * @SINCE_1_0.0
 214    * @return the initial autorepeating delay in seconds.
 215    */
 216   float GetInitialAutoRepeatingDelay() const;
 217
 218   /**
 219    * @brief Sets the next autorepeating delay.
 220    *
 221    * By default this value is set to 0.05 seconds.
 222    *
 223    * @SINCE_1_0.0
 224    * @param[in] nextAutoRepeatingDelay in seconds.
 225    * @pre nextAutoRepeatingDelay must be greater than zero.
 226    */
 227   void SetNextAutoRepeatingDelay( float nextAutoRepeatingDelay );
 228
 229   /**
 230    * @SINCE_1_0.0
 231    * @return the next autorepeating delay in seconds.
 232    */
 233   float GetNextAutoRepeatingDelay() const;
 234
 235   /**
 236    * @brief Sets the \e togglable property.
 237    *
 238    * If the \e togglable property is set to \e true, then the \e autorepeating property is set to false.
 239    *
 240    * @SINCE_1_0.0
 241    * @param[in] togglable property.
 242    */
 243   void SetTogglableButton( bool togglable );
 244
 245   /**
 246    * @SINCE_1_0.0
 247    * @return \e true if the \e togglable property is set.
 248    */
 249   bool IsTogglableButton() const;
 250
 251   /**
 252    * @brief Sets the button as selected or unselected.
 253    *
 254    * \e togglable property must be set to \e true.
 255    *
 256    * Emits a Button::StateChangedSignal() signal.
 257    *
 258    * @SINCE_1_0.0
 259    * @param[in] selected property.
 260    */
 261   void SetSelected( bool selected );
 262
 263   /**
 264    * @SINCE_1_0.0
 265    * @return \e true if the \e selected property is set and the button is togglable.
 266    */
 267   bool IsSelected() const;
 268
 269   /**
 270    * @brief Sets the animation time.
 271    *
 272    * @SINCE_1_0.0
 273    * @param[in] animationTime The animation time in seconds.
 274    */
 275   void SetAnimationTime( float animationTime );
 276
 277   /**
 278    * @brief Retrieves button's animation time.
 279    *
 280    * @SINCE_1_0.0
 281    * @return The animation time in seconds.
 282    */
 283   float GetAnimationTime() const;
 284
 285   /**
 286    * @brief Sets the button's label.
 287    *
 288    * @SINCE_1_0.0
 289    * @param[in] label The label text.
 290    */
 291   void SetLabelText( const std::string& label );
 292
 293   /**
 294    * @brief Gets the label.
 295    *
 296    * @SINCE_1_0.0
 297    * @return The label text.
 298    */
 299   std::string GetLabelText() const;
 300
 301   /**
 302    * @brief Sets the unselected button image.
 303    *
 304    * @SINCE_1_0.0
 305    * @param[in] filename The button image.
 306    */
 307   void SetUnselectedImage( const std::string& filename );
 308
 309   /**
 310    * @brief Sets the background image.
 311    *
 312    * @SINCE_1_0.0
 313    * @param[in] filename The background image.
 314    */
 315   void SetBackgroundImage( const std::string& filename );
 316
 317   /**
 318    * @brief Sets the selected image.
 319    *
 320    * @SINCE_1_0.0
 321    * @param[in] filename The selected image.
 322    */
 323   void SetSelectedImage( const std::string& filename );
 324
 325   /**
 326    * @brief Sets the selected background image.
 327    *
 328    * @SINCE_1_0.0
 329    * @param[in] filename The selected background image.
 330    */
 331   void SetSelectedBackgroundImage( const std::string& filename );
 332
 333   /**
 334    * @brief Sets the disabled background image.
 335    *
 336    * @SINCE_1_0.0
 337    * @param[in] filename The disabled background image.
 338    */
 339   void SetDisabledBackgroundImage( const std::string& filename );
 340
 341   /**
 342    * @brief Sets the disabled button image.
 343    *
 344    * @SINCE_1_0.0
 345    * @param[in] filename The disabled button image.
 346    */
 347   void SetDisabledImage( const std::string& filename );
 348
 349   /**
 350    * @brief Sets the disabled selected button image.
 351    *
 352    * @SINCE_1_0.0
 353    * @param[in] filename The disabled selected button image.
 354    */
 355   void SetDisabledSelectedImage( const std::string& filename );
 356
 357   // Deprecated API
 358
 359   /**
 360    * @deprecated DALi 1.0.50
 361    *
 362    * @brief Sets the label with an actor.
 363    *
 364    * @SINCE_1_0.0
 365    * @param[in]  label The actor to use as a label
 366    */
 367   void SetLabel( Actor label );
 368
 369   /**
 370    * @deprecated DALi 1.0.50
 371    *
 372    * @brief Sets the button image.
 373    *
 374    * @SINCE_1_0.0
 375    * @param[in]  image The button image.
 376    */
 377   void SetButtonImage( Image image );
 378
 379   /**
 380    * @deprecated DALi 1.0.50
 381    *
 382    * @brief Sets the selected image.
 383    *
 384    * @SINCE_1_0.0
 385    * @param[in]  image The selected image.
 386    */
 387   void SetSelectedImage( Image image );
 388
 389   /**
 390    * @deprecated DALi 1.0.50
 391    *
 392    * @brief Gets the button image.
 393    *
 394    * @SINCE_1_0.0
 395    * @return     An actor with the button image.
 396    */
 397   Actor GetButtonImage() const;
 398
 399   /**
 400    * @deprecated DALi 1.0.50
 401    *
 402    * @brief Gets the selected image.
 403    *
 404    * @SINCE_1_0.0
 405    * @return     An actor with the selected image.
 406    */
 407   Actor GetSelectedImage() const;
 408
 409 public: //Signals
 410
 411   /**
 412    * @brief Button signal type
 413    * @SINCE_1_0.0
 414    */
 415   typedef Signal< bool ( Button ) > ButtonSignalType;
 416
 417   /**
 418    * @brief This signal is emitted when the button is touched.
 419    *
 420    * A callback of the following type may be connected:
 421    * @code
 422    *   bool YourCallbackName( Button button );
 423    * @endcode
 424    * @SINCE_1_0.0
 425    * @return The signal to connect to.
 426    */
 427   ButtonSignalType& PressedSignal();
 428
 429   /**
 430    * @brief This signal is emitted when the button is touched and the touch point leaves the boundary of the button.
 431    *
 432    * A callback of the following type may be connected:
 433    * @code
 434    *   bool YourCallbackName( Button button );
 435    * @endcode
 436    * @SINCE_1_0.0
 437    * @return The signal to connect to.
 438    */
 439   ButtonSignalType& ReleasedSignal();
 440
 441   /**
 442    * @brief This signal is emitted when the button is touched and the touch point doesn't leave the boundary of the button.
 443    *
 444    * A callback of the following type may be connected:
 445    * @code
 446    *   bool YourCallbackName( Button button );
 447    * @endcode
 448    * @SINCE_1_0.0
 449    * @return The signal to connect to.
 450    */
 451   ButtonSignalType& ClickedSignal();
 452
 453   /**
 454    * @brief This signal is emitted when the button's state is changed.
 455    * The application can get the state by calling IsSelected().
 456    *
 457    * A callback of the following type may be connected:
 458    * @code
 459    *   bool YourCallbackName( Button button );
 460    * @endcode
 461    * @SINCE_1_0.0
 462    * @return The signal to connect to.
 463    */
 464   ButtonSignalType& StateChangedSignal();
 465
 466 public: // Not intended for application developers
 467
 468   /**
 469    * @brief Creates a handle using the Toolkit::Internal implementation.
 470    *
 471    * @SINCE_1_0.0
 472    * @param[in]  implementation  The Control implementation.
 473    */
 474   DALI_INTERNAL Button( Internal::Button& implementation );
 475
 476   /**
 477    * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
 478    *
 479    * @SINCE_1_0.0
 480    * @param[in]  internal  A pointer to the internal CustomActor.
 481    */
 482   DALI_INTERNAL Button( Dali::Internal::CustomActor* internal );
 483 };
 484
 485 /**
 486  * @}
 487  */
 488 } // namespace Toolkit
 489
 490 } // namespace Dali
 491
 492 #endif // __DALI_TOOLKIT_BUTTON_H__