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) 2021 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 namespace Toolkit
  31 {
  32 namespace Internal
  33 {
  34 /**
  35  * PushButton implementation class.
  36  *
  37  * \sa Dali::Toolkit::PushButton
  38  */
  39 class PushButton : public Button
  40 {
  41 public:
  42   /**
  43    * Create a new PushButton.
  44    * @return A smart-pointer to the newly allocated PushButton.
  45    */
  46   static Dali::Toolkit::PushButton New();
  47
  48 protected:
  49   /**
  50    * Construct a new PushButton.
  51    */
  52   PushButton();
  53
  54   /**
  55    * A reference counted object may only be deleted by calling Unreference()
  56    */
  57   virtual ~PushButton();
  58
  59 public:
  60   // Properties
  61
  62   /**
  63    * Enum for the alignment modes of the icon.
  64    */
  65   enum IconAlignment
  66   {
  67     LEFT,
  68     RIGHT,
  69     TOP,
  70     BOTTOM,
  71     DEFAULT = RIGHT
  72   };
  73
  74   /**
  75    * Called when a property of an object of this type is set.
  76    * @param[in] object The object whose property is set.
  77    * @param[in] index The property index.
  78    * @param[in] value The new property value.
  79    */
  80   static void SetProperty(BaseObject* object, Property::Index index, const Property::Value& value);
  81
  82   /**
  83    * Called to retrieve a property of an object of this type.
  84    * @param[in] object The object whose property is to be retrieved.
  85    * @param[in] index The property index.
  86    * @return The current value of the property.
  87    */
  88   static Property::Value GetProperty(BaseObject* object, Property::Index propertyIndex);
  89
  90 private: // From Button
  91   /**
  92    * @copydoc Toolkit::Internal::Button::OnInitialize
  93    */
  94   void OnInitialize() override;
  95
  96   /**
  97    * @copydoc Toolkit::Internal::Control::CreateAccessibleObject()
  98    */
  99   DevelControl::ControlAccessible* CreateAccessibleObject() override;
 100
 101 private:
 102   /**
 103    * @brief Sets the alignment mode to use to align the icon to the label.
 104    *
 105    * @param[in] iconAlignment The alignment mode to use
 106    */
 107   void SetIconAlignment(const PushButton::IconAlignment iconAlignment);
 108
 109   /**
 110    * @brief Gets the alignment mode used to align the icon to the label.
 111    *
 112    * @return The alignment mode in use
 113    */
 114   const PushButton::IconAlignment GetIconAlignment() const;
 115
 116 private:
 117   // Undefined
 118   PushButton(const PushButton&);
 119
 120   // Undefined
 121   PushButton& operator=(const PushButton&);
 122
 123 private:
 124   IconAlignment mIconAlignment; ///< The alignment of the icon against the label.
 125
 126 protected:
 127   class PushButtonAccessible : public Button::ButtonAccessible
 128   {
 129   public:
 130     using Button::ButtonAccessible::ButtonAccessible;
 131
 132     /**
 133      * @copydoc Dali::Toolkit::DevelControl::ControlAccessible::CalculateStates()
 134      */
 135     Dali::Accessibility::States CalculateStates() override;
 136   };
 137
 138   void OnStateChange(State newState) override;
 139 };
 140
 141 } // namespace Internal
 142
 143 // Helpers for public-api forwarding methods
 144
 145 inline Toolkit::Internal::PushButton& GetImplementation(Toolkit::PushButton& button)
 146 {
 147   DALI_ASSERT_ALWAYS(button);
 148
 149   Dali::RefObject& handle = button.GetImplementation();
 150
 151   return static_cast<Toolkit::Internal::PushButton&>(handle);
 152 }
 153
 154 inline const Toolkit::Internal::PushButton& GetImplementation(const Toolkit::PushButton& button)
 155 {
 156   DALI_ASSERT_ALWAYS(button);
 157
 158   const Dali::RefObject& handle = button.GetImplementation();
 159
 160   return static_cast<const Toolkit::Internal::PushButton&>(handle);
 161 }
 162
 163 } // namespace Toolkit
 164
 165 } // namespace Dali
 166
 167 #endif // DALI_TOOLKIT_INTERNAL_PUSH_BUTTON_H