1 #ifndef DALI_TOOLKIT_CONTROL_DATA_IMPL_H
2 #define DALI_TOOLKIT_CONTROL_DATA_IMPL_H
5 * Copyright (c) 2018 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>
27 #include <dali-toolkit/internal/visuals/visual-resource-observer.h>
28 #include <dali-toolkit/public-api/controls/control-impl.h>
29 #include <dali/devel-api/common/owner-container.h>
30 #include <dali-toolkit/devel-api/layouting/layout-item-impl.h>
31 #include <dali-toolkit/devel-api/visual-factory/visual-base.h>
32 #include <dali-toolkit/internal/controls/tooltip/tooltip.h>
33 #include <dali-toolkit/internal/builder/style.h>
34 #include <dali-toolkit/internal/builder/dictionary.h>
35 #include <dali-toolkit/public-api/visuals/visual-properties.h>
47 * Struct used to store Visual within the control, index is a unique key for each visual.
49 struct RegisteredVisual
51 Property::Index index;
52 Toolkit::Visual::Base visual;
56 RegisteredVisual( Property::Index aIndex, Toolkit::Visual::Base &aVisual, bool aEnabled, bool aPendingReplacement )
57 : index(aIndex), visual(aVisual), enabled(aEnabled), pending( aPendingReplacement )
62 typedef Dali::OwnerContainer< RegisteredVisual* > RegisteredVisualContainer;
66 * @brief Holds the Implementation for the internal control class
68 class Control::Impl : public ConnectionTracker, public Visual::ResourceObserver
74 * @brief Retrieves the implementation of the internal control class.
75 * @param[in] internalControl A ref to the control whose internal implementation is required
76 * @return The internal implementation
78 static Control::Impl& Get( Internal::Control& internalControl );
81 * @copydoc Get( Internal::Control& )
83 static const Control::Impl& Get( const Internal::Control& internalControl );
87 * @param[in] controlImpl The control which owns this implementation
89 Impl( Control& controlImpl );
97 * @brief Called when a pinch is detected.
98 * @param[in] actor The actor the pinch occurred on
99 * @param[in] pinch The pinch gesture details
101 void PinchDetected(Actor actor, const PinchGesture& pinch);
104 * @brief Called when a pan is detected.
105 * @param[in] actor The actor the pan occurred on
106 * @param[in] pinch The pan gesture details
108 void PanDetected(Actor actor, const PanGesture& pan);
111 * @brief Called when a tap is detected.
112 * @param[in] actor The actor the tap occurred on
113 * @param[in] pinch The tap gesture details
115 void TapDetected(Actor actor, const TapGesture& tap);
118 * @brief Called when a long-press is detected.
119 * @param[in] actor The actor the long-press occurred on
120 * @param[in] pinch The long-press gesture details
122 void LongPressDetected(Actor actor, const LongPressGesture& longPress);
125 * @brief Called when a resource is ready.
126 * @param[in] object The visual whose resources are ready
127 * @note Overriding method in Visual::ResourceObserver.
129 virtual void ResourceReady( Visual::Base& object );
132 * @copydoc Dali::Toolkit::DevelControl::RegisterVisual()
134 void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual );
137 * @copydoc Dali::Toolkit::DevelControl::RegisterVisual()
139 void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, int depthIndex );
142 * @copydoc Dali::Toolkit::DevelControl::RegisterVisual()
144 void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, bool enabled );
147 * @copydoc Dali::Toolkit::DevelControl::RegisterVisual()
149 void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, bool enabled, int depthIndex );
152 * @copydoc Dali::Toolkit::DevelControl::UnregisterVisual()
154 void UnregisterVisual( Property::Index index );
157 * @copydoc Dali::Toolkit::DevelControl::GetVisual()
159 Toolkit::Visual::Base GetVisual( Property::Index index ) const;
162 * @copydoc Dali::Toolkit::DevelControl::EnableVisual()
164 void EnableVisual( Property::Index index, bool enable );
167 * @copydoc Dali::Toolkit::DevelControl::IsVisualEnabled()
169 bool IsVisualEnabled( Property::Index index ) const;
172 * @brief Stops observing the given visual.
173 * @param[in] visual The visual to stop observing
175 void StopObservingVisual( Toolkit::Visual::Base& visual );
178 * @brief Starts observing the given visual.
179 * @param[in] visual The visual to start observing
181 void StartObservingVisual( Toolkit::Visual::Base& visual);
184 * @copydoc Dali::Toolkit::DevelControl::GetVisualResourceStatus()
186 Toolkit::Visual::ResourceStatus GetVisualResourceStatus( Property::Index index ) const;
189 * @param[in,out] animation Handle to existing animation, or an empty handle that
190 * can be set to a New animation if createAnimation is true
191 * @param[in] transitionData The transition data describing the animation
192 * @param[in] createAnimation True if the animation should be created
194 void AddTransitions( Dali::Animation& animation,
195 const Toolkit::TransitionData& transitionData,
196 bool createAnimation = false );
199 * @copydoc Dali::Toolkit::DevelControl::CreateTransition()
201 Dali::Animation CreateTransition( const Toolkit::TransitionData& transitionData );
204 * @copydoc Dali::Toolkit::DevelControl::DoAction()
206 void DoAction( Dali::Property::Index visualIndex, Dali::Property::Index actionId, const Dali::Property::Value attributes );
209 * @brief Function used to set control properties.
210 * @param[in] object The object whose property to set
211 * @param[in] index The index of the property to set
212 * @param[in] value The value of the property to set
214 static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
217 * @brief Function used to retrieve the value of control properties.
218 * @param[in] object The object whose property to get
219 * @param[in] index The index of the property to get
220 * @return The value of the property
222 static Property::Value GetProperty( BaseObject* object, Property::Index index );
225 * @brief Sets the state of the control.
226 * @param[in] newState The state to set
227 * @param[in] withTransitions Whether to show a transition when changing to the new state
229 void SetState( DevelControl::State newState, bool withTransitions=true );
232 * @brief Sets the sub-state of the control.
233 * @param[in] newState The sub-state to set
234 * @param[in] withTransitions Whether to show a transition when changing to the new sub-state
236 void SetSubState( const std::string& subStateName, bool withTransitions=true );
239 * @brief Replaces visuals and properties from the old state to the new state.
240 * @param[in] oldState The old state
241 * @param[in] newState The new state
242 * @param[in] subState The current sub state
244 void ReplaceStateVisualsAndProperties( const StylePtr oldState, const StylePtr newState, const std::string& subState );
247 * @brief Removes a visual from the control's container.
248 * @param[in] visuals The container of visuals
249 * @param[in] visualName The name of the visual to remove
251 void RemoveVisual( RegisteredVisualContainer& visuals, const std::string& visualName );
254 * @brief Removes several visuals from the control's container.
255 * @param[in] visuals The container of visuals
256 * @param[in] removeVisuals The visuals to remove
258 void RemoveVisuals( RegisteredVisualContainer& visuals, DictionaryKeys& removeVisuals );
261 * @brief Copies the visual properties that are specific to the control instance into the instancedProperties container.
262 * @param[in] visuals The control's visual container
263 * @param[out] instancedProperties The instanced properties are added to this container
265 void CopyInstancedProperties( RegisteredVisualContainer& visuals, Dictionary<Property::Map>& instancedProperties );
268 * @brief On state change, ensures visuals are moved or created appropriately.
270 * Go through the list of visuals that are common to both states.
271 * If they are different types, or are both image types with different
272 * URLs, then the existing visual needs moving and the new visual needs creating
274 * @param[in] stateVisualsToChange The visuals to change
275 * @param[in] instancedProperties The instanced properties @see CopyInstancedProperties
277 void RecreateChangedVisuals( Dictionary<Property::Map>& stateVisualsToChange, Dictionary<Property::Map>& instancedProperties );
280 * @brief Whether the resource is ready
281 * @return True if the resource is read.
283 bool IsResourceReady() const;
286 * @copydoc CustomActorImpl::OnStageDisconnection()
288 void OnStageDisconnection();
291 * @brief Sets the margin.
292 * @param[in] margin Margin is a collections of extent ( start, end, top, bottom )
294 void SetMargin( Extents margin );
297 * @brief Returns the value of margin
298 * @return The value of margin
300 Extents GetMargin() const;
303 * @brief Sets the padding.
304 * @param[in] padding Padding is a collections of extent ( start, end, top, bottom ).
306 void SetPadding( Extents padding );
309 * @brief Returns the value of padding
310 * @return The value of padding
312 Extents GetPadding() const;
315 * @brief Set the input method context.
316 * @param[in] inputMethodContext The input method context.
318 void SetInputMethodContext( InputMethodContext& inputMethodContext );
321 * @brief Filter an key event.
322 * @param[in] event The key to be filtered.
323 * @return True if the key handled, otherwise false.
325 bool FilterKeyEvent( const KeyEvent& event );
328 * @brief Get the layout associated with this control, if any.
330 * @return A pointer to the layout, or NULL.
332 Toolkit::Internal::LayoutItemPtr GetLayout() const;
335 * @brief Set the layout on this control.
336 * @param[in] layout Pointer to the layout
338 void SetLayout( Toolkit::Internal::LayoutItem& layout );
341 * @brief Remove the layout from this control
343 * @note This does not remove any children from this control, nor does it strip
344 * layouts from them but it does remove them from the layout hierarchy.
349 * @copydoc DevelControl::SetLayoutingRequired
351 void SetLayoutingRequired( bool layoutingRequired );
354 * @copydoc DevelControl::IsLayoutingRequired()
356 bool IsLayoutingRequired();
361 * Used as an alternative to boolean so that it is obvious whether a visual is enabled/disabled.
367 DISABLED = 0, ///< Visual disabled.
368 ENABLED = 1 ///< Visual enabled.
373 * 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.
375 struct DepthIndexValue
379 NOT_SET = 0, ///< Visual depth value not set by caller.
380 SET = 1 ///< Visual depth value set by caller.
385 * @brief Adds the visual to the list of registered visuals.
386 * @param[in] index The Property index of the visual, used to reference visual
387 * @param[in,out] visual The visual to register, which can be altered in this function
388 * @param[in] enabled false if derived class wants to control when visual is set on stage
389 * @param[in] depthIndexValueSet Set to true if the depthIndex has actually been set manually
390 * @param[in] depthIndex The visual's depth-index is set to this
392 * @note Registering a visual with an index that already has a registered visual will replace it. The replacement will
393 * occur once the replacement visual is ready (loaded).
395 void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, VisualState::Type enabled, DepthIndexValue::Type depthIndexValueSet, int depthIndex = 0 );
399 Control& mControlImpl;
400 DevelControl::State mState;
401 std::string mSubStateName;
404 Toolkit::Internal::LayoutItemPtr mLayout;
406 int mLeftFocusableActorId; ///< Actor ID of Left focusable control.
407 int mRightFocusableActorId; ///< Actor ID of Right focusable control.
408 int mUpFocusableActorId; ///< Actor ID of Up focusable control.
409 int mDownFocusableActorId; ///< Actor ID of Down focusable control.
411 RegisteredVisualContainer mVisuals; ///< Stores visuals needed by the control, non trivial type so std::vector used.
412 std::string mStyleName;
413 Vector4 mBackgroundColor; ///< The color of the background visual
414 Vector3* mStartingPinchScale; ///< The scale when a pinch gesture starts, TODO: consider removing this
415 Extents mMargin; ///< The margin values
416 Extents mPadding; ///< The padding values
417 Toolkit::Control::KeyEventSignalType mKeyEventSignal;
418 Toolkit::Control::KeyInputFocusSignalType mKeyInputFocusGainedSignal;
419 Toolkit::Control::KeyInputFocusSignalType mKeyInputFocusLostSignal;
420 Toolkit::Control::ResourceReadySignalType mResourceReadySignal;
423 PinchGestureDetector mPinchGestureDetector;
424 PanGestureDetector mPanGestureDetector;
425 TapGestureDetector mTapGestureDetector;
426 LongPressGestureDetector mLongPressGestureDetector;
431 InputMethodContext mInputMethodContext;
433 ControlBehaviour mFlags : CONTROL_BEHAVIOUR_FLAG_COUNT; ///< Flags passed in from constructor.
434 bool mIsKeyboardNavigationSupported :1; ///< Stores whether keyboard navigation is supported by the control.
435 bool mIsKeyboardFocusGroup :1; ///< Stores whether the control is a focus group.
436 bool mIsLayoutingRequired :1; ///< Stores whether the control needs to be Layout
438 RegisteredVisualContainer mRemoveVisuals; ///< List of visuals that are being replaced by another visual once ready
441 // Properties - these need to be members of Internal::Control::Impl as they access private methods/data of Internal::Control and Internal::Control::Impl.
442 static const PropertyRegistration PROPERTY_1;
443 static const PropertyRegistration PROPERTY_2;
444 static const PropertyRegistration PROPERTY_3;
445 static const PropertyRegistration PROPERTY_4;
446 static const PropertyRegistration PROPERTY_5;
447 static const PropertyRegistration PROPERTY_6;
448 static const PropertyRegistration PROPERTY_7;
449 static const PropertyRegistration PROPERTY_8;
450 static const PropertyRegistration PROPERTY_9;
451 static const PropertyRegistration PROPERTY_10;
452 static const PropertyRegistration PROPERTY_11;
453 static const PropertyRegistration PROPERTY_12;
454 static const PropertyRegistration PROPERTY_13;
455 static const PropertyRegistration PROPERTY_14;
459 } // namespace Internal
461 } // namespace Toolkit
465 #endif // DALI_TOOLKIT_CONTROL_DATA_IMPL_H