2 * Copyright (c) 2022 Samsung Electronics Co., Ltd.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include "toggle-button-impl.h"
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>
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>
38 #if defined(DEBUG_ENABLED)
39 extern Debug::Filter* gLogButtonFilter;
52 return Toolkit::ToggleButton::New();
56 DALI_TYPE_REGISTRATION_BEGIN(Toolkit::ToggleButton, Toolkit::Button, Create)
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)
62 DALI_TYPE_REGISTRATION_END()
64 } // unnamed namespace
66 Dali::Toolkit::ToggleButton ToggleButton::New()
68 DALI_LOG_INFO(gLogButtonFilter, Debug::General, "ToggleButton::New\n");
69 // Create the implementation, temporarily owned on stack
70 IntrusivePtr<ToggleButton> internalToggleButton = new ToggleButton();
72 // Pass ownership to CustomActor
73 Dali::Toolkit::ToggleButton toggleButton(*internalToggleButton);
75 // Second-phase init of the implementation
76 // This can only be done after the CustomActor connection has been made...
77 internalToggleButton->Initialize();
82 ToggleButton::ToggleButton()
86 mToggleSelectedVisuals(),
87 mToggleDisabledVisuals(),
88 mToggleDisabledSelectedVisuals(),
90 mCurrentToggleIndex(0)
92 DALI_LOG_INFO(gLogButtonFilter, Debug::General, "ToggleButton::Constructor\n");
93 SetTogglableButton(false);
96 ToggleButton::~ToggleButton()
100 void ToggleButton::OnInitialize()
102 DALI_LOG_INFO(gLogButtonFilter, Debug::General, "ToggleButton::OnInitialize\n");
103 Button::OnInitialize();
105 // Toggle button requires the Leave event.
107 self.SetProperty(Actor::Property::LEAVE_REQUIRED, true);
109 self.SetProperty(DevelControl::Property::ACCESSIBILITY_ROLE, Dali::Accessibility::Role::TOGGLE_BUTTON);
112 DevelControl::ControlAccessible* ToggleButton::CreateAccessibleObject()
114 return new ToggleButtonAccessible(Self());
117 void ToggleButton::SetProperty(BaseObject* object, Property::Index propertyIndex, const Property::Value& value)
119 Toolkit::ToggleButton toggleButton = Toolkit::ToggleButton::DownCast(Dali::BaseHandle(object));
121 DALI_LOG_INFO(gLogButtonFilter, Debug::Verbose, "ToggleButton::SetProperty index[%d]\n", propertyIndex);
125 ToggleButton& toggleButtonImpl(GetImplementation(toggleButton));
127 switch(propertyIndex)
129 case Toolkit::ToggleButton::Property::STATE_VISUALS:
131 Property::Array stateArray;
132 if(value.Get(stateArray))
134 toggleButtonImpl.SetToggleStates(stateArray);
139 case Toolkit::ToggleButton::Property::TOOLTIPS:
141 const Property::Array* tipArray = value.GetArray();
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)
149 tipArray->GetElementAt(i).Get(tips[i]);
151 toggleButtonImpl.SetToggleTooltips(tips);
163 Property::Value ToggleButton::GetProperty(BaseObject* object, Property::Index propertyIndex)
165 Property::Value value;
167 Toolkit::ToggleButton toggleButton = Toolkit::ToggleButton::DownCast(Dali::BaseHandle(object));
169 DALI_LOG_INFO(gLogButtonFilter, Debug::Verbose, "ToggleButton::GetProperty index[%d]\n", propertyIndex);
173 ToggleButton& toggleButtonImpl(GetImplementation(toggleButton));
175 switch(propertyIndex)
177 case Toolkit::ToggleButton::Property::STATE_VISUALS:
179 value = toggleButtonImpl.GetToggleStates();
182 case Toolkit::ToggleButton::Property::TOOLTIPS:
184 Property::Value value1(Property::ARRAY);
185 Property::Array* tipArray = value1.GetArray();
189 std::vector<std::string> tips = toggleButtonImpl.GetToggleTooltips();
190 size_t tipsCount(tips.size());
191 for(size_t i(0); i != tipsCount; ++i)
193 tipArray->PushBack(tips[i]);
199 case Toolkit::ToggleButton::Property::CURRENT_STATE_INDEX:
201 value = static_cast<int>(toggleButtonImpl.mCurrentToggleIndex);
210 void ToggleButton::CreateVisualsForAllStates(const Property::Array& states, std::vector<Toolkit::Visual::Base>& visuals)
212 DALI_LOG_INFO(gLogButtonFilter, Debug::General, "ToggleButton::CreateVisualsForAllStates\n");
216 for(unsigned int i = 0; i < states.Count(); i++)
218 Property::Value value(states[i]);
220 Toolkit::VisualFactory visualFactory = Toolkit::VisualFactory::Get();
221 Toolkit::Visual::Base stateVisual;
223 if(value.GetType() == Property::MAP)
225 Property::Map* map = value.GetMap();
226 if(map && !map->Empty()) // Empty map results in current visual removal.
228 DALI_LOG_INFO(gLogButtonFilter, Debug::Verbose, "ToggleButton::CreateVisuals Using Map\n");
229 stateVisual = visualFactory.CreateVisual(*map);
232 else if(value.GetType() == Property::STRING)
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())
238 stateVisual = visualFactory.CreateVisual(imageUrl, ImageDimensions());
244 stateVisual.SetDepthIndex(DepthIndex::CONTENT);
245 visuals.push_back(stateVisual);
248 DALI_LOG_INFO(gLogButtonFilter, Debug::Verbose, "ToggleButton::CreateVisuals mToggleVisuals:%d\n", mToggleVisuals.size());
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");
256 mToggleStates.Clear();
257 mToggleStates = states;
258 /* New toggle button index from 0. */
259 mCurrentToggleIndex = 0;
261 // Create all visuals, save to mToggleVisuals.
262 CreateVisualsForAllStates(states, mToggleVisuals);
263 CreateVisualsForAllStates(states, mToggleSelectedVisuals);
264 CreateVisualsForAllStates(states, mToggleDisabledVisuals);
265 CreateVisualsForAllStates(states, mToggleDisabledSelectedVisuals);
267 DALI_LOG_INFO(gLogButtonFilter, Debug::General, "ToggleButton::Began to register visual.\n");
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]);
278 Property::Array ToggleButton::GetToggleStates() const
280 return mToggleStates;
283 void ToggleButton::SetToggleTooltips(std::vector<std::string>& tips)
285 DALI_LOG_INFO(gLogButtonFilter, Debug::General, "ToggleButton::SetToggleTooltips\n");
288 mToggleTooltips.clear();
289 mToggleTooltips.swap(tips);
292 if(!mToggleTooltips.empty() && (mCurrentToggleIndex < mToggleTooltips.size()))
294 Self().SetProperty(Toolkit::DevelControl::Property::TOOLTIP, mToggleTooltips[mCurrentToggleIndex]);
300 const std::vector<std::string>& ToggleButton::GetToggleTooltips() const
302 return mToggleTooltips;
305 void ToggleButton::PrepareVisual(Property::Index index, Toolkit::Visual::Base& visual)
307 bool enabled = false; // Disabled by default
309 // Unregister the visual with the given index if registered previously
310 if(DevelControl::GetVisual(*this, index))
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);
317 DevelControl::RegisterVisual(*this, index, visual, enabled);
320 void ToggleButton::RelayoutVisual(Property::Index index, const Vector2& size)
322 Toolkit::Visual::Base visual = DevelControl::GetVisual(*this, index);
325 Size visualSize = Size::ZERO;
326 Vector2 visualPosition = Vector2::ZERO;
328 visual.GetNaturalSize(visualSize);
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);
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);
341 visual.SetTransformAndSize(visualTransform, size);
345 void ToggleButton::OnRelayout(const Vector2& size, RelayoutContainer& container)
347 DALI_LOG_INFO(gLogButtonFilter, Debug::General, "ToggleButton::OnRelayout targetSize(%f,%f) ptr(%p)\n", size.width, size.height, this);
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);
355 void ToggleButton::OnPressed()
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());
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]);
367 //Need to check mCurrentToggleIndex, it must less than the size of mToggleTooltips.
368 if(!mToggleTooltips.empty() && (mCurrentToggleIndex < mToggleTooltips.size()))
370 Self().SetProperty(Toolkit::DevelControl::Property::TOOLTIP, mToggleTooltips[mCurrentToggleIndex]);
376 Dali::Accessibility::States ToggleButton::ToggleButtonAccessible::CalculateStates()
378 auto states = Button::ButtonAccessible::CalculateStates();
379 auto button = Toolkit::ToggleButton::DownCast(Self());
380 if(button.GetProperty<int>(Toolkit::ToggleButton::Property::CURRENT_STATE_INDEX))
382 states[Dali::Accessibility::State::CHECKED] = true;
387 std::string ToggleButton::ToggleButtonAccessible::GetDescriptionRaw() const
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);
393 return tooltips[index].Get<std::string>();
396 Property::Index ToggleButton::ToggleButtonAccessible::GetDescriptionPropertyIndex()
398 return Toolkit::ToggleButton::Property::TOOLTIPS;
401 void ToggleButton::OnStateChange(State newState)
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))
406 auto* accessible = GetAccessibleObject();
408 accessible->EmitStateChanged(Dali::Accessibility::State::CHECKED, mCurrentToggleIndex ? 1 : 0, 0);
409 accessible->Emit(Dali::Accessibility::ObjectPropertyChangeEvent::DESCRIPTION);
413 } // namespace Internal
415 } // namespace Toolkit