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

   1 #ifndef __DALI_TOOLKIT_INTERNAL_PUSH_BUTTON_PAINTER_H__
   2 #define __DALI_TOOLKIT_INTERNAL_PUSH_BUTTON_PAINTER_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 "button-painter-impl.h"
  23
  24 namespace Dali
  25 {
  26
  27 // Forward declarations
  28
  29 class Image;
  30
  31 namespace Toolkit
  32 {
  33
  34 // Forward declarations
  35
  36 class PushButton;
  37
  38 namespace Internal
  39 {
  40
  41 // Forward declarations
  42
  43 class PushButtonPainter;
  44
  45 /**
  46  * PushButtonPainter methods should be implemented in a subclass.
  47  */
  48 class PushButtonPainter : public ButtonPainter
  49 {
  50 public:
  51   /**
  52    * Destructor.
  53    *
  54    */
  55   virtual ~PushButtonPainter() {}
  56
  57   /**
  58    * This method is called from the Dali::Toolkit::Internal::PushButton when the
  59    * \e autorepeating property changes.
  60    * @param[in] autorepeating property.
  61    */
  62   virtual void SetAutoRepeating( bool autorepeating ) = 0;
  63
  64   /**
  65    * This method is called when the Dali::Toolkit::Internal::PushButton, in which this
  66    * object is registered, is pressed.
  67    * @param[inout] button The Dali::Toolkit::PushButton, linked to the internal
  68    * implementation, in which this object is registered.
  69    */
  70   virtual void Pressed( Toolkit::PushButton& button ) = 0;
  71
  72   /**
  73    * This method is called when the Dali::Toolkit::Internal::PushButton, in which this
  74    * object is registered, is released.
  75    * @param[inout] button The Dali::Toolkit::PushButton, linked to the internal
  76    * implementation, in which this object is registered.
  77    */
  78   virtual void Released( Toolkit::PushButton& button ) = 0;
  79
  80   /**
  81    * This method is called when the Dali::Toolkit::Internal::PushButton, in which this
  82    * object is registered, is clicked.
  83    * @param[inout] button The Dali::Toolkit::PushButton, linked to the internal
  84    * implementation, in which this object is registered.
  85    */
  86   virtual void Clicked( Toolkit::PushButton& button ) = 0;
  87
  88   /**
  89    * This method is called when the Dali::Toolkit::Internal::PushButton, in which this
  90    * object is registered, is toggled.
  91    * @param[inout] button The Dali::Toolkit::PushButton, linked to the internal
  92    * implementation, in which this object is registered.
  93    */
  94   virtual void Toggled( Toolkit::PushButton& button ) = 0;
  95
  96   /////////////////////////////////////////////////////////////////////////////
  97   // ButtonPainter interface
  98   /////////////////////////////////////////////////////////////////////////////
  99
 100   /**
 101    * @copydoc ButtonPainter::Initialize( Toolkit::Button& button )
 102    */
 103   virtual void Initialize( Toolkit::Button& button ) = 0;
 104
 105   /**
 106    * @copydoc ButtonPainter::SetSize( Toolkit::Button& button, const Vector3& size )
 107    */
 108   virtual void SetSize( Toolkit::Button& button, const Vector3& size ) = 0;
 109
 110   /**
 111    * @copydoc ButtonPainter::SetDisabled( Toolkit::Button& button, bool disabled )
 112    */
 113   virtual void SetDisabled( Toolkit::Button& button, bool disabled ) = 0;
 114
 115   /**
 116    * @copydoc ButtonPainter::SetAnimationTime()
 117    */
 118   virtual void SetAnimationTime( float animationTime ) = 0;
 119
 120   /**
 121    * @copydoc ButtonPainter::GetAnimationTime()
 122    */
 123   virtual float GetAnimationTime() const = 0;
 124 };
 125
 126 } // namespace Internal
 127
 128 } // namespace Toolkit
 129
 130 } // namespace Dali
 131
 132 #endif // __DALI_TOOLKIT_INTERNAL_PUSH_BUTTON_PAINTER_H__