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