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

   1 #ifndef DALI_TOOLKIT_INTERNAL_PUSH_BUTTON_H
   2 #define DALI_TOOLKIT_INTERNAL_PUSH_BUTTON_H
   3
   4 /*
   5  * Copyright (c) 2019 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 // EXTERNAL INCLUDES
  22 #include <dali/public-api/common/vector-wrapper.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali-toolkit/public-api/controls/buttons/push-button.h>
  26 #include "button-impl.h"
  27
  28 namespace Dali
  29 {
  30
  31 namespace Toolkit
  32 {
  33
  34 namespace Internal
  35 {
  36
  37 /**
  38  * PushButton implementation class.
  39  *
  40  * \sa Dali::Toolkit::PushButton
  41  */
  42 class PushButton : public Button
  43 {
  44 public:
  45
  46   /**
  47    * Create a new PushButton.
  48    * @return A smart-pointer to the newly allocated PushButton.
  49    */
  50   static Dali::Toolkit::PushButton New();
  51
  52 protected:
  53
  54   /**
  55    * Construct a new PushButton.
  56    */
  57   PushButton();
  58
  59   /**
  60    * A reference counted object may only be deleted by calling Unreference()
  61    */
  62   virtual ~PushButton();
  63
  64 public:
  65
  66   // Properties
  67
  68   /**
  69    * Enum for the alignment modes of the icon.
  70    */
  71   enum IconAlignment
  72   {
  73     LEFT,
  74     RIGHT,
  75     TOP,
  76     BOTTOM,
  77     DEFAULT = RIGHT
  78   };
  79
  80   /**
  81    * Called when a property of an object of this type is set.
  82    * @param[in] object The object whose property is set.
  83    * @param[in] index The property index.
  84    * @param[in] value The new property value.
  85    */
  86   static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
  87
  88   /**
  89    * Called to retrieve a property of an object of this type.
  90    * @param[in] object The object whose property is to be retrieved.
  91    * @param[in] index The property index.
  92    * @return The current value of the property.
  93    */
  94   static Property::Value GetProperty( BaseObject* object, Property::Index propertyIndex );
  95
  96   /**
  97    * Deprecated API for Setting Pushbutton image using an Actor
  98    * @param[in] image, Image Actor that has a url which can be used to create an image visual
  99    */
 100   void SetButtonImage( Actor image );
 101
 102   /**
 103    * Deprecated API for Setting Pushbutton image using an Actor
 104    * @param[in] image, Image Actor that has a url which can be used to create an image visual
 105    */
 106   void SetBackgroundImage( Actor image );
 107
 108   /**
 109    * Deprecated API for Setting Pushbutton image using an Actor
 110    * @param[in] image, Image Actor that has a url which can be used to create an image visual
 111    */
 112   void SetSelectedImage( Actor image );
 113
 114   /**
 115    * Deprecated API for Setting Pushbutton image using an Actor
 116    * @param[in] image, Image Actor that has a url which can be used to create an image visual
 117    */
 118   void SetSelectedBackgroundImage( Actor image );
 119
 120   /**
 121    * Deprecated API for Setting Pushbutton image using an Actor
 122    * @param[in] image, Image Actor that has a url which can be used to create an image visual
 123    */
 124   void SetDisabledBackgroundImage( Actor image );
 125
 126   /**
 127    * Deprecated API for Setting Pushbutton image using an Actor
 128    * @param[in] image, Image Actor that has a url which can be used to create an image visual
 129    */
 130   void SetDisabledImage( Actor image );
 131
 132   /**
 133    * Deprecated API for Setting Pushbutton image using an Actor
 134    * @param[in] image, Image Actor that has a url which can be used to create an image visual
 135    */
 136   void SetDisabledSelectedImage( Actor image );
 137
 138 private: // From Button
 139
 140   /**
 141    * @copydoc Toolkit::Internal::Button::OnInitialize
 142    */
 143   virtual void OnInitialize();
 144
 145 private:
 146
 147   /**
 148    * @brief Sets the alignment mode to use to align the icon to the label.
 149    *
 150    * @param[in] iconAlignment The alignment mode to use
 151    */
 152   void SetIconAlignment( const PushButton::IconAlignment iconAlignment );
 153
 154   /**
 155    * @brief Gets the alignment mode used to align the icon to the label.
 156    *
 157    * @return The alignment mode in use
 158    */
 159   const PushButton::IconAlignment GetIconAlignment() const;
 160
 161 private:
 162
 163   // Undefined
 164   PushButton( const PushButton& );
 165
 166   // Undefined
 167   PushButton& operator=( const PushButton& );
 168
 169 private:
 170
 171   IconAlignment  mIconAlignment;                 ///< The alignment of the icon against the label.
 172 };
 173
 174 } // namespace Internal
 175
 176 // Helpers for public-api forwarding methods
 177
 178 inline Toolkit::Internal::PushButton& GetImplementation( Toolkit::PushButton& button )
 179 {
 180   DALI_ASSERT_ALWAYS( button );
 181
 182   Dali::RefObject& handle = button.GetImplementation();
 183
 184   return static_cast<Toolkit::Internal::PushButton&>( handle );
 185 }
 186
 187 inline const Toolkit::Internal::PushButton& GetImplementation( const Toolkit::PushButton& button )
 188 {
 189   DALI_ASSERT_ALWAYS( button );
 190
 191   const Dali::RefObject& handle = button.GetImplementation();
 192
 193   return static_cast<const Toolkit::Internal::PushButton&>( handle );
 194 }
 195
 196 } // namespace Toolkit
 197
 198 } // namespace Dali
 199
 200 #endif // DALI_TOOLKIT_INTERNAL_PUSH_BUTTON_H