1 #ifndef DALI_TOOLKIT_CONTROL_DATA_IMPL_H
2 #define DALI_TOOLKIT_CONTROL_DATA_IMPL_H
5 * Copyright (c) 2019 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali/public-api/object/type-registry.h>
23 #include <dali-toolkit/devel-api/controls/control-devel.h>
24 #include <dali/devel-api/adaptor-framework/autofill-item.h>
25 #include <dali/devel-api/adaptor-framework/autofill-manager.h>
29 #include <dali-toolkit/internal/visuals/visual-event-observer.h>
30 #include <dali-toolkit/public-api/controls/control-impl.h>
31 #include <dali-toolkit/devel-api/controls/text-controls/autofill-container.h>
32 #include <dali/devel-api/common/owner-container.h>
33 #include <dali-toolkit/devel-api/visual-factory/visual-base.h>
34 #include <dali-toolkit/internal/controls/tooltip/tooltip.h>
35 #include <dali-toolkit/internal/builder/style.h>
36 #include <dali-toolkit/internal/builder/dictionary.h>
37 #include <dali-toolkit/public-api/visuals/visual-properties.h>
49 * Struct used to store Visual within the control, index is a unique key for each visual.
51 struct RegisteredVisual
53 Property::Index index;
54 Toolkit::Visual::Base visual;
58 RegisteredVisual( Property::Index aIndex, Toolkit::Visual::Base &aVisual, bool aEnabled, bool aPendingReplacement )
59 : index(aIndex), visual(aVisual), enabled(aEnabled), pending( aPendingReplacement )
64 typedef Dali::OwnerContainer< RegisteredVisual* > RegisteredVisualContainer;
68 * @brief Holds the Implementation for the internal control class
70 class Control::Impl : public ConnectionTracker, public Visual::EventObserver
76 * @brief Retrieves the implementation of the internal control class.
77 * @param[in] internalControl A ref to the control whose internal implementation is required
78 * @return The internal implementation
80 static Control::Impl& Get( Internal::Control& internalControl );
83 * @copydoc Get( Internal::Control& )
85 static const Control::Impl& Get( const Internal::Control& internalControl );
89 * @param[in] controlImpl The control which owns this implementation
91 Impl( Control& controlImpl );
99 * @brief Called when a pinch is detected.
100 * @param[in] actor The actor the pinch occurred on
101 * @param[in] pinch The pinch gesture details
103 void PinchDetected(Actor actor, const PinchGesture& pinch);
106 * @brief Called when a pan is detected.
107 * @param[in] actor The actor the pan occurred on
108 * @param[in] pinch The pan gesture details
110 void PanDetected(Actor actor, const PanGesture& pan);
113 * @brief Called when a tap is detected.
114 * @param[in] actor The actor the tap occurred on
115 * @param[in] pinch The tap gesture details
117 void TapDetected(Actor actor, const TapGesture& tap);
120 * @brief Called when a long-press is detected.
121 * @param[in] actor The actor the long-press occurred on
122 * @param[in] pinch The long-press gesture details
124 void LongPressDetected(Actor actor, const LongPressGesture& longPress);
127 * @brief Called when a resource is ready.
128 * @param[in] object The visual whose resources are ready
129 * @note Overriding method in Visual::EventObserver.
131 void ResourceReady( Visual::Base& object ) override;
134 * @brief Called when an event occurs.
135 * @param[in] object The visual whose events occur
136 * @param[in] signalId The signal to emit. See Visual to find supported signals
137 * @note Overriding method in Visual::EventObserver.
139 void NotifyVisualEvent( Visual::Base& object, Property::Index signalId ) override;
142 * @copydoc Dali::Toolkit::DevelControl::RegisterVisual()
144 void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual );
147 * @copydoc Dali::Toolkit::DevelControl::RegisterVisual()
149 void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, int depthIndex );
152 * @copydoc Dali::Toolkit::DevelControl::RegisterVisual()
154 void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, bool enabled );
157 * @copydoc Dali::Toolkit::DevelControl::RegisterVisual()
159 void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, bool enabled, int depthIndex );
162 * @copydoc Dali::Toolkit::DevelControl::UnregisterVisual()
164 void UnregisterVisual( Property::Index index );
167 * @copydoc Dali::Toolkit::DevelControl::GetVisual()
169 Toolkit::Visual::Base GetVisual( Property::Index index ) const;
172 * @copydoc Dali::Toolkit::DevelControl::EnableVisual()
174 void EnableVisual( Property::Index index, bool enable );
177 * @copydoc Dali::Toolkit::DevelControl::IsVisualEnabled()
179 bool IsVisualEnabled( Property::Index index ) const;
182 * @brief Stops observing the given visual.
183 * @param[in] visual The visual to stop observing
185 void StopObservingVisual( Toolkit::Visual::Base& visual );
188 * @brief Starts observing the given visual.
189 * @param[in] visual The visual to start observing
191 void StartObservingVisual( Toolkit::Visual::Base& visual);
194 * @copydoc Dali::Toolkit::DevelControl::GetVisualResourceStatus()
196 Toolkit::Visual::ResourceStatus GetVisualResourceStatus( Property::Index index ) const;
199 * @param[in,out] animation Handle to existing animation, or an empty handle that
200 * can be set to a New animation if createAnimation is true
201 * @param[in] transitionData The transition data describing the animation
202 * @param[in] createAnimation True if the animation should be created
204 void AddTransitions( Dali::Animation& animation,
205 const Toolkit::TransitionData& transitionData,
206 bool createAnimation = false );
209 * @copydoc Dali::Toolkit::DevelControl::CreateTransition()
211 Dali::Animation CreateTransition( const Toolkit::TransitionData& transitionData );
214 * @copydoc Dali::Toolkit::DevelControl::DoAction()
216 void DoAction( Dali::Property::Index visualIndex, Dali::Property::Index actionId, const Dali::Property::Value attributes );
219 * @brief Function used to set control properties.
220 * @param[in] object The object whose property to set
221 * @param[in] index The index of the property to set
222 * @param[in] value The value of the property to set
224 static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
227 * @brief Function used to retrieve the value of control properties.
228 * @param[in] object The object whose property to get
229 * @param[in] index The index of the property to get
230 * @return The value of the property
232 static Property::Value GetProperty( BaseObject* object, Property::Index index );
235 * @brief Sets the state of the control.
236 * @param[in] newState The state to set
237 * @param[in] withTransitions Whether to show a transition when changing to the new state
239 void SetState( DevelControl::State newState, bool withTransitions=true );
242 * @brief Sets the sub-state of the control.
243 * @param[in] newState The sub-state to set
244 * @param[in] withTransitions Whether to show a transition when changing to the new sub-state
246 void SetSubState( const std::string& subStateName, bool withTransitions=true );
249 * @brief Replaces visuals and properties from the old state to the new state.
250 * @param[in] oldState The old state
251 * @param[in] newState The new state
252 * @param[in] subState The current sub state
254 void ReplaceStateVisualsAndProperties( const StylePtr oldState, const StylePtr newState, const std::string& subState );
257 * @brief Removes a visual from the control's container.
258 * @param[in] visuals The container of visuals
259 * @param[in] visualName The name of the visual to remove
261 void RemoveVisual( RegisteredVisualContainer& visuals, const std::string& visualName );
264 * @brief Removes several visuals from the control's container.
265 * @param[in] visuals The container of visuals
266 * @param[in] removeVisuals The visuals to remove
268 void RemoveVisuals( RegisteredVisualContainer& visuals, DictionaryKeys& removeVisuals );
271 * @brief Copies the visual properties that are specific to the control instance into the instancedProperties container.
272 * @param[in] visuals The control's visual container
273 * @param[out] instancedProperties The instanced properties are added to this container
275 void CopyInstancedProperties( RegisteredVisualContainer& visuals, Dictionary<Property::Map>& instancedProperties );
278 * @brief On state change, ensures visuals are moved or created appropriately.
280 * Go through the list of visuals that are common to both states.
281 * If they are different types, or are both image types with different
282 * URLs, then the existing visual needs moving and the new visual needs creating
284 * @param[in] stateVisualsToChange The visuals to change
285 * @param[in] instancedProperties The instanced properties @see CopyInstancedProperties
287 void RecreateChangedVisuals( Dictionary<Property::Map>& stateVisualsToChange, Dictionary<Property::Map>& instancedProperties );
290 * @brief Whether the resource is ready
291 * @return True if the resource is read.
293 bool IsResourceReady() const;
296 * @copydoc CustomActorImpl::OnSceneDisconnection()
298 void OnSceneDisconnection();
301 * @brief Sets the margin.
302 * @param[in] margin Margin is a collections of extent ( start, end, top, bottom )
304 void SetMargin( Extents margin );
307 * @brief Returns the value of margin
308 * @return The value of margin
310 Extents GetMargin() const;
313 * @brief Sets the padding.
314 * @param[in] padding Padding is a collections of extent ( start, end, top, bottom ).
316 void SetPadding( Extents padding );
319 * @brief Returns the value of padding
320 * @return The value of padding
322 Extents GetPadding() const;
325 * @brief Set the input method context.
326 * @param[in] inputMethodContext The input method context.
328 void SetInputMethodContext( InputMethodContext& inputMethodContext );
331 * @brief Filter an key event.
332 * @param[in] event The key to be filtered.
333 * @return True if the key handled, otherwise false.
335 bool FilterKeyEvent( const KeyEvent& event );
338 * @copydoc DevelControl::VisualEventSignal()
340 DevelControl::VisualEventSignalType& VisualEventSignal();
343 * @brief Sets the shadow with a property map.
344 * @param[in] map The shadow property map
346 void SetShadow(const Property::Map& map);
349 * @brief Clear the shadow.
354 * @brief Sets whether the Autofill functionality is enabled.
355 * @param[in] autofillEnabled Set true when Autofill should be enabled.
357 void SetAutofillEnabled( bool autofillEnabled );
360 * @brief Check if the Autofill framework is enabled.
361 * @return True if Autofill is enabled
363 bool IsAutofillEnabled();
366 * @brief Sets AutofillItemHandle
367 * @param item AutofillItem handle
369 void SetAutofillItemHandle( Dali::AutofillItem item );
372 * @brief Gets AutofillItemHandle
373 * @return AutofillItem handle
375 Dali::AutofillItem GetAutofillItemHandle();
378 * @brief Sets AutofillContainer which this control belongs to.
379 * @param[in] container
381 void SetAutofillContainer( Toolkit::AutofillContainer container );
384 * @brief Gets AutofillContainer that the control belongs to.
385 * @return AutofillContainer handle
387 Toolkit::AutofillContainer GetAutofillContainer();
392 * Used as an alternative to boolean so that it is obvious whether a visual is enabled/disabled.
398 DISABLED = 0, ///< Visual disabled.
399 ENABLED = 1 ///< Visual enabled.
404 * Used as an alternative to boolean so that it is obvious whether a visual's depth value has been set or not by the caller.
406 struct DepthIndexValue
410 NOT_SET = 0, ///< Visual depth value not set by caller.
411 SET = 1 ///< Visual depth value set by caller.
416 * @brief Adds the visual to the list of registered visuals.
417 * @param[in] index The Property index of the visual, used to reference visual
418 * @param[in,out] visual The visual to register, which can be altered in this function
419 * @param[in] enabled false if derived class wants to control when visual is set on stage
420 * @param[in] depthIndexValueSet Set to true if the depthIndex has actually been set manually
421 * @param[in] depthIndex The visual's depth-index is set to this
423 * @note Registering a visual with an index that already has a registered visual will replace it. The replacement will
424 * occur once the replacement visual is ready (loaded).
426 void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, VisualState::Type enabled, DepthIndexValue::Type depthIndexValueSet, int depthIndex = 0 );
429 * @brief Emits the resource ready signal.
431 void EmitResourceReadySignal();
434 * @brief Callbacks called on idle.
436 void OnIdleCallback();
440 Control& mControlImpl;
441 DevelControl::State mState;
442 std::string mSubStateName;
444 int mLeftFocusableActorId; ///< Actor ID of Left focusable control.
445 int mRightFocusableActorId; ///< Actor ID of Right focusable control.
446 int mUpFocusableActorId; ///< Actor ID of Up focusable control.
447 int mDownFocusableActorId; ///< Actor ID of Down focusable control.
449 RegisteredVisualContainer mVisuals; ///< Stores visuals needed by the control, non trivial type so std::vector used.
450 std::string mStyleName;
451 Vector4 mBackgroundColor; ///< The color of the background visual
452 Vector3* mStartingPinchScale; ///< The scale when a pinch gesture starts, TODO: consider removing this
453 Extents mMargin; ///< The margin values
454 Extents mPadding; ///< The padding values
455 Toolkit::Control::KeyEventSignalType mKeyEventSignal;
456 Toolkit::Control::KeyInputFocusSignalType mKeyInputFocusGainedSignal;
457 Toolkit::Control::KeyInputFocusSignalType mKeyInputFocusLostSignal;
458 Toolkit::Control::ResourceReadySignalType mResourceReadySignal;
459 DevelControl::VisualEventSignalType mVisualEventSignal;
462 PinchGestureDetector mPinchGestureDetector;
463 PanGestureDetector mPanGestureDetector;
464 TapGestureDetector mTapGestureDetector;
465 LongPressGestureDetector mLongPressGestureDetector;
470 InputMethodContext mInputMethodContext;
471 CallbackBase* mIdleCallback; ///< The idle callback to emit the resource ready signal.
472 AutofillItem mAutofillItem;
473 Toolkit::AutofillContainer mAutofillContainer;
475 ControlBehaviour mFlags : CONTROL_BEHAVIOUR_FLAG_COUNT; ///< Flags passed in from constructor.
476 bool mIsKeyboardNavigationSupported :1; ///< Stores whether keyboard navigation is supported by the control.
477 bool mIsKeyboardFocusGroup :1; ///< Stores whether the control is a focus group.
478 bool mIsEmittingResourceReadySignal :1; ///< True during ResourceReady().
479 bool mNeedToEmitResourceReady :1; ///< True if need to emit the resource ready signal again.
480 bool mIsAutofillEnabled : 1; ///< Stroes whether the Autofill functionality is enabled.
482 RegisteredVisualContainer mRemoveVisuals; ///< List of visuals that are being replaced by another visual once ready
485 // Properties - these need to be members of Internal::Control::Impl as they access private methods/data of Internal::Control and Internal::Control::Impl.
486 static const PropertyRegistration PROPERTY_1;
487 static const PropertyRegistration PROPERTY_2;
488 static const PropertyRegistration PROPERTY_3;
489 static const PropertyRegistration PROPERTY_4;
490 static const PropertyRegistration PROPERTY_5;
491 static const PropertyRegistration PROPERTY_6;
492 static const PropertyRegistration PROPERTY_7;
493 static const PropertyRegistration PROPERTY_8;
494 static const PropertyRegistration PROPERTY_9;
495 static const PropertyRegistration PROPERTY_10;
496 static const PropertyRegistration PROPERTY_11;
497 static const PropertyRegistration PROPERTY_12;
498 static const PropertyRegistration PROPERTY_13;
499 static const PropertyRegistration PROPERTY_14;
500 static const PropertyRegistration PROPERTY_15;
504 } // namespace Internal
506 } // namespace Toolkit
510 #endif // DALI_TOOLKIT_CONTROL_DATA_IMPL_H