1 #ifndef __DALI_CUSTOM_ACTOR_IMPL_H__
2 #define __DALI_CUSTOM_ACTOR_IMPL_H__
5 * Copyright (c) 2016 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/property.h>
23 #include <dali/public-api/object/ref-object.h>
24 #include <dali/public-api/actors/actor-enumerations.h>
25 #include <dali/public-api/math/compile-time-math.h>
30 * @addtogroup dali_core_actors
34 namespace Internal DALI_INTERNAL
42 class CustomActorImpl;
43 class RelayoutContainer;
52 * @brief Pointer to Dali::CustomActorImpl object.
55 typedef IntrusivePtr<CustomActorImpl> CustomActorImplPtr;
58 * @brief CustomActorImpl is an abstract base class for custom control implementations.
60 * This provides a series of pure virtual methods, which are called when actor-specific events occur.
61 * And CustomActorImpl is typically owned by a single CustomActor instance; see also CustomActor::CustomActor( CustomActorImpl &implementation ).
64 class DALI_IMPORT_API CustomActorImpl : public Dali::RefObject
69 * @brief Virtual destructor
72 virtual ~CustomActorImpl();
76 class Extension; ///< Forward declare future extension interface
79 * @brief Used by derived CustomActorImpl instances, to access the public Actor interface.
82 * @return A pointer to self, or an uninitialized pointer if the CustomActorImpl is not owned.
84 CustomActor Self() const;
87 * @brief Called after the actor has been connected to the stage.
89 * When an actor is connected, it will be directly or indirectly parented to the root Actor.
91 * @param[in] depth The depth in the hierarchy for the actor
93 * @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected.
94 * When the parent of a set of actors is connected to the stage, then all of the children
95 * will received this callback.
96 * For the following actor tree, the callback order will be A, B, D, E, C, and finally F.
107 * @param[in] depth The depth in the hierarchy for the actor
109 virtual void OnStageConnection( int depth ) = 0;
112 * @brief Called after the actor has been disconnected from Stage.
114 * If an actor is disconnected it either has no parent, or is parented to a disconnected actor.
117 * @note When the parent of a set of actors is disconnected to the stage, then all of the children
118 * will received this callback, starting with the leaf actors.
119 * For the following actor tree, the callback order will be D, E, B, F, C, and finally A.
131 virtual void OnStageDisconnection() = 0;
134 * @brief Called after a child has been added to the owning actor.
137 * @param[in] child The child which has been added
139 virtual void OnChildAdd(Actor& child) = 0;
142 * @brief Called after the owning actor has attempted to remove a child( regardless of whether it succeeded or not ).
145 * @param[in] child The child being removed
147 virtual void OnChildRemove(Actor& child) = 0;
150 * @brief Called when the owning actor property is set.
153 * @param[in] index The Property index that was set
154 * @param[in] propertyValue The value to set
156 virtual void OnPropertySet( Property::Index index, Property::Value propertyValue );
159 * @brief Called when the owning actor's size is set e.g. using Actor::SetSize().
162 * @param[in] targetSize The target size. Note that this target size may not match the size returned via @ref Actor::GetTargetSize.
164 virtual void OnSizeSet(const Vector3& targetSize) = 0;
167 * @brief Called when the owning actor's size is animated e.g. using Animation::AnimateTo( Property( actor, Actor::Property::SIZE ), ... ).
170 * @param[in] animation The object which is animating the owning actor.
171 * @param[in] targetSize The target size. Note that this target size may not match the size returned via @ref Actor::GetTargetSize.
173 virtual void OnSizeAnimation(Animation& animation, const Vector3& targetSize) = 0;
176 * @DEPRECATED_1_1.37 Connect to TouchSignal() instead.
178 * @brief Called after a touch-event is received by the owning actor.
181 * @param[in] event The touch event
182 * @return True if the event should be consumed.
183 * @note CustomActorImpl::REQUIRES_TOUCH_EVENTS must be enabled during construction. See CustomActorImpl::CustomActorImpl( ActorFlags flags ).
185 virtual bool OnTouchEvent(const TouchEvent& event) DALI_DEPRECATED_API = 0;
188 * @brief Called after a hover-event is received by the owning actor.
191 * @param[in] event The hover event
192 * @return True if the event should be consumed.
193 * @note CustomActorImpl::REQUIRES_HOVER_EVENTS must be enabled during construction. See CustomActorImpl::CustomActorImpl( ActorFlags flags ).
195 virtual bool OnHoverEvent(const HoverEvent& event) = 0;
198 * @brief Called after a key-event is received by the actor that has had its focus set.
201 * @param[in] event the Key Event
202 * @return True if the event should be consumed.
204 virtual bool OnKeyEvent(const KeyEvent& event) = 0;
207 * @brief Called after a wheel-event is received by the owning actor.
210 * @param[in] event The wheel event
211 * @return True if the event should be consumed.
212 * @note CustomActorImpl::REQUIRES_WHEEL_EVENTS must be enabled during construction. See CustomActorImpl::CustomActorImpl( ActorFlags flags ).
214 virtual bool OnWheelEvent(const WheelEvent& event) = 0;
217 * @brief Called after the size negotiation has been finished for this control.
219 * The control is expected to assign this given size to itself/its children.
221 * Should be overridden by derived classes if they need to layout
222 * actors differently after certain operations like add or remove
223 * actors, resize or after changing specific properties.
226 * @param[in] size The allocated size.
227 * @param[in,out] container The control should add actors to this container that it is not able
228 * to allocate a size for.
229 * @note As this function is called from inside the size negotiation algorithm, you cannot
230 * call RequestRelayout (the call would just be ignored).
232 virtual void OnRelayout( const Vector2& size, RelayoutContainer& container ) = 0;
235 * @brief Notification for deriving classes
238 * @param[in] policy The policy being set
239 * @param[in] dimension The dimension the policy is being set for
241 virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension ) = 0;
244 * @brief Return the natural size of the actor.
247 * @return The actor's natural size
249 virtual Vector3 GetNaturalSize() = 0;
252 * @brief Calculate the size for a child.
255 * @param[in] child The child actor to calculate the size for
256 * @param[in] dimension The dimension to calculate the size for. E.g. width or height.
257 * @return Return the calculated size for the given dimension.
259 virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension ) = 0;
262 * @brief This method is called during size negotiation when a height is required for a given width.
264 * Derived classes should override this if they wish to customize the height returned.
267 * @param width Width to use.
268 * @return The height based on the width.
270 virtual float GetHeightForWidth( float width ) = 0;
273 * @brief This method is called during size negotiation when a width is required for a given height.
275 * Derived classes should override this if they wish to customize the width returned.
278 * @param height Height to use.
279 * @return The width based on the width.
281 virtual float GetWidthForHeight( float height ) = 0;
284 * @brief Determine if this actor is dependent on it's children for relayout.
287 * @param dimension The dimension(s) to check for
288 * @return Return if the actor is dependent on it's children.
290 virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ) = 0;
293 * @brief Virtual method to notify deriving classes that relayout dependencies have been
294 * met and the size for this object is about to be calculated for the given dimension
297 * @param dimension The dimension that is about to be calculated
299 virtual void OnCalculateRelayoutSize( Dimension::Type dimension ) = 0;
302 * @brief Virtual method to notify deriving classes that the size for a dimension
303 * has just been negotiated
306 * @param[in] size The new size for the given dimension
307 * @param[in] dimension The dimension that was just negotiated
309 virtual void OnLayoutNegotiated( float size, Dimension::Type dimension ) = 0;
312 * @brief Retrieve the extension for this control.
315 * @return The extension if available, NULL otherwise
317 virtual Extension* GetExtension()
322 protected: // For derived classes
325 * @brief Flags for the constructor
330 ACTOR_BEHAVIOUR_NONE = 0, ///< Use if no change to default behaviour is needed. @DEPRECATED_1_2_10
331 ACTOR_BEHAVIOUR_DEFAULT = 0, ///< Use to provide default behaviour (size negotiation is on, event callbacks are not called). @SINCE_1_2_10
332 DISABLE_SIZE_NEGOTIATION = 1 << 0, ///< True if control does not need size negotiation, i.e. it can be skipped in the algorithm @SINCE_1_0.0
333 REQUIRES_TOUCH_EVENTS = 1 << 1, ///< True if the OnTouchEvent() callback is required. @SINCE_1_0.0
334 REQUIRES_HOVER_EVENTS = 1 << 2, ///< True if the OnHoverEvent() callback is required. @SINCE_1_0.0
335 REQUIRES_WHEEL_EVENTS = 1 << 3, ///< True if the OnWheelEvent() callback is required. @SINCE_1_0.0
337 LAST_ACTOR_FLAG ///< Special marker for last actor flag @SINCE_1_0.0
340 static const int ACTOR_FLAG_COUNT = Log< LAST_ACTOR_FLAG - 1 >::value + 1; ///< Value for deriving classes to continue on the flag enum
343 * @brief Create a CustomActorImpl.
345 * @param[in] flags Bitfield of ActorFlags to define behaviour
347 CustomActorImpl( ActorFlags flags );
349 // Size negotiation helpers
352 * @brief Request a relayout, which means performing a size negotiation on this actor, its parent and children (and potentially whole scene).
354 * This method can also be called from a derived class every time it needs a different size.
355 * At the end of event processing, the relayout process starts and
356 * all controls which requested Relayout will have their sizes (re)negotiated.
359 * @note RelayoutRequest() can be called multiple times; the size negotiation is still
360 * only performed once, i.e. there is no need to keep track of this in the calling side.
362 void RelayoutRequest();
365 * @brief Provides the Actor implementation of GetHeightForWidth.
367 * @param width Width to use.
368 * @return The height based on the width.
370 float GetHeightForWidthBase( float width );
373 * @brief Provides the Actor implementation of GetWidthForHeight.
375 * @param height Height to use.
376 * @return The width based on the height.
378 float GetWidthForHeightBase( float height );
381 * @brief Calculate the size for a child using the base actor object.
384 * @param[in] child The child actor to calculate the size for
385 * @param[in] dimension The dimension to calculate the size for. E.g. width or height
386 * @return Return the calculated size for the given dimension. If more than one dimension is requested, just return the first one found.
388 float CalculateChildSizeBase( const Dali::Actor& child, Dimension::Type dimension );
391 * @brief Determine if this actor is dependent on it's children for relayout from the base class.
394 * @param dimension The dimension(s) to check for
395 * @return Return if the actor is dependent on it's children.
397 bool RelayoutDependentOnChildrenBase( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
399 public: // Not intended for application developers
402 * @brief Initialize a CustomActor.
404 * @param[in] owner The owning object
405 * @pre The CustomActorImpl is not already owned.
406 * @note Called when ownership of the CustomActorImpl is passed to a CustomActor.
408 void Initialize(Internal::CustomActor& owner);
411 * @brief Get the owner.
413 * This method is needed when creating additional handle objects to existing objects.
414 * Owner is the Dali::Internal::CustomActor that owns the implementation of the custom actor
415 * inside core. Creation of a handle to Dali public API Actor requires this pointer.
417 * @return A pointer to the Actor implementation that owns this custom actor implementation
419 Internal::CustomActor* GetOwner() const;
422 * @brief Returns whether the OnTouchEvent() callback is required.
424 * @return True if the OnTouchEvent() callback is required.
425 * @note Called when ownership of the CustomActorImpl is passed to a CustomActor.
427 bool RequiresTouchEvents() const;
430 * @brief Returns whether the OnHoverEvent() callback is required.
432 * @return True if the OnHoverEvent() callback is required.
433 * @note Called when ownership of the CustomActorImpl is passed to a CustomActor.
435 bool RequiresHoverEvents() const;
438 * @brief Returns whether the OnWheelEvent() callback is required.
440 * @return True if the OnWheelEvent() callback is required.
441 * @note Called when ownership of the CustomActorImpl is passed to a CustomActor.
443 bool RequiresWheelEvents() const;
446 * @brief Returns whether relayout is enabled.
448 * @return Return true if relayout is enabled on the custom actor.
449 * @note Called when ownership of the CustomActorImpl is passed to a CustomActor.
451 bool IsRelayoutEnabled() const;
455 Internal::CustomActor* mOwner; ///< Internal owner of this custom actor implementation
456 ActorFlags mFlags :ACTOR_FLAG_COUNT; ///< ActorFlags flags to determine behaviour
464 #endif // __DALI_CUSTOM_ACTOR_IMPL_H__