1 #ifndef DALI_TOOLKIT_CONTROL_DATA_IMPL_H
2 #define DALI_TOOLKIT_CONTROL_DATA_IMPL_H
5 * Copyright (c) 2017 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/visual-factory/visual-base.h>
31 #include <dali-toolkit/internal/controls/tooltip/tooltip.h>
32 #include <dali-toolkit/internal/builder/style.h>
33 #include <dali-toolkit/internal/builder/dictionary.h>
45 * Struct used to store Visual within the control, index is a unique key for each visual.
47 struct RegisteredVisual
49 Property::Index index;
50 Toolkit::Visual::Base visual;
54 RegisteredVisual( Property::Index aIndex, Toolkit::Visual::Base &aVisual, bool aEnabled, bool aPendingReplacement )
55 : index(aIndex), visual(aVisual), enabled(aEnabled), pending( aPendingReplacement )
60 typedef Dali::OwnerContainer< RegisteredVisual* > RegisteredVisualContainer;
64 * @brief Holds the Implementation for the internal control class
66 class Control::Impl : public ConnectionTracker, public Visual::ResourceObserver
72 * @brief Retrieves the implementation of the internal control class.
73 * @param[in] internalControl A ref to the control whose internal implementation is required
74 * @return The internal implementation
76 static Control::Impl& Get( Internal::Control& internalControl );
79 * @copydoc Get( Internal::Control& )
81 static const Control::Impl& Get( const Internal::Control& internalControl );
85 * @param[in] controlImpl The control which own this implementation
87 Impl( Control& controlImpl );
95 * @brief Called when a pinch is detected.
96 * @param[in] actor The actor the pinch occurred on
97 * @param[in] pinch The pinch gesture details
99 void PinchDetected(Actor actor, const PinchGesture& pinch);
102 * @brief Called when a pan is detected.
103 * @param[in] actor The actor the pan occurred on
104 * @param[in] pinch The pan gesture details
106 void PanDetected(Actor actor, const PanGesture& pan);
109 * @brief Called when a tap is detected.
110 * @param[in] actor The actor the tap occurred on
111 * @param[in] pinch The tap gesture details
113 void TapDetected(Actor actor, const TapGesture& tap);
116 * @brief Called when a long-press is detected.
117 * @param[in] actor The actor the long-press occurred on
118 * @param[in] pinch The long-press gesture details
120 void LongPressDetected(Actor actor, const LongPressGesture& longPress);
123 * @brief Called when a resource is ready.
124 * @param[in] object The visual whose resources are ready
125 * @note Overriding method in Visual::ResourceObserver.
127 virtual void ResourceReady( Visual::Base& object );
130 * @copydoc Dali::Toolkit::DevelControl::RegisterVisual()
132 void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual );
135 * @copydoc Dali::Toolkit::DevelControl::RegisterVisual()
137 void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, int depthIndex );
140 * @copydoc Dali::Toolkit::DevelControl::RegisterVisual()
142 void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, bool enabled );
145 * @copydoc Dali::Toolkit::DevelControl::RegisterVisual()
147 void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, bool enabled, int depthIndex );
150 * @copydoc Dali::Toolkit::DevelControl::UnregisterVisual()
152 void UnregisterVisual( Property::Index index );
155 * @copydoc Dali::Toolkit::DevelControl::GetVisual()
157 Toolkit::Visual::Base GetVisual( Property::Index index ) const;
160 * @copydoc Dali::Toolkit::DevelControl::EnableVisual()
162 void EnableVisual( Property::Index index, bool enable );
165 * @copydoc Dali::Toolkit::DevelControl::IsVisualEnabled()
167 bool IsVisualEnabled( Property::Index index ) const;
170 * @brief Stops observing the given visual.
171 * @param[in] visual The visual to stop observing
173 void StopObservingVisual( Toolkit::Visual::Base& visual );
176 * @brief Starts observing the given visual.
177 * @param[in] visual The visual to start observing
179 void StartObservingVisual( Toolkit::Visual::Base& visual);
182 * @copydoc Dali::Toolkit::DevelControl::CreateTransition()
184 Dali::Animation CreateTransition( const Toolkit::TransitionData& transitionData );
187 * @brief Function used to set control properties.
188 * @param[in] object The object whose property to set
189 * @param[in] index The index of the property to set
190 * @param[in] value The value of the property to set
192 static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
195 * @brief Function used to retrieve the value of control properties.
196 * @param[in] object The object whose property to get
197 * @param[in] index The index of the property to get
198 * @return The value of the property
200 static Property::Value GetProperty( BaseObject* object, Property::Index index );
203 * @brief Sets the state of the control.
204 * @param[in] newState The state to set
205 * @param[in] withTransitions Whether to show a transition when changing to the new state
207 void SetState( DevelControl::State newState, bool withTransitions=true );
210 * @brief Sets the sub-state of the control.
211 * @param[in] newState The sub-state to set
212 * @param[in] withTransitions Whether to show a transition when changing to the new sub-state
214 void SetSubState( const std::string& subStateName, bool withTransitions=true );
217 * @brief Replaces visuals and properties from the old state to the new state.
218 * @param[in] oldState The old state
219 * @param[in] newState The new state
220 * @param[in] subState The current sub state
222 void ReplaceStateVisualsAndProperties( const StylePtr oldState, const StylePtr newState, const std::string& subState );
225 * @brief Removes a visual from the control's container.
226 * @param[in] visuals The container of visuals
227 * @param[in] visualName The name of the visual to remove
229 void RemoveVisual( RegisteredVisualContainer& visuals, const std::string& visualName );
232 * @brief Removes several visuals from the control's container.
233 * @param[in] visuals The container of visuals
234 * @param[in] removeVisuals The visuals to remove
236 void RemoveVisuals( RegisteredVisualContainer& visuals, DictionaryKeys& removeVisuals );
239 * @brief Copies the visual properties that are specific to the control instance into the instancedProperties container.
240 * @param[in] visuals The control's visual container
241 * @param[out] instancedProperties The instanced properties are added to this container
243 void CopyInstancedProperties( RegisteredVisualContainer& visuals, Dictionary<Property::Map>& instancedProperties );
246 * @brief On state change, ensures visuals are moved or created appropriately.
248 * Go through the list of visuals that are common to both states.
249 * If they are different types, or are both image types with different
250 * URLs, then the existing visual needs moving and the new visual needs creating
252 * @param[in] stateVisualsToChange The visuals to change
253 * @param[in] instancedProperties The instanced properties @see CopyInstancedProperties
255 void RecreateChangedVisuals( Dictionary<Property::Map>& stateVisualsToChange, Dictionary<Property::Map>& instancedProperties );
258 * @brief Whether the resource is ready
259 * @return True if the resource is read.
261 bool IsResourceReady() const;
264 * @copydoc CustomActorImpl::OnStageDisconnection()
266 void OnStageDisconnection();
269 * @brief Sets the margin.
270 * @param[in] margin Margin is a collections of extent ( start, end, top, bottom )
272 void SetMargin( Extents margin );
275 * @brief Returns the value of margin
276 * @return The value of margin
278 Extents GetMargin() const;
281 * @brief Sets the padding.
282 * @param[in] padding Padding is a collections of extent ( start, end, top, bottom ).
284 void SetPadding( Extents padding );
287 * @brief Returns the value of padding
288 * @return The value of padding
290 Extents GetPadding() const;
295 * Used as an alternative to boolean so that it is obvious whether a visual is enabled/disabled.
301 DISABLED = 0, ///< Visual disabled.
302 ENABLED = 1 ///< Visual enabled.
307 * 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.
309 struct DepthIndexValue
313 NOT_SET = 0, ///< Visual depth value not set by caller.
314 SET = 1 ///< Visual depth value set by caller.
319 * @brief Adds the visual to the list of registered visuals.
320 * @param[in] index The Property index of the visual, used to reference visual
321 * @param[in,out] visual The visual to register, which can be altered in this function
322 * @param[in] enabled false if derived class wants to control when visual is set on stage
323 * @param[in] depthIndexValueSet Set to true if the depthIndex has actually been set manually
324 * @param[in] depthIndex The visual's depth-index is set to this
326 * @note Registering a visual with an index that already has a registered visual will replace it. The replacement will
327 * occur once the replacement visual is ready (loaded).
329 void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, VisualState::Type enabled, DepthIndexValue::Type depthIndexValueSet, int depthIndex = 0 );
333 Control& mControlImpl;
334 DevelControl::State mState;
335 std::string mSubStateName;
337 int mLeftFocusableActorId; ///< Actor ID of Left focusable control.
338 int mRightFocusableActorId; ///< Actor ID of Right focusable control.
339 int mUpFocusableActorId; ///< Actor ID of Up focusable control.
340 int mDownFocusableActorId; ///< Actor ID of Down focusable control.
342 RegisteredVisualContainer mVisuals; ///< Stores visuals needed by the control, non trivial type so std::vector used.
343 std::string mStyleName;
344 Vector4 mBackgroundColor; ///< The color of the background visual
345 Vector3* mStartingPinchScale; ///< The scale when a pinch gesture starts, TODO: consider removing this
346 Extents mMargin; ///< The margin values
347 Extents mPadding; ///< The padding values
348 Toolkit::Control::KeyEventSignalType mKeyEventSignal;
349 Toolkit::Control::KeyInputFocusSignalType mKeyInputFocusGainedSignal;
350 Toolkit::Control::KeyInputFocusSignalType mKeyInputFocusLostSignal;
351 Toolkit::Control::ResourceReadySignalType mResourceReadySignal;
354 PinchGestureDetector mPinchGestureDetector;
355 PanGestureDetector mPanGestureDetector;
356 TapGestureDetector mTapGestureDetector;
357 LongPressGestureDetector mLongPressGestureDetector;
362 ControlBehaviour mFlags : CONTROL_BEHAVIOUR_FLAG_COUNT; ///< Flags passed in from constructor.
363 bool mIsKeyboardNavigationSupported :1; ///< Stores whether keyboard navigation is supported by the control.
364 bool mIsKeyboardFocusGroup :1; ///< Stores whether the control is a focus group.
366 RegisteredVisualContainer mRemoveVisuals; ///< List of visuals that are being replaced by another visual once ready
368 // Properties - these need to be members of Internal::Control::Impl as they access private methods/data of Internal::Control and Internal::Control::Impl.
369 static const PropertyRegistration PROPERTY_1;
370 static const PropertyRegistration PROPERTY_2;
371 static const PropertyRegistration PROPERTY_3;
372 static const PropertyRegistration PROPERTY_4;
373 static const PropertyRegistration PROPERTY_5;
374 static const PropertyRegistration PROPERTY_6;
375 static const PropertyRegistration PROPERTY_7;
376 static const PropertyRegistration PROPERTY_8;
377 static const PropertyRegistration PROPERTY_9;
378 static const PropertyRegistration PROPERTY_10;
379 static const PropertyRegistration PROPERTY_11;
380 static const PropertyRegistration PROPERTY_12;
381 static const PropertyRegistration PROPERTY_13;
382 static const PropertyRegistration PROPERTY_14;
386 } // namespace Internal
388 } // namespace Toolkit
392 #endif // DALI_TOOLKIT_CONTROL_DATA_IMPL_H