base/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) 2014 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 DALI_IMPORT_API
  25 {
  26
  27 namespace Internal DALI_INTERNAL
  28 {
  29 class CustomActor;
  30 }
  31
  32 namespace Toolkit
  33 {
  34
  35 namespace Internal DALI_INTERNAL
  36 {
  37 class Button;
  38 }
  39
  40 /**
  41  * @brief Button is a base class for different kind of buttons.
  42  *
  43  * This class provides the dimmed property and the clicked signal.
  44  *
  45  * A ClickedSignal() is emitted when the button is touched and the touch
  46  * point doesn't leave the boundary of the button.
  47  *
  48  * When the \e dimmed property is set to \e true, no signal is emitted.
  49  */
  50 class Button : public Control
  51 {
  52 public:
  53
  54   // Signal Names
  55   static const char* const SIGNAL_CLICKED; ///< name "clicked"
  56   static const char* const SIGNAL_TOGGLED; ///< name "toggled"
  57
  58   // Properties
  59   static const Property::Index PROPERTY_DIMMED; ///< name "dimmed", @see SetDimmed(), type BOOLEAN
  60
  61 public:
  62
  63   /**
  64    * @brief Create an uninitialized Button.
  65    *
  66    * Only derived versions can be instantiated.  Calling member
  67    * functions with an uninitialized Dali::Object is not allowed.
  68    */
  69   Button();
  70
  71   /**
  72    * @brief Copy constructor.
  73    */
  74   Button( const Button& button );
  75
  76   /**
  77    * @brief Assignment operator.
  78    */
  79   Button& operator=( const Button& button );
  80
  81   /**
  82    * @brief Downcast an Object handle to Button.
  83    *
  84    * If handle points to a Button the downcast produces valid
  85    * handle. If not the returned handle is left uninitialized.
  86    *
  87    * @param[in] handle Handle to an object
  88    * @return handle to a Button or an uninitialized handle
  89    */
  90   static Button DownCast( BaseHandle handle );
  91
  92   /**
  93    * @brief Destructor
  94    *
  95    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  96    */
  97   ~Button();
  98
  99   /**
 100    * @brief Sets the button as \e dimmed.
 101    *
 102    * No signals are emitted when the \e dimmed property is set.
 103    *
 104    * @param[in] dimmed property.
 105    */
 106   void SetDimmed( bool dimmed );
 107
 108   /**
 109    * @return \e true if the button is \e dimmed.
 110    */
 111   bool IsDimmed() const;
 112
 113   /**
 114    * @brief Sets the animation time.
 115    *
 116    * @param [in] animationTime The animation time in seconds.
 117    */
 118   void SetAnimationTime( float animationTime );
 119
 120   /**
 121    * @brief Retrieves button's animation time.
 122    *
 123    * @return The animation time in seconds.
 124    */
 125   float GetAnimationTime() const;
 126
 127 public: //Signals
 128
 129   /**
 130    * @brief Button Clicked signal type
 131    */
 132   typedef SignalV2< bool ( Button ) > ClickedSignalV2;
 133
 134   /**
 135    * @brief Button toggled signal type
 136    */
 137   typedef SignalV2< bool ( Button, bool ) > ToggledSignalV2;
 138
 139   /**
 140    * @brief Signal emitted when the button is touched and the touch point doesn't leave the boundary of the button.
 141    */
 142   ClickedSignalV2& ClickedSignal();
 143
 144   /**
 145    * @brief Signal emitted when the button's state is toggled.
 146    */
 147   ToggledSignalV2& ToggledSignal();
 148
 149 public: // Not intended for application developers
 150
 151   /**
 152    * @brief Creates a handle using the Toolkit::Internal implementation.
 153    *
 154    * @param[in]  implementation  The Control implementation.
 155    */
 156   Button( Internal::Button& implementation );
 157
 158   /**
 159    * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
 160    *
 161    * @param[in]  internal  A pointer to the internal CustomActor.
 162    */
 163   Button( Dali::Internal::CustomActor* internal );
 164 };
 165
 166 } // namespace Toolkit
 167
 168 } // namespace Dali
 169
 170 #endif // __DALI_TOOLKIT_BUTTON_H__