1 #ifndef __DALI_CUSTOM_ACTOR_IMPL_H__
2 #define __DALI_CUSTOM_ACTOR_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 <cstdint> // uint32_t
25 #include <dali/public-api/object/property.h>
26 #include <dali/public-api/object/ref-object.h>
27 #include <dali/public-api/actors/actor-enumerations.h>
28 #include <dali/public-api/math/compile-time-math.h>
33 * @addtogroup dali_core_actors
37 namespace Internal DALI_INTERNAL
45 class CustomActorImpl;
46 class RelayoutContainer;
55 * @brief Pointer to Dali::CustomActorImpl object.
58 typedef IntrusivePtr<CustomActorImpl> CustomActorImplPtr;
61 * @brief CustomActorImpl is an abstract base class for custom control implementations.
63 * This provides a series of pure virtual methods, which are called when actor-specific events occur.
64 * And CustomActorImpl is typically owned by a single CustomActor instance; see also CustomActor::CustomActor( CustomActorImpl &implementation ).
67 class DALI_CORE_API CustomActorImpl : public Dali::RefObject
71 class Extension; ///< Forward declare future extension interface
75 * @brief Virtual destructor
78 virtual ~CustomActorImpl();
82 * @brief Used by derived CustomActorImpl instances, to access the public Actor interface.
85 * @return A pointer to self, or an uninitialized pointer if the CustomActorImpl is not owned.
87 CustomActor Self() const;
90 * @brief Called after the actor has been connected to the stage.
92 * When an actor is connected, it will be directly or indirectly parented to the root Actor.
94 * @param[in] depth The depth in the hierarchy for the actor
96 * @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected.
97 * When the parent of a set of actors is connected to the stage, then all of the children
98 * will received this callback.
99 * For the following actor tree, the callback order will be A, B, D, E, C, and finally F.
110 * @param[in] depth The depth in the hierarchy for the actor
112 virtual void OnStageConnection( int32_t depth ) = 0;
115 * @brief Called after the actor has been disconnected from Stage.
117 * If an actor is disconnected, it either has no parent or is parented to a disconnected actor.
120 * @note When the parent of a set of actors is disconnected to the stage, then all of the children
121 * will received this callback, starting with the leaf actors.
122 * For the following actor tree, the callback order will be D, E, B, F, C, and finally A.
134 virtual void OnStageDisconnection() = 0;
137 * @brief Called after a child has been added to the owning actor.
140 * @param[in] child The child which has been added
142 virtual void OnChildAdd(Actor& child) = 0;
145 * @brief Called after the owning actor has attempted to remove a child (regardless of whether it succeeded or not).
148 * @param[in] child The child being removed
150 virtual void OnChildRemove(Actor& child) = 0;
153 * @brief Called when the owning actor property is set.
156 * @param[in] index The Property index that was set
157 * @param[in] propertyValue The value to set
159 virtual void OnPropertySet( Property::Index index, Property::Value propertyValue );
162 * @brief Called when the owning actor's size is set e.g. using Actor::SetSize().
165 * @param[in] targetSize The target size. Note that this target size may not match the size returned via @ref Actor::GetTargetSize
167 virtual void OnSizeSet(const Vector3& targetSize) = 0;
170 * @brief Called when the owning actor's size is animated e.g. using Animation::AnimateTo( Property( actor, Actor::Property::SIZE ), ... ).
173 * @param[in] animation The object which is animating the owning actor
174 * @param[in] targetSize The target size. Note that this target size may not match the size returned via @ref Actor::GetTargetSize
176 virtual void OnSizeAnimation(Animation& animation, const Vector3& targetSize) = 0;
179 * @DEPRECATED_1_1.37 Connect to TouchSignal() instead.
181 * @brief Called after a touch-event is received by the owning actor.
184 * @param[in] event The touch event
185 * @return True if the event should be consumed
186 * @note CustomActorImpl::REQUIRES_TOUCH_EVENTS must be enabled during construction. See CustomActorImpl::CustomActorImpl( ActorFlags flags ).
188 virtual bool OnTouchEvent(const TouchEvent& event) DALI_DEPRECATED_API = 0;
191 * @brief Called after a hover-event is received by the owning actor.
194 * @param[in] event The hover event
195 * @return True if the event should be consumed
196 * @note CustomActorImpl::REQUIRES_HOVER_EVENTS must be enabled during construction. See CustomActorImpl::CustomActorImpl( ActorFlags flags ).
198 virtual bool OnHoverEvent(const HoverEvent& event) = 0;
201 * @brief Called after a key-event is received by the actor that has had its focus set.
204 * @param[in] event The Key Event
205 * @return True if the event should be consumed
207 virtual bool OnKeyEvent(const KeyEvent& event) = 0;
210 * @brief Called after a wheel-event is received by the owning actor.
213 * @param[in] event The wheel event
214 * @return True if the event should be consumed
215 * @note CustomActorImpl::REQUIRES_WHEEL_EVENTS must be enabled during construction. See CustomActorImpl::CustomActorImpl( ActorFlags flags ).
217 virtual bool OnWheelEvent(const WheelEvent& event) = 0;
220 * @brief Called after the size negotiation has been finished for this control.
222 * The control is expected to assign this given size to itself/its children.
224 * Should be overridden by derived classes if they need to layout
225 * actors differently after certain operations like add or remove
226 * actors, resize or after changing specific properties.
229 * @param[in] size The allocated size
230 * @param[in,out] container The control should add actors to this container that it is not able
231 * to allocate a size for
232 * @note As this function is called from inside the size negotiation algorithm, you cannot
233 * call RequestRelayout (the call would just be ignored).
235 virtual void OnRelayout( const Vector2& size, RelayoutContainer& container ) = 0;
238 * @brief Notification for deriving classes.
241 * @param[in] policy The policy being set
242 * @param[in] dimension The dimension the policy is being set for
244 virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension ) = 0;
247 * @brief Returns the natural size of the actor.
250 * @return The actor's natural size
252 virtual Vector3 GetNaturalSize() = 0;
255 * @brief Calculates the size for a child.
258 * @param[in] child The child actor to calculate the size for
259 * @param[in] dimension The dimension to calculate the size for. E.g. width or height
260 * @return Return the calculated size for the given dimension
262 virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension ) = 0;
265 * @brief This method is called during size negotiation when a height is required for a given width.
267 * Derived classes should override this if they wish to customize the height returned.
270 * @param[in] width Width to use
271 * @return The height based on the width
273 virtual float GetHeightForWidth( float width ) = 0;
276 * @brief This method is called during size negotiation when a width is required for a given height.
278 * Derived classes should override this if they wish to customize the width returned.
281 * @param[in] height Height to use
282 * @return The width based on the width
284 virtual float GetWidthForHeight( float height ) = 0;
287 * @brief Determines if this actor is dependent on its children for relayout.
290 * @param[in] dimension The dimension(s) to check for
291 * @return Return if the actor is dependent on it's children
293 virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ) = 0;
296 * @brief Virtual method to notify deriving classes that relayout dependencies have been
297 * met and the size for this object is about to be calculated for the given dimension.
300 * @param[in] dimension The dimension that is about to be calculated
302 virtual void OnCalculateRelayoutSize( Dimension::Type dimension ) = 0;
305 * @brief Virtual method to notify deriving classes that the size for a dimension
306 * has just been negotiated.
309 * @param[in] size The new size for the given dimension
310 * @param[in] dimension The dimension that was just negotiated
312 virtual void OnLayoutNegotiated( float size, Dimension::Type dimension ) = 0;
315 * @brief Retrieves the extension for this control.
318 * @return The extension if available, NULL otherwise
320 virtual Extension* GetExtension()
325 protected: // For derived classes
328 * @brief Enumeration for the constructor flags.
333 ACTOR_BEHAVIOUR_NONE = 0, ///< Use if no change to default behaviour is needed. @DEPRECATED_1_2_10
334 ACTOR_BEHAVIOUR_DEFAULT = 0, ///< Use to provide default behaviour (size negotiation is on, event callbacks are not called). @SINCE_1_2_10
335 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
336 REQUIRES_TOUCH_EVENTS = 1 << 1, ///< True if the OnTouchEvent() callback is required. @SINCE_1_0.0
337 REQUIRES_HOVER_EVENTS = 1 << 2, ///< True if the OnHoverEvent() callback is required. @SINCE_1_0.0
338 REQUIRES_WHEEL_EVENTS = 1 << 3, ///< True if the OnWheelEvent() callback is required. @SINCE_1_0.0
340 LAST_ACTOR_FLAG ///< Special marker for last actor flag @SINCE_1_0.0
343 static const int32_t ACTOR_FLAG_COUNT = Log< LAST_ACTOR_FLAG - 1 >::value + 1; ///< Value for deriving classes to continue on the flag enum
346 * @brief Creates a CustomActorImpl.
348 * @param[in] flags Bitfield of ActorFlags to define behaviour
350 CustomActorImpl( ActorFlags flags );
352 // Size negotiation helpers
355 * @brief Requests a relayout, which means performing a size negotiation on this actor, its parent and children (and potentially whole scene).
357 * This method can also be called from a derived class every time it needs a different size.
358 * At the end of event processing, the relayout process starts and
359 * all controls which requested Relayout will have their sizes (re)negotiated.
362 * @note RelayoutRequest() can be called multiple times; the size negotiation is still
363 * only performed once, i.e. there is no need to keep track of this in the calling side.
365 void RelayoutRequest();
368 * @brief Provides the Actor implementation of GetHeightForWidth.
370 * @param[in] width Width to use
371 * @return The height based on the width
373 float GetHeightForWidthBase( float width );
376 * @brief Provides the Actor implementation of GetWidthForHeight.
378 * @param[in] height Height to use
379 * @return The width based on the height
381 float GetWidthForHeightBase( float height );
384 * @brief Calculates the size for a child using the base actor object.
387 * @param[in] child The child actor to calculate the size for
388 * @param[in] dimension The dimension to calculate the size for. E.g. width or height
389 * @return Return the calculated size for the given dimension. If more than one dimension is requested, just return the first one found
391 float CalculateChildSizeBase( const Dali::Actor& child, Dimension::Type dimension );
394 * @brief Determines if this actor is dependent on its children for relayout from the base class.
397 * @param[in] dimension The dimension(s) to check for
398 * @return Return if the actor is dependent on it's children
400 bool RelayoutDependentOnChildrenBase( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
402 public: // Not intended for application developers
405 * @brief Initializes a CustomActor.
407 * @param[in] owner The owning object
408 * @pre The CustomActorImpl is not already owned.
409 * @note Called when ownership of the CustomActorImpl is passed to a CustomActor.
411 void Initialize(Internal::CustomActor& owner);
414 * @brief Gets the owner.
416 * This method is needed when creating additional handle objects to existing objects.
417 * Owner is the Dali::Internal::CustomActor that owns the implementation of the custom actor
418 * inside core. Creation of a handle to Dali public API Actor requires this pointer.
420 * @return A pointer to the Actor implementation that owns this custom actor implementation
422 Internal::CustomActor* GetOwner() const;
425 * @brief Returns whether the OnTouchEvent() callback is required.
427 * @return True if the OnTouchEvent() callback is required
428 * @note Called when ownership of the CustomActorImpl is passed to a CustomActor.
430 bool RequiresTouchEvents() const;
433 * @brief Returns whether the OnHoverEvent() callback is required.
435 * @return True if the OnHoverEvent() callback is required
436 * @note Called when ownership of the CustomActorImpl is passed to a CustomActor.
438 bool RequiresHoverEvents() const;
441 * @brief Returns whether the OnWheelEvent() callback is required.
443 * @return True if the OnWheelEvent() callback is required
444 * @note Called when ownership of the CustomActorImpl is passed to a CustomActor.
446 bool RequiresWheelEvents() const;
449 * @brief Returns whether relayout is enabled.
451 * @return Return true if relayout is enabled on the custom actor
452 * @note Called when ownership of the CustomActorImpl is passed to a CustomActor.
454 bool IsRelayoutEnabled() const;
458 Internal::CustomActor* mOwner; ///< Internal owner of this custom actor implementation
459 ActorFlags mFlags :ACTOR_FLAG_COUNT; ///< ActorFlags flags to determine behaviour
467 #endif // __DALI_CUSTOM_ACTOR_IMPL_H__