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

   1 /*
   2  * Copyright (c) 2021 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *
  16  */
  17
  18 // CLASS HEADER
  19 #include "push-button-impl.h"
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/devel-api/scripting/scripting.h>
  23 #include <dali/integration-api/debug.h>
  24 #include <dali/public-api/object/type-registry-helper.h>
  25 #include <dali/public-api/object/type-registry.h>
  26
  27 // INTERNAL INCLUDES
  28 #include <dali-toolkit/devel-api/controls/control-depth-index-ranges.h>
  29 #include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
  30 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
  31 #include <dali-toolkit/public-api/controls/text-controls/text-label.h>
  32
  33 #if defined(DEBUG_ENABLED)
  34 extern Debug::Filter* gLogButtonFilter;
  35 #endif
  36
  37 namespace Dali
  38 {
  39 namespace Toolkit
  40 {
  41 namespace Internal
  42 {
  43 namespace
  44 {
  45 BaseHandle Create()
  46 {
  47   return Toolkit::PushButton::New();
  48 }
  49
  50 // Properties
  51
  52 DALI_TYPE_REGISTRATION_BEGIN(Toolkit::PushButton, Toolkit::Button, Create)
  53
  54 DALI_PROPERTY_REGISTRATION(Toolkit, PushButton, "labelPadding", STRING, LABEL_PADDING)
  55 DALI_PROPERTY_REGISTRATION(Toolkit, PushButton, "iconPadding", STRING, ICON_PADDING)
  56
  57 DALI_TYPE_REGISTRATION_END()
  58
  59 } // unnamed namespace
  60
  61 namespace
  62 {
  63 } // unnamed namespace
  64
  65 Dali::Toolkit::PushButton PushButton::New()
  66 {
  67   // Create the implementation, temporarily owned on stack
  68   IntrusivePtr<PushButton> internalPushButton = new PushButton();
  69
  70   // Pass ownership to CustomActor
  71   Dali::Toolkit::PushButton pushButton(*internalPushButton);
  72
  73   // Second-phase init of the implementation
  74   // This can only be done after the CustomActor connection has been made...
  75   internalPushButton->Initialize();
  76
  77   return pushButton;
  78 }
  79
  80 PushButton::PushButton()
  81 : Button(),
  82   mIconAlignment(RIGHT)
  83 {
  84 }
  85
  86 PushButton::~PushButton()
  87 {
  88 }
  89
  90 void PushButton::OnInitialize()
  91 {
  92   Button::OnInitialize();
  93
  94   // Push button requires the Leave event.
  95   Actor self = Self();
  96   self.SetProperty(Actor::Property::LEAVE_REQUIRED, true);
  97
  98   self.SetProperty(DevelControl::Property::ACCESSIBILITY_ROLE, Dali::Accessibility::Role::PUSH_BUTTON);
  99 }
 100
 101 DevelControl::ControlAccessible* PushButton::CreateAccessibleObject()
 102 {
 103   return new PushButtonAccessible(Self());
 104 }
 105
 106 void PushButton::SetIconAlignment(const PushButton::IconAlignment iconAlignment)
 107 {
 108   mIconAlignment = iconAlignment;
 109   Button::Align labelAlignment;
 110   switch(iconAlignment)
 111   {
 112     case RIGHT:
 113     {
 114       labelAlignment = Button::BEGIN;
 115       break;
 116     }
 117     case TOP:
 118     {
 119       labelAlignment = Button::BOTTOM;
 120       break;
 121     }
 122     case BOTTOM:
 123     {
 124       labelAlignment = Button::TOP;
 125       break;
 126     }
 127     case LEFT:
 128     default:
 129       labelAlignment = Button::END;
 130       break;
 131   }
 132
 133   Button::SetLabelAlignment(labelAlignment);
 134 }
 135
 136 const PushButton::IconAlignment PushButton::GetIconAlignment() const
 137 {
 138   return mIconAlignment;
 139 }
 140
 141 void PushButton::SetProperty(BaseObject* object, Property::Index propertyIndex, const Property::Value& value)
 142 {
 143   Toolkit::PushButton pushButton = Toolkit::PushButton::DownCast(Dali::BaseHandle(object));
 144
 145   if(pushButton)
 146   {
 147     PushButton& pushButtonImpl(GetImplementation(pushButton));
 148
 149     // Properties remain here for Tizen 3.0 legacy requirements. Are now in Button base class
 150
 151     switch(propertyIndex)
 152     {
 153       case Toolkit::PushButton::Property::LABEL_PADDING:
 154       {
 155         Vector4 padding(value.Get<Vector4>());
 156         pushButtonImpl.Button::SetLabelPadding(Padding(padding.x, padding.y, padding.z, padding.w));
 157         break;
 158       }
 159       case Toolkit::PushButton::Property::ICON_PADDING:
 160       {
 161         Vector4 padding(value.Get<Vector4>());
 162         pushButtonImpl.Button::SetForegroundPadding(Padding(padding.x, padding.y, padding.z, padding.w));
 163         break;
 164       }
 165     }
 166   }
 167 }
 168
 169 Property::Value PushButton::GetProperty(BaseObject* object, Property::Index propertyIndex)
 170 {
 171   Property::Value value;
 172
 173   Toolkit::PushButton pushButton = Toolkit::PushButton::DownCast(Dali::BaseHandle(object));
 174
 175   if(pushButton)
 176   {
 177     PushButton& pushButtonImpl(GetImplementation(pushButton));
 178
 179     switch(propertyIndex)
 180     {
 181       case Toolkit::PushButton::Property::LABEL_PADDING:
 182       {
 183         Padding padding = pushButtonImpl.Button::GetLabelPadding();
 184         value           = Vector4(padding.x, padding.y, padding.top, padding.bottom);
 185         break;
 186       }
 187       case Toolkit::PushButton::Property::ICON_PADDING:
 188       {
 189         Padding padding = pushButtonImpl.Button::GetForegroundPadding();
 190         value           = Vector4(padding.x, padding.y, padding.top, padding.bottom);
 191         break;
 192       }
 193     }
 194   }
 195
 196   return value;
 197 }
 198
 199 Dali::Accessibility::States PushButton::PushButtonAccessible::CalculateStates()
 200 {
 201   auto state = Button::ButtonAccessible::CalculateStates();
 202   auto self = Toolkit::Button::DownCast(Self());
 203   state[Dali::Accessibility::State::PRESSED] = self.GetProperty<bool>(Toolkit::Button::Property::SELECTED);
 204   return state;
 205 }
 206
 207 void PushButton::OnStateChange(State newState)
 208 {
 209   // TODO: replace it with OnPropertySet hook once Button::Property::SELECTED will be consistently used
 210   if((Dali::Accessibility::Accessible::GetCurrentlyHighlightedActor() == Self()) && (newState == SELECTED_STATE || newState == UNSELECTED_STATE))
 211   {
 212     auto* accessible = GetAccessibleObject();
 213
 214     accessible->EmitStateChanged(Dali::Accessibility::State::PRESSED, newState == SELECTED_STATE ? 1 : 0, 0);
 215
 216     if(Self().GetProperty<bool>(Toolkit::Button::Property::TOGGLABLE))
 217     {
 218       accessible->EmitStateChanged(Dali::Accessibility::State::CHECKED, newState == SELECTED_STATE ? 1 : 0, 0);
 219     }
 220   }
 221 }
 222
 223 } // namespace Internal
 224
 225 } // namespace Toolkit
 226
 227 } // namespace Dali