2 * Copyright (c) 2020 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 "confirmation-popup-impl.h"
22 #include <dali/public-api/object/type-registry.h>
23 #include <dali/public-api/object/type-registry-helper.h>
39 * This struct is used to define all details required about a dynamically created signal.
41 struct ControlDetailType
43 const char* signalName;
44 const char* controlName;
45 const char* connectSignalPropertyName;
48 /* A table of all control details. These details are kept in one place for maintainability.
49 * Name of the signal | Name of the control | Name of the property which lets the
50 * the app-developer | which will provide | app developer choose which signal
51 * can connect to. | the signal. | within the control to connect to. */
52 const ControlDetailType ControlDetails[] = {
53 { "controlSignalOk", "controlOk", "connectSignalOkSelected" },
54 { "controlSignalCancel", "controlCancel", "connectSignalCancelSelected" },
56 const unsigned int ControlDetailsCount = sizeof( ControlDetails ) / sizeof( ControlDetails[0] );
58 // To give sensible default behaviour to save the connect signal properties being set.
59 const char* const DEFAULT_CONNECT_SIGNAL_NAME = "clicked";
63 return Toolkit::ConfirmationPopup::New();
66 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::ConfirmationPopup, Toolkit::Popup, Create )
68 DALI_PROPERTY_REGISTRATION( Toolkit, ConfirmationPopup, ControlDetails[0].connectSignalPropertyName, STRING, CONNECT_SIGNAL_OK_SELECTED )
69 DALI_PROPERTY_REGISTRATION( Toolkit, ConfirmationPopup, ControlDetails[1].connectSignalPropertyName, STRING, CONNECT_SIGNAL_CANCEL_SELECTED )
71 // Note: We do not use the macros for signal registration as we do not want to redefine the signal name strings.
72 // We have predefined them for optimal signal name to control name lookup.
73 SignalConnectorType signalConnector1( typeRegistration, ControlDetails[0].signalName, &Toolkit::Internal::ConfirmationPopup::DoConnectSignal );
74 SignalConnectorType signalConnector2( typeRegistration, ControlDetails[1].signalName, &Toolkit::Internal::ConfirmationPopup::DoConnectSignal );
76 DALI_TYPE_REGISTRATION_END()
78 } // Unnamed namespace
80 Dali::Toolkit::ConfirmationPopup ConfirmationPopup::New()
82 // Create the implementation, temporarily owned on stack.
83 IntrusivePtr< ConfirmationPopup > internalConfirmationPopup = new ConfirmationPopup();
85 // Pass ownership to CustomActor
86 Dali::Toolkit::ConfirmationPopup confirmationPopup( *internalConfirmationPopup );
88 // Second-phase initialisation of the implementation.
89 // This can only be done after the CustomActor connection has been made...
90 internalConfirmationPopup->Initialize();
92 return confirmationPopup;
95 ConfirmationPopup::ConfirmationPopup()
96 : Toolkit::Internal::Popup()
98 mControlSignals.reserve( MAXIMUM_NUMBER_OF_CONTROLS );
99 mControlSignalNames[ Toolkit::ConfirmationPopup::CONTROL_OK ] = DEFAULT_CONNECT_SIGNAL_NAME;
100 mControlSignalNames[ Toolkit::ConfirmationPopup::CONTROL_CANCEL ] = DEFAULT_CONNECT_SIGNAL_NAME;
103 ConfirmationPopup::~ConfirmationPopup()
105 for( SignalContainerType::iterator i = mControlSignals.begin(); i != mControlSignals.end(); ++i )
107 delete ( i->second );
109 mControlSignals.clear();
112 void ConfirmationPopup::SetProperty( BaseObject* object, Property::Index propertyIndex, const Property::Value& value )
114 Toolkit::ConfirmationPopup popup = Toolkit::ConfirmationPopup::DownCast( Dali::BaseHandle( object ) );
118 ConfirmationPopup& popupImpl( GetDerivedImplementation( popup ) );
120 switch ( propertyIndex )
122 case Toolkit::ConfirmationPopup::Property::CONNECT_SIGNAL_OK_SELECTED:
124 popupImpl.SetControlSignalName( Toolkit::ConfirmationPopup::CONTROL_OK, value.Get< std::string >() );
127 case Toolkit::ConfirmationPopup::Property::CONNECT_SIGNAL_CANCEL_SELECTED:
129 popupImpl.SetControlSignalName( Toolkit::ConfirmationPopup::CONTROL_CANCEL, value.Get< std::string >() );
136 Property::Value ConfirmationPopup::GetProperty( BaseObject* object, Property::Index propertyIndex )
138 Property::Value value;
140 Toolkit::ConfirmationPopup popup = Toolkit::ConfirmationPopup::DownCast( Dali::BaseHandle( object ) );
144 ConfirmationPopup& popupImpl( GetDerivedImplementation( popup ) );
146 switch ( propertyIndex )
148 case Toolkit::ConfirmationPopup::Property::CONNECT_SIGNAL_OK_SELECTED:
150 value = popupImpl.GetControlSignalName( Toolkit::ConfirmationPopup::CONTROL_OK );
153 case Toolkit::ConfirmationPopup::Property::CONNECT_SIGNAL_CANCEL_SELECTED:
155 value = popupImpl.GetControlSignalName( Toolkit::ConfirmationPopup::CONTROL_CANCEL );
164 void ConfirmationPopup::SetControlSignalName( const unsigned int controlNumber, const std::string& signalName )
166 if( controlNumber < ControlDetailsCount )
168 mControlSignalNames[ controlNumber ] = signalName;
172 std::string ConfirmationPopup::GetControlSignalName( unsigned int controlNumber ) const
174 if( controlNumber < ControlDetailsCount )
176 return mControlSignalNames[ controlNumber ];
182 bool ConfirmationPopup::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
184 Dali::BaseHandle handle( object );
185 Toolkit::ConfirmationPopup popup = Toolkit::ConfirmationPopup::DownCast( handle );
187 // Look up the requested signal, attempting to create it dynamically if it doesn't exist.
188 SignalDelegate* signalDelegate = Dali::Toolkit::GetDerivedImplementation( popup ).GetControlSignal( signalName );
191 // The signal delegate was created successfully, attempt to connect it to a callback if specified.
192 // If none is specified, the creation is still successful as the signal delegate can connect at a later time.
195 signalDelegate->Connect( tracker, functor );
200 // The signal could not be created.
204 SignalDelegate* ConfirmationPopup::GetControlSignal( const std::string& signalName )
206 // Check if the specified signal name already exists.
207 SignalContainerType::iterator end = mControlSignals.end();
208 for( SignalContainerType::iterator iter = mControlSignals.begin(); iter != end; ++iter )
210 // Find the first non-connected signal by matching signal name.
211 if( ( signalName == iter->first ) && ( !iter->second->IsConnected() ) )
213 // The requested signal (delegate) already exists, just return it.
218 // The signal doesn't exist, or it does but it's already connected to something else.
219 // To make a new connection to an existing signal, we need a new delegate,
220 // as delegates house a signal connection functor each.
221 // Check the signal name is valid and if so create the signal dynamically.
222 for( unsigned int i = 0; i < ControlDetailsCount; ++i )
224 if( 0 == strcmp( signalName.c_str(), ControlDetails[ i ].signalName ) )
226 // The signal name is valid, check the respective actor to connect to exists.
227 Actor connectActor = Self().FindChildByName( ControlDetails[ i ].controlName );
230 // The actor exists, set up a signal delegate that will allow the application developer
231 // to connect the actor signal directly to their callback.
232 // Note: We don't use the GetControlSignalName() here for speedup, as we know the array bound is capped.
233 SignalDelegate* signalDelegate = new SignalDelegate( connectActor, mControlSignalNames[ i ] );
235 // Store the delegate with the signal name so we know what signals have been dynamically created so far.
236 mControlSignals.push_back( std::make_pair( signalName, signalDelegate ) );
238 // Return the delegate to allow connection to the newly created signal.
239 return signalDelegate;
242 // Signal name valid but could not connect to the control,
247 // Signal name was not found (invalid).
252 } // namespace Internal
254 } // namespace Toolkit