dali-toolkit/internal/controls/buttons/button-impl.h

   1 #ifndef __DALI_TOOLKIT_INTERNAL_BUTTON_H__
   2 #define __DALI_TOOLKIT_INTERNAL_BUTTON_H__
   3
   4 //
   5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6 //
   7 // Licensed under the Flora License, Version 1.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://floralicense.org/license/
  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 // INTERNAL INCLUDES
  21 #include <dali/dali.h>
  22 #include <dali-toolkit/public-api/controls/buttons/button.h>
  23 #include <dali-toolkit/public-api/controls/control-impl.h>
  24 #include "button-painter-impl.h"
  25
  26 namespace Dali
  27 {
  28
  29 namespace Toolkit
  30 {
  31
  32 class Button;
  33
  34 namespace Internal
  35 {
  36
  37 /**
  38  * Button is the base class implementation for all buttons.
  39  */
  40 class Button : public ControlImpl
  41 {
  42 public:
  43
  44   // Properties
  45   enum
  46   {
  47     BUTTON_PROPERTY_START_INDEX = ControlImpl::CONTROL_PROPERTY_END_INDEX + 1,
  48     BUTTON_PROPERTY_END_INDEX = BUTTON_PROPERTY_START_INDEX + 1000 ///< Reserving 1000 property indices
  49   };
  50
  51 protected:
  52
  53   /**
  54    * Construct a new Button.
  55    */
  56   Button();
  57
  58   /**
  59    * A reference counted object may only be deleted by calling Unreference()
  60    */
  61   virtual ~Button();
  62
  63 public:
  64
  65   /**
  66    * @copydoc Dali::Toolkit::Button::SetDimmed( bool dimmed )
  67    */
  68   void SetDimmed( bool dimmed );
  69
  70   /**
  71    * @copydoc Dali::Toolkit::Button::IsDimmed() const
  72    */
  73   bool IsDimmed() const;
  74
  75   /**
  76    * @copydoc Dali::Toolkit::Button::SetAnimationTime()
  77    */
  78   void SetAnimationTime( float animationTime );
  79
  80   /**
  81    * @copydoc Dali::Toolkit::Button::GetAnimationTime()
  82    */
  83   float GetAnimationTime() const;
  84
  85 private:
  86
  87   /**
  88    * This method is called after the button initialization.
  89    * Could be reimplemented in subclasses to provide specific behaviour.
  90    */
  91   virtual void OnButtonInitialize() { }
  92
  93   /**
  94    * This method is called from the OnTouchEvent method when the button is down.
  95    * Could be reimplemented in subclasses to provide specific behaviour.
  96    */
  97   virtual void OnButtonDown() { }
  98
  99   /**
 100    * This method is called from the OnTouchEvent method when the button is up.
 101    * Could be reimplemented in subclasses to provide specific behaviour.
 102    */
 103   virtual void OnButtonUp() { }
 104
 105   /**
 106    * This method is called from the OnTouchEvent method when the touch point leaves the boundary of the button or
 107    * more than one touch points are received.
 108    * Could be reimplemented in subclasses to provide specific behaviour.
 109    */
 110   virtual void OnTouchPointLeave() { }
 111
 112   /**
 113    * This method is called from the OnTouchEvent method when the touch point is interrupted.
 114    * Could be reimplemented in subclasses to provide specific behaviour.
 115    */
 116   virtual void OnTouchPointInterrupted() { }
 117
 118   /**
 119    * This method is called when the animation time is set.
 120    * Needs to be reimplemented in subclasses to set the animation time in different buttons.
 121    * @param animationTime The animation time in seconds.
 122    */
 123   virtual void OnAnimationTimeSet( float animationTime );
 124
 125   /**
 126    * This method is called when the animation time is requested.
 127    * Needs to be reimplemented in subclases to return the animation time.
 128    * @return The animation time in seconds.
 129    */
 130   virtual float OnAnimationTimeRequested() const;
 131
 132 public:
 133
 134   /**
 135    * @copydoc Dali::Toolkit::Button::ClickedSignal()
 136    */
 137   Toolkit::Button::ClickedSignalV2& ClickedSignal();
 138
 139   /**
 140    * Connects a callback function with the object's signals.
 141    * @param[in] object The object providing the signal.
 142    * @param[in] tracker Used to disconnect the signal.
 143    * @param[in] signalName The signal to connect to.
 144    * @param[in] functor A newly allocated FunctorDelegate.
 145    * @return True if the signal was connected.
 146    * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
 147    */
 148   static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
 149
 150   // Properties
 151
 152   /**
 153    * Called when a property of an object of this type is set.
 154    * @param[in] object The object whose property is set.
 155    * @param[in] index The property index.
 156    * @param[in] value The new property value.
 157    */
 158   static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
 159
 160   /**
 161    * Called to retrieve a property of an object of this type.
 162    * @param[in] object The object whose property is to be retrieved.
 163    * @param[in] index The property index.
 164    * @return The current value of the property.
 165    */
 166   static Property::Value GetProperty( BaseObject* object, Property::Index propertyIndex );
 167
 168 protected: // From CustomActorImpl
 169
 170   /**
 171    * @copydoc Dali::CustomActorImpl::OnTouchEvent( const TouchEvent& event )
 172    */
 173   virtual bool OnTouchEvent( const TouchEvent& event );
 174
 175 private: // From ControlImpl
 176
 177   /**
 178    * @copydoc Toolkit::Control::OnInitialize()
 179    */
 180   virtual void OnInitialize();
 181
 182   /**
 183    * @copydoc Toolkit::Control::OnControlSizeSet( const Vector3& targetSize )
 184    */
 185   virtual void OnControlSizeSet( const Vector3& targetSize );
 186
 187 private:
 188
 189   /**
 190    * Handler for tap events.
 191    * We do not actually do anything when we receive a tap as the button handles tap event through
 192    * the touch event system itself as it requires more than just tap handling (e.g. leave events).
 193    * This stops any of our parents receiving a tap gesture when it occurs within our area.
 194    * @param[in]  actor  The tapped actor.
 195    * @param[in]  tap    The tap gesture.
 196    */
 197   void OnTap(Actor actor, TapGesture tap);
 198
 199 private:
 200
 201   /**
 202    * Callback received when the button is disconected from the stage.
 203    * It resets the button status.
 204    */
 205   void OnStageDisconnection();
 206
 207 private:
 208
 209   // Undefined
 210   Button( const Button& );
 211
 212   // Undefined
 213   Button& operator = ( const Button& );
 214
 215 protected: // Signals
 216
 217   enum ButtonState
 218   {
 219     ButtonUp,                         ///< The button is up.
 220     ButtonDown,                       ///< The button is down.
 221   };
 222
 223   ButtonState      mState;                ///< Stores the button state.
 224
 225   bool             mDimmed;               ///< Stores the dimmed property.
 226
 227   ButtonPainterPtr mPainter;              ///< Pointer to a ButtonPainter base class.
 228
 229   Toolkit::Button::ClickedSignalV2 mClickedSignalV2; ///< Signal emitted when the button is clicked.
 230
 231   TapGestureDetector mTapDetector;
 232 };
 233
 234 } // namespace Internal
 235
 236
 237 // Helpers for public-api forwarding methods
 238
 239 inline Toolkit::Internal::Button& GetImplementation( Toolkit::Button& button )
 240 {
 241   DALI_ASSERT_ALWAYS( button );
 242
 243   Dali::RefObject& handle = button.GetImplementation();
 244
 245   return static_cast<Toolkit::Internal::Button&>( handle );
 246 }
 247
 248 inline const Toolkit::Internal::Button& GetImplementation( const Toolkit::Button& button )
 249 {
 250   DALI_ASSERT_ALWAYS( button );
 251
 252   const Dali::RefObject& handle = button.GetImplementation();
 253
 254   return static_cast<const Toolkit::Internal::Button&>( handle );
 255 }
 256
 257 } // namespace Toolkit
 258
 259 } // namespace Dali
 260
 261 #endif // __DALI_TOOLKIT_INTERNAL_BUTTON_H__
 262