2 * Copyright (c) 2018 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/public-api/object/type-registry.h>
23 #include <dali/public-api/object/type-registry-helper.h>
24 #include <dali/public-api/images/resource-image.h>
25 #include <dali/devel-api/scripting/scripting.h>
26 #include <dali/public-api/object/property-array.h>
27 #include <dali/integration-api/debug.h>
30 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
31 #include <dali-toolkit/devel-api/controls/control-depth-index-ranges.h>
32 #include <dali-toolkit/devel-api/controls/control-devel.h>
33 #include <dali-toolkit/devel-api/controls/buttons/button-devel.h>
34 #include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
35 #include <dali-toolkit/public-api/visuals/visual-properties.h>
36 #include <dali-toolkit/public-api/align-enumerations.h>
37 #include <dali-toolkit/devel-api/controls/tooltip/tooltip-properties.h>
38 #include <dali-toolkit/public-api/visuals/text-visual-properties.h>
39 #include <dali-toolkit/devel-api/controls/control-devel.h>
41 #if defined(DEBUG_ENABLED)
42 extern Debug::Filter* gLogButtonFilter;
59 return Toolkit::ToggleButton::New();
63 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::ToggleButton, Toolkit::Button, Create )
65 DALI_PROPERTY_REGISTRATION( Toolkit, ToggleButton, "stateVisuals", ARRAY, STATE_VISUALS )
66 DALI_PROPERTY_REGISTRATION( Toolkit, ToggleButton, "tooltips", ARRAY, TOOLTIPS )
67 DALI_PROPERTY_REGISTRATION( Toolkit, ToggleButton, "currentStateIndex", INTEGER, CURRENT_STATE_INDEX )
69 DALI_TYPE_REGISTRATION_END()
71 } // unnamed namespace
73 Dali::Toolkit::ToggleButton ToggleButton::New()
75 DALI_LOG_INFO( gLogButtonFilter, Debug::General, "ToggleButton::New\n" );
76 // Create the implementation, temporarily owned on stack
77 IntrusivePtr< ToggleButton > internalToggleButton = new ToggleButton();
79 // Pass ownership to CustomActor
80 Dali::Toolkit::ToggleButton toggleButton( *internalToggleButton );
82 // Second-phase init of the implementation
83 // This can only be done after the CustomActor connection has been made...
84 internalToggleButton->Initialize();
89 ToggleButton::ToggleButton()
93 mToggleSelectedVisuals(),
94 mToggleDisabledVisuals(),
95 mToggleDisabledSelectedVisuals(),
97 mCurrentToggleIndex(0)
99 DALI_LOG_INFO( gLogButtonFilter, Debug::General, "ToggleButton::Constructor\n" );
100 SetTogglableButton( false );
103 ToggleButton::~ToggleButton()
107 void ToggleButton::OnInitialize()
109 DALI_LOG_INFO( gLogButtonFilter, Debug::General, "ToggleButton::OnInitialize\n" );
110 Button::OnInitialize();
112 // Toggle button requires the Leave event.
114 self.SetLeaveRequired( true );
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 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 Property::Array array = toggleButtonImpl.GetToggleStates();
180 value = Property::Value( array );
183 case Toolkit::ToggleButton::Property::TOOLTIPS:
185 Property::Value value1( Property::ARRAY );
186 Property::Array* tipArray = value1.GetArray();
190 std::vector<std::string> tips = toggleButtonImpl.GetToggleTooltips();
191 size_t tipsCount( tips.size() );
192 for( size_t i( 0 ); i != tipsCount; ++i )
194 tipArray->PushBack( tips[i] );
200 case Toolkit::ToggleButton::Property::CURRENT_STATE_INDEX:
202 value = static_cast<int>(toggleButtonImpl.mCurrentToggleIndex);
211 void ToggleButton::CreateVisualsForAllStates( const Property::Array& states, std::vector<Toolkit::Visual::Base>& visuals )
213 DALI_LOG_INFO( gLogButtonFilter, Debug::General, "ToggleButton::CreateVisualsForAllStates\n" );
217 for ( unsigned int i = 0; i < states.Count(); i++ )
219 Property::Value value( states[i] );
221 Toolkit::VisualFactory visualFactory = Toolkit::VisualFactory::Get();
222 Toolkit::Visual::Base stateVisual;
224 if ( value.GetType() == Property::MAP )
226 Property::Map *map = value.GetMap();
227 if( map && !map->Empty() ) // Empty map results in current visual removal.
229 DALI_LOG_INFO( gLogButtonFilter, Debug::Verbose, "ToggleButton::CreateVisuals Using Map\n" );
230 stateVisual = visualFactory.CreateVisual( *map );
233 else if ( value.GetType() == Property::STRING )
235 std::string imageUrl = value.Get<std::string>();
236 DALI_LOG_INFO( gLogButtonFilter, Debug::Verbose, "ToggleButton::CreateVisuals Using image URL\n" );
237 if ( !imageUrl.empty() )
239 stateVisual = visualFactory.CreateVisual( imageUrl, ImageDimensions() );
245 stateVisual.SetDepthIndex( DepthIndex::CONTENT );
246 visuals.push_back( stateVisual );
249 DALI_LOG_INFO( gLogButtonFilter, Debug::Verbose, "ToggleButton::CreateVisuals mToggleVisuals:%d\n", mToggleVisuals.size() );
252 void ToggleButton::SetToggleStates( const Property::Array& states )
253 { //this should really be generalized to be either string or maps so that any visual can be created.
254 DALI_LOG_INFO( gLogButtonFilter, Debug::General, "ToggleButton::SetToggleStates\n" );
255 if ( !states.Empty() )
257 mToggleStates.Clear();
258 mToggleStates = states;
259 /* New toggle button index from 0. */
260 mCurrentToggleIndex = 0;
262 // Create all visuals, save to mToggleVisuals.
263 CreateVisualsForAllStates( states, mToggleVisuals );
264 CreateVisualsForAllStates( states, mToggleSelectedVisuals );
265 CreateVisualsForAllStates( states, mToggleDisabledVisuals );
266 CreateVisualsForAllStates( states, mToggleDisabledSelectedVisuals );
268 DALI_LOG_INFO( gLogButtonFilter, Debug::General, "ToggleButton::Began to register visual.\n" );
270 PrepareVisual( Toolkit::DevelButton::Property::UNSELECTED_VISUAL, mToggleVisuals[mCurrentToggleIndex] );
271 PrepareVisual( Toolkit::DevelButton::Property::SELECTED_VISUAL, mToggleSelectedVisuals[mCurrentToggleIndex] );
272 PrepareVisual( Toolkit::DevelButton::Property::DISABLED_UNSELECTED_VISUAL, mToggleDisabledVisuals[mCurrentToggleIndex] );
273 PrepareVisual( Toolkit::DevelButton::Property::DISABLED_SELECTED_VISUAL, mToggleDisabledSelectedVisuals[mCurrentToggleIndex] );
279 Property::Array ToggleButton::GetToggleStates() const
281 return mToggleStates;
284 void ToggleButton::SetToggleTooltips( std::vector<std::string>& tips )
286 DALI_LOG_INFO( gLogButtonFilter, Debug::General, "ToggleButton::SetToggleTooltips\n" );
289 mToggleTooltips.clear();
290 mToggleTooltips.swap( tips );
293 if ( !mToggleTooltips.empty() && ( mCurrentToggleIndex < mToggleTooltips.size() ) )
295 Self().SetProperty( Toolkit::DevelControl::Property::TOOLTIP, mToggleTooltips[mCurrentToggleIndex] );
301 const std::vector<std::string>& ToggleButton::GetToggleTooltips() const
303 return mToggleTooltips;
306 void ToggleButton::PrepareVisual(Property::Index index, Toolkit::Visual::Base& visual)
308 bool enabled = false; // Disabled by default
310 // Unregister the visual with the given index if registered previously
311 if( DevelControl::GetVisual( *this, index ) )
313 // Check whether it was enabled to ensure we do the same with the new visual we're registering
314 enabled = DevelControl::IsVisualEnabled( *this, index );
315 DevelControl::UnregisterVisual( *this, index );
318 DevelControl::RegisterVisual( *this, index, visual, enabled );
321 void ToggleButton::RelayoutVisual( Property::Index index, const Vector2& size )
323 Toolkit::Visual::Base visual = DevelControl::GetVisual( *this, index );
326 Size visualSize = Size::ZERO;
327 Vector2 visualPosition = Vector2::ZERO;
329 visual.GetNaturalSize( visualSize );
331 DALI_LOG_INFO( gLogButtonFilter, Debug::General, "ToggleButton::OnRelayout Setting visual size to(%f,%f)\n", visualSize.width, visualSize.height );
332 DALI_LOG_INFO( gLogButtonFilter, Debug::General, "ToggleButton::OnRelayout Setting visual position to(%f,%f)\n", visualPosition.x, visualPosition.y );
334 Property::Map visualTransform;
335 visualTransform.Add( Toolkit::Visual::Transform::Property::SIZE, visualSize )
336 .Add( Toolkit::Visual::Transform::Property::OFFSET, visualPosition )
337 .Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY, Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
338 .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY, Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
339 .Add( Toolkit::Visual::Transform::Property::ORIGIN, Toolkit::Align::CENTER )
340 .Add( Toolkit::Visual::Transform::Property::ANCHOR_POINT, Toolkit::Align::CENTER );
342 visual.SetTransformAndSize( visualTransform, size );
346 void ToggleButton::OnRelayout( const Vector2& size, RelayoutContainer& container )
348 DALI_LOG_INFO( gLogButtonFilter, Debug::General, "ToggleButton::OnRelayout targetSize(%f,%f) ptr(%p)\n", size.width, size.height, this );
350 RelayoutVisual( Toolkit::DevelButton::Property::UNSELECTED_VISUAL, size );
351 RelayoutVisual( Toolkit::DevelButton::Property::SELECTED_VISUAL, size );
352 RelayoutVisual( Toolkit::DevelButton::Property::DISABLED_UNSELECTED_VISUAL, size );
353 RelayoutVisual( Toolkit::DevelButton::Property::DISABLED_SELECTED_VISUAL, size );
356 void ToggleButton::OnPressed()
358 DALI_LOG_INFO( gLogButtonFilter, Debug::General, "ToggleButton::OnPressed\n" );
359 // State index will add 1 only when button is pressed.
360 mCurrentToggleIndex = ( mCurrentToggleIndex + 1 ) % mToggleVisuals.size();
362 // Both create SelectedVisual and UnselectedVisual
363 PrepareVisual( Toolkit::DevelButton::Property::UNSELECTED_VISUAL, mToggleVisuals[mCurrentToggleIndex] );
364 PrepareVisual( Toolkit::DevelButton::Property::SELECTED_VISUAL, mToggleSelectedVisuals[mCurrentToggleIndex] );
365 PrepareVisual( Toolkit::DevelButton::Property::DISABLED_UNSELECTED_VISUAL, mToggleDisabledVisuals[mCurrentToggleIndex] );
366 PrepareVisual( Toolkit::DevelButton::Property::DISABLED_SELECTED_VISUAL, mToggleDisabledSelectedVisuals[mCurrentToggleIndex] );
368 //Need to check mCurrentToggleIndex, it must less than the size of mToggleTooltips.
369 if ( !mToggleTooltips.empty() && ( mCurrentToggleIndex < mToggleTooltips.size() ) )
371 Self().SetProperty( Toolkit::DevelControl::Property::TOOLTIP, mToggleTooltips[mCurrentToggleIndex] );
377 } // namespace Internal
379 } // namespace Toolkit