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

   1 /*
   2  * Copyright (c) 2023 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 "toggle-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/property-array.h>
  25 #include <dali/public-api/object/type-registry-helper.h>
  26 #include <dali/public-api/object/type-registry.h>
  27
  28 // INTERNAL INCLUDES
  29 #include <dali-toolkit/devel-api/controls/control-depth-index-ranges.h>
  30 #include <dali-toolkit/devel-api/controls/control-devel.h>
  31 #include <dali-toolkit/devel-api/controls/tooltip/tooltip-properties.h>
  32 #include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
  33 #include <dali-toolkit/public-api/align-enumerations.h>
  34 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
  35 #include <dali-toolkit/public-api/visuals/text-visual-properties.h>
  36 #include <dali-toolkit/public-api/visuals/visual-properties.h>
  37
  38 #if defined(DEBUG_ENABLED)
  39 extern Debug::Filter* gLogButtonFilter;
  40 #endif
  41
  42 namespace Dali
  43 {
  44 namespace Toolkit
  45 {
  46 namespace Internal
  47 {
  48 namespace
  49 {
  50 BaseHandle Create()
  51 {
  52   return Toolkit::ToggleButton::New();
  53 }
  54
  55 // Properties
  56 DALI_TYPE_REGISTRATION_BEGIN(Toolkit::ToggleButton, Toolkit::Button, Create)
  57
  58 DALI_PROPERTY_REGISTRATION(Toolkit, ToggleButton, "stateVisuals", ARRAY, STATE_VISUALS)
  59 DALI_PROPERTY_REGISTRATION(Toolkit, ToggleButton, "tooltips", ARRAY, TOOLTIPS)
  60 DALI_PROPERTY_REGISTRATION(Toolkit, ToggleButton, "currentStateIndex", INTEGER, CURRENT_STATE_INDEX)
  61
  62 DALI_TYPE_REGISTRATION_END()
  63
  64 } // unnamed namespace
  65
  66 Dali::Toolkit::ToggleButton ToggleButton::New()
  67 {
  68   DALI_LOG_INFO(gLogButtonFilter, Debug::General, "ToggleButton::New\n");
  69   // Create the implementation, temporarily owned on stack
  70   IntrusivePtr<ToggleButton> internalToggleButton = new ToggleButton();
  71
  72   // Pass ownership to CustomActor
  73   Dali::Toolkit::ToggleButton toggleButton(*internalToggleButton);
  74
  75   // Second-phase init of the implementation
  76   // This can only be done after the CustomActor connection has been made...
  77   internalToggleButton->Initialize();
  78
  79   return toggleButton;
  80 }
  81
  82 ToggleButton::ToggleButton()
  83 : Button(),
  84   mToggleStates(),
  85   mToggleVisuals(),
  86   mToggleSelectedVisuals(),
  87   mToggleDisabledVisuals(),
  88   mToggleDisabledSelectedVisuals(),
  89   mToggleTooltips(),
  90   mCurrentToggleIndex(0)
  91 {
  92   DALI_LOG_INFO(gLogButtonFilter, Debug::General, "ToggleButton::Constructor\n");
  93   SetTogglableButton(false);
  94 }
  95
  96 ToggleButton::~ToggleButton()
  97 {
  98 }
  99
 100 void ToggleButton::OnInitialize()
 101 {
 102   DALI_LOG_INFO(gLogButtonFilter, Debug::General, "ToggleButton::OnInitialize\n");
 103   Button::OnInitialize();
 104
 105   // Toggle button requires the Leave event.
 106   Actor self = Self();
 107   self.SetProperty(Actor::Property::LEAVE_REQUIRED, true);
 108
 109   self.SetProperty(DevelControl::Property::ACCESSIBILITY_ROLE, Dali::Accessibility::Role::TOGGLE_BUTTON);
 110 }
 111
 112 DevelControl::ControlAccessible* ToggleButton::CreateAccessibleObject()
 113 {
 114   return new ToggleButtonAccessible(Self());
 115 }
 116
 117 void ToggleButton::SetProperty(BaseObject* object, Property::Index propertyIndex, const Property::Value& value)
 118 {
 119   Toolkit::ToggleButton toggleButton = Toolkit::ToggleButton::DownCast(Dali::BaseHandle(object));
 120
 121   DALI_LOG_INFO(gLogButtonFilter, Debug::Verbose, "ToggleButton::SetProperty index[%d]\n", propertyIndex);
 122
 123   if(toggleButton)
 124   {
 125     ToggleButton& toggleButtonImpl(GetImplementation(toggleButton));
 126
 127     switch(propertyIndex)
 128     {
 129       case Toolkit::ToggleButton::Property::STATE_VISUALS:
 130       {
 131         Property::Array stateArray;
 132         if(value.Get(stateArray))
 133         {
 134           toggleButtonImpl.SetToggleStates(stateArray);
 135         }
 136
 137         break;
 138       }
 139       case Toolkit::ToggleButton::Property::TOOLTIPS:
 140       {
 141         const Property::Array* tipArray = value.GetArray();
 142         if(tipArray)
 143         {
 144           std::vector<std::string> tips;
 145           size_t                   tipsCount = tipArray->Count();
 146           tips.resize(tipsCount);
 147           for(size_t i = 0; i != tipsCount; ++i)
 148           {
 149             tipArray->GetElementAt(i).Get(tips[i]);
 150           }
 151           toggleButtonImpl.SetToggleTooltips(tips);
 152         }
 153         break;
 154       }
 155       default:
 156       {
 157         break;
 158       }
 159     } // end of switch
 160   }
 161 }
 162
 163 Property::Value ToggleButton::GetProperty(BaseObject* object, Property::Index propertyIndex)
 164 {
 165   Property::Value value;
 166
 167   Toolkit::ToggleButton toggleButton = Toolkit::ToggleButton::DownCast(Dali::BaseHandle(object));
 168
 169   DALI_LOG_INFO(gLogButtonFilter, Debug::Verbose, "ToggleButton::GetProperty index[%d]\n", propertyIndex);
 170
 171   if(toggleButton)
 172   {
 173     ToggleButton& toggleButtonImpl(GetImplementation(toggleButton));
 174
 175     switch(propertyIndex)
 176     {
 177       case Toolkit::ToggleButton::Property::STATE_VISUALS:
 178       {
 179         value = toggleButtonImpl.GetToggleStates();
 180         break;
 181       }
 182       case Toolkit::ToggleButton::Property::TOOLTIPS:
 183       {
 184         Property::Value  value1(Property::ARRAY);
 185         Property::Array* tipArray = value1.GetArray();
 186
 187         if(tipArray)
 188         {
 189           std::vector<std::string> tips = toggleButtonImpl.GetToggleTooltips();
 190           size_t                   tipsCount(tips.size());
 191           for(size_t i(0); i != tipsCount; ++i)
 192           {
 193             tipArray->PushBack(tips[i]);
 194           }
 195         }
 196         value = value1;
 197         break;
 198       }
 199       case Toolkit::ToggleButton::Property::CURRENT_STATE_INDEX:
 200       {
 201         value = static_cast<int>(toggleButtonImpl.mCurrentToggleIndex);
 202         break;
 203       }
 204     } // end of switch
 205   }
 206
 207   return value;
 208 }
 209
 210 void ToggleButton::CreateVisualsForAllStates(const Property::Array& states, std::vector<Toolkit::Visual::Base>& visuals)
 211 {
 212   DALI_LOG_INFO(gLogButtonFilter, Debug::General, "ToggleButton::CreateVisualsForAllStates\n");
 213
 214   visuals.clear();
 215
 216   for(unsigned int i = 0; i < states.Count(); i++)
 217   {
 218     Property::Value value(states[i]);
 219
 220     Toolkit::VisualFactory visualFactory = Toolkit::VisualFactory::Get();
 221     Toolkit::Visual::Base  stateVisual;
 222
 223     if(value.GetType() == Property::MAP)
 224     {
 225       Property::Map* map = value.GetMap();
 226       if(map && !map->Empty()) // Empty map results in current visual removal.
 227       {
 228         DALI_LOG_INFO(gLogButtonFilter, Debug::Verbose, "ToggleButton::CreateVisuals Using Map\n");
 229         stateVisual = visualFactory.CreateVisual(*map);
 230       }
 231     }
 232     else if(value.GetType() == Property::STRING)
 233     {
 234       std::string imageUrl = value.Get<std::string>();
 235       DALI_LOG_INFO(gLogButtonFilter, Debug::Verbose, "ToggleButton::CreateVisuals Using image URL\n");
 236       if(!imageUrl.empty())
 237       {
 238         stateVisual = visualFactory.CreateVisual(imageUrl, ImageDimensions());
 239       }
 240     }
 241
 242     if(stateVisual)
 243     {
 244       stateVisual.SetDepthIndex(DepthIndex::CONTENT);
 245       visuals.push_back(stateVisual);
 246     }
 247   } // end of for
 248   DALI_LOG_INFO(gLogButtonFilter, Debug::Verbose, "ToggleButton::CreateVisuals mToggleVisuals:%d\n", mToggleVisuals.size());
 249 }
 250
 251 void ToggleButton::SetToggleStates(const Property::Array& states)
 252 { //this should really be generalized to be either string or maps so that any visual can be created.
 253   DALI_LOG_INFO(gLogButtonFilter, Debug::General, "ToggleButton::SetToggleStates\n");
 254   if(!states.Empty())
 255   {
 256     mToggleStates.Clear();
 257     mToggleStates = states;
 258     /* New toggle button index from 0. */
 259     mCurrentToggleIndex = 0;
 260
 261     // Create all visuals, save to mToggleVisuals.
 262     CreateVisualsForAllStates(states, mToggleVisuals);
 263     CreateVisualsForAllStates(states, mToggleSelectedVisuals);
 264     CreateVisualsForAllStates(states, mToggleDisabledVisuals);
 265     CreateVisualsForAllStates(states, mToggleDisabledSelectedVisuals);
 266
 267     DALI_LOG_INFO(gLogButtonFilter, Debug::General, "ToggleButton::Began to register visual.\n");
 268
 269     PrepareVisual(Toolkit::Button::Property::UNSELECTED_VISUAL, mToggleVisuals[mCurrentToggleIndex]);
 270     PrepareVisual(Toolkit::Button::Property::SELECTED_VISUAL, mToggleSelectedVisuals[mCurrentToggleIndex]);
 271     PrepareVisual(Toolkit::Button::Property::DISABLED_UNSELECTED_VISUAL, mToggleDisabledVisuals[mCurrentToggleIndex]);
 272     PrepareVisual(Toolkit::Button::Property::DISABLED_SELECTED_VISUAL, mToggleDisabledSelectedVisuals[mCurrentToggleIndex]);
 273
 274     RelayoutRequest();
 275   }
 276 }
 277
 278 Property::Array ToggleButton::GetToggleStates() const
 279 {
 280   return mToggleStates;
 281 }
 282
 283 void ToggleButton::SetToggleTooltips(std::vector<std::string>& tips)
 284 {
 285   DALI_LOG_INFO(gLogButtonFilter, Debug::General, "ToggleButton::SetToggleTooltips\n");
 286   if(!tips.empty())
 287   {
 288     mToggleTooltips.clear();
 289     mToggleTooltips.swap(tips);
 290   }
 291
 292   if(!mToggleTooltips.empty() && (mCurrentToggleIndex < mToggleTooltips.size()))
 293   {
 294     Self().SetProperty(Toolkit::DevelControl::Property::TOOLTIP, mToggleTooltips[mCurrentToggleIndex]);
 295   }
 296
 297   RelayoutRequest();
 298 }
 299
 300 const std::vector<std::string>& ToggleButton::GetToggleTooltips() const
 301 {
 302   return mToggleTooltips;
 303 }
 304
 305 void ToggleButton::PrepareVisual(Property::Index index, Toolkit::Visual::Base& visual)
 306 {
 307   bool enabled = false; // Disabled by default
 308
 309   // Unregister the visual with the given index if registered previously
 310   if(DevelControl::GetVisual(*this, index))
 311   {
 312     // Check whether it was enabled to ensure we do the same with the new visual we're registering
 313     enabled = DevelControl::IsVisualEnabled(*this, index);
 314     DevelControl::UnregisterVisual(*this, index);
 315   }
 316
 317   DevelControl::RegisterVisual(*this, index, visual, enabled);
 318 }
 319
 320 void ToggleButton::RelayoutVisual(Property::Index index, const Vector2& size)
 321 {
 322   Toolkit::Visual::Base visual = DevelControl::GetVisual(*this, index);
 323   if(visual)
 324   {
 325     Size    visualSize     = Size::ZERO;
 326     Vector2 visualPosition = Vector2::ZERO;
 327
 328     visual.GetNaturalSize(visualSize);
 329
 330     DALI_LOG_INFO(gLogButtonFilter, Debug::General, "ToggleButton::OnRelayout Setting visual size to(%f,%f)\n", visualSize.width, visualSize.height);
 331     DALI_LOG_INFO(gLogButtonFilter, Debug::General, "ToggleButton::OnRelayout Setting visual position to(%f,%f)\n", visualPosition.x, visualPosition.y);
 332
 333     Property::Map visualTransform;
 334     visualTransform.Add(Toolkit::Visual::Transform::Property::SIZE, visualSize)
 335       .Add(Toolkit::Visual::Transform::Property::OFFSET, visualPosition)
 336       .Add(Toolkit::Visual::Transform::Property::OFFSET_POLICY, Vector2(Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE))
 337       .Add(Toolkit::Visual::Transform::Property::SIZE_POLICY, Vector2(Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE))
 338       .Add(Toolkit::Visual::Transform::Property::ORIGIN, Toolkit::Align::CENTER)
 339       .Add(Toolkit::Visual::Transform::Property::ANCHOR_POINT, Toolkit::Align::CENTER);
 340
 341     visual.SetTransformAndSize(visualTransform, size);
 342   }
 343 }
 344
 345 void ToggleButton::OnRelayout(const Vector2& size, RelayoutContainer& container)
 346 {
 347   DALI_LOG_INFO(gLogButtonFilter, Debug::General, "ToggleButton::OnRelayout targetSize(%f,%f) ptr(%p)\n", size.width, size.height, this);
 348
 349   RelayoutVisual(Toolkit::Button::Property::UNSELECTED_VISUAL, size);
 350   RelayoutVisual(Toolkit::Button::Property::SELECTED_VISUAL, size);
 351   RelayoutVisual(Toolkit::Button::Property::DISABLED_UNSELECTED_VISUAL, size);
 352   RelayoutVisual(Toolkit::Button::Property::DISABLED_SELECTED_VISUAL, size);
 353 }
 354
 355 void ToggleButton::OnPressed()
 356 {
 357   DALI_LOG_INFO(gLogButtonFilter, Debug::General, "ToggleButton::OnPressed\n");
 358   // State index will add 1 only when button is pressed.
 359   mCurrentToggleIndex = (mCurrentToggleIndex + 1) % static_cast<uint32_t>(mToggleVisuals.size());
 360
 361   // Both create SelectedVisual and UnselectedVisual
 362   PrepareVisual(Toolkit::Button::Property::UNSELECTED_VISUAL, mToggleVisuals[mCurrentToggleIndex]);
 363   PrepareVisual(Toolkit::Button::Property::SELECTED_VISUAL, mToggleSelectedVisuals[mCurrentToggleIndex]);
 364   PrepareVisual(Toolkit::Button::Property::DISABLED_UNSELECTED_VISUAL, mToggleDisabledVisuals[mCurrentToggleIndex]);
 365   PrepareVisual(Toolkit::Button::Property::DISABLED_SELECTED_VISUAL, mToggleDisabledSelectedVisuals[mCurrentToggleIndex]);
 366
 367   //Need to check mCurrentToggleIndex, it must less than the size of mToggleTooltips.
 368   if(!mToggleTooltips.empty() && (mCurrentToggleIndex < mToggleTooltips.size()))
 369   {
 370     Self().SetProperty(Toolkit::DevelControl::Property::TOOLTIP, mToggleTooltips[mCurrentToggleIndex]);
 371   }
 372
 373   RelayoutRequest();
 374 }
 375
 376 Dali::Accessibility::States ToggleButton::ToggleButtonAccessible::CalculateStates()
 377 {
 378   auto states = Button::ButtonAccessible::CalculateStates();
 379   auto button = Toolkit::ToggleButton::DownCast(Self());
 380   if(button.GetProperty<int>(Toolkit::ToggleButton::Property::CURRENT_STATE_INDEX))
 381   {
 382     states[Dali::Accessibility::State::CHECKED] = true;
 383   }
 384   return states;
 385 }
 386
 387 std::string ToggleButton::ToggleButtonAccessible::GetDescriptionRaw() const
 388 {
 389   auto button   = Toolkit::ToggleButton::DownCast(Self());
 390   auto index    = button.GetProperty<int>(Toolkit::ToggleButton::Property::CURRENT_STATE_INDEX);
 391   auto tooltips = button.GetProperty<Property::Array>(Toolkit::ToggleButton::Property::TOOLTIPS);
 392
 393   return tooltips[index].Get<std::string>();
 394 }
 395
 396 Property::Index ToggleButton::ToggleButtonAccessible::GetDescriptionPropertyIndex()
 397 {
 398   return Toolkit::ToggleButton::Property::TOOLTIPS;
 399 }
 400
 401 void ToggleButton::OnStateChange(State newState)
 402 {
 403   // TODO: replace it with OnPropertySet hook once Button::Property::SELECTED will be consistently used
 404   if((Self() == Dali::Accessibility::Accessible::GetCurrentlyHighlightedActor()) && (newState == SELECTED_STATE || newState == UNSELECTED_STATE))
 405   {
 406     auto* accessible = GetAccessibleObject();
 407     if(DALI_LIKELY(accessible))
 408     {
 409       accessible->EmitStateChanged(Dali::Accessibility::State::CHECKED, mCurrentToggleIndex ? 1 : 0, 0);
 410       accessible->Emit(Dali::Accessibility::ObjectPropertyChangeEvent::DESCRIPTION);
 411     }
 412   }
 413 }
 414
 415 } // namespace Internal
 416
 417 } // namespace Toolkit
 418
 419 } // namespace Dali