1 #ifndef __DALI_CUSTOM_ACTOR_IMPL_H__
2 #define __DALI_CUSTOM_ACTOR_IMPL_H__
5 * Copyright (c) 2015 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
68 class Extension; ///< Forward declare future extension interface
71 * @brief Virtual destructor
74 virtual ~CustomActorImpl();
77 * @brief Used by derived CustomActorImpl instances, to access the public Actor interface.
80 * @return A pointer to self, or an uninitialized pointer if the CustomActorImpl is not owned.
82 CustomActor Self() const;
85 * @brief Called after the actor has been connected to the stage.
87 * When an actor is connected, it will be directly or indirectly parented to the root Actor.
89 * @param[in] depth The depth in the hierarchy for the actor
91 * @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected.
92 * When the parent of a set of actors is connected to the stage, then all of the children
93 * will received this callback.
94 * For the following actor tree, the callback order will be A, B, D, E, C, and finally F.
105 * @param[in] depth The depth in the hierarchy for the actor
107 virtual void OnStageConnection( int depth ) = 0;
110 * @brief Called after the actor has been disconnected from Stage.
112 * If an actor is disconnected it either has no parent, or is parented to a disconnected actor.
115 * @note When the parent of a set of actors is disconnected to the stage, then all of the children
116 * will received this callback, starting with the leaf actors.
117 * For the following actor tree, the callback order will be D, E, B, F, C, and finally A.
129 virtual void OnStageDisconnection() = 0;
132 * @brief Called after a child has been added to the owning actor.
135 * @param[in] child The child which has been added
137 virtual void OnChildAdd(Actor& child) = 0;
140 * @brief Called after a child has been removed from the owning actor.
143 * @param[in] child The child being removed
145 virtual void OnChildRemove(Actor& child) = 0;
148 * @brief Called when the owning actor property is set.
151 * @param[in] index The Property index that was set
152 * @param[in] propertyValue The value to set
154 virtual void OnPropertySet( Property::Index index, Property::Value propertyValue );
157 * @brief Called when the owning actor's size is set e.g. using Actor::SetSize().
160 * @param[in] targetSize The target size. Note that this target size may not match the size returned via @ref Actor::GetSize.
162 virtual void OnSizeSet(const Vector3& targetSize) = 0;
165 * @brief Called when the owning actor's size is animated e.g. using Animation::AnimateTo( Property( actor, Actor::Property::SIZE ), ... ).
168 * @param[in] animation The object which is animating the owning actor.
169 * @param[in] targetSize The target size. Note that this target size may not match the size returned via @ref Actor::GetSize.
171 virtual void OnSizeAnimation(Animation& animation, const Vector3& targetSize) = 0;
174 * @brief Called after a touch-event is received by the owning actor.
177 * @param[in] event The touch event
178 * @return True if the event should be consumed.
179 * @note CustomActorImpl::REQUIRES_TOUCH_EVENTS must be enabled during construction. See CustomActorImpl::CustomActorImpl( ActorFlags flags ).
181 virtual bool OnTouchEvent(const TouchEvent& event) = 0;
184 * @brief Called after a hover-event is received by the owning actor.
187 * @param[in] event The hover event
188 * @return True if the event should be consumed.
189 * @note CustomActorImpl::REQUIRES_HOVER_EVENTS must be enabled during construction. See CustomActorImpl::CustomActorImpl( ActorFlags flags ).
191 virtual bool OnHoverEvent(const HoverEvent& event) = 0;
194 * @brief Called after a key-event is received by the actor that has had its focus set.
197 * @param[in] event the Key Event
198 * @return True if the event should be consumed.
200 virtual bool OnKeyEvent(const KeyEvent& event) = 0;
203 * @brief Called after a wheel-event is received by the owning actor.
206 * @param[in] event The wheel event
207 * @return True if the event should be consumed.
208 * @note CustomActorImpl::REQUIRES_WHEEL_EVENTS must be enabled during construction. See CustomActorImpl::CustomActorImpl( ActorFlags flags ).
210 virtual bool OnWheelEvent(const WheelEvent& event) = 0;
213 * @brief Called after the size negotiation has been finished for this control.
215 * The control is expected to assign this given size to itself/its children.
217 * Should be overridden by derived classes if they need to layout
218 * actors differently after certain operations like add or remove
219 * actors, resize or after changing specific properties.
222 * @param[in] size The allocated size.
223 * @param[in,out] container The control should add actors to this container that it is not able
224 * to allocate a size for.
225 * @note As this function is called from inside the size negotiation algorithm, you cannot
226 * call RequestRelayout (the call would just be ignored).
228 virtual void OnRelayout( const Vector2& size, RelayoutContainer& container ) = 0;
231 * @brief Notification for deriving classes
234 * @param[in] policy The policy being set
235 * @param[in] dimension The dimension the policy is being set for
237 virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension ) = 0;
240 * @brief Return the natural size of the actor.
243 * @return The actor's natural size
245 virtual Vector3 GetNaturalSize() = 0;
248 * @brief Calculate the size for a child.
251 * @param[in] child The child actor to calculate the size for
252 * @param[in] dimension The dimension to calculate the size for. E.g. width or height.
253 * @return Return the calculated size for the given dimension.
255 virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension ) = 0;
258 * @brief This method is called during size negotiation when a height is required for a given width.
260 * Derived classes should override this if they wish to customize the height returned.
263 * @param width Width to use.
264 * @return The height based on the width.
266 virtual float GetHeightForWidth( float width ) = 0;
269 * @brief This method is called during size negotiation when a width is required for a given height.
271 * Derived classes should override this if they wish to customize the width returned.
274 * @param height Height to use.
275 * @return The width based on the width.
277 virtual float GetWidthForHeight( float height ) = 0;
280 * @brief Determine if this actor is dependent on it's children for relayout.
283 * @param dimension The dimension(s) to check for
284 * @return Return if the actor is dependent on it's children.
286 virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ) = 0;
289 * @brief Virtual method to notify deriving classes that relayout dependencies have been
290 * met and the size for this object is about to be calculated for the given dimension
293 * @param dimension The dimension that is about to be calculated
295 virtual void OnCalculateRelayoutSize( Dimension::Type dimension ) = 0;
298 * @brief Virtual method to notify deriving classes that the size for a dimension
299 * has just been negotiated
302 * @param[in] size The new size for the given dimension
303 * @param[in] dimension The dimension that was just negotiated
305 virtual void OnLayoutNegotiated( float size, Dimension::Type dimension ) = 0;
308 * @brief Retrieve the extension for this control.
311 * @return The extension if available, NULL otherwise
313 virtual Extension* GetExtension()
318 protected: // For derived classes
320 // Flags for the constructor
323 ACTOR_BEHAVIOUR_NONE = 0,
324 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
325 REQUIRES_TOUCH_EVENTS = 1 << 1, ///< True if the OnTouchEvent() callback is required. @SINCE_1_0.0
326 REQUIRES_HOVER_EVENTS = 1 << 2, ///< True if the OnHoverEvent() callback is required. @SINCE_1_0.0
327 REQUIRES_WHEEL_EVENTS = 1 << 3, ///< True if the OnWheelEvent() callback is required. @SINCE_1_0.0
329 LAST_ACTOR_FLAG ///< Special marker for last actor flag @SINCE_1_0.0
332 static const int ACTOR_FLAG_COUNT = Log< LAST_ACTOR_FLAG - 1 >::value + 1; ///< Value for deriving classes to continue on the flag enum
335 * @brief Create a CustomActorImpl.
337 * @param[in] flags Bitfield of ActorFlags to define behaviour
339 CustomActorImpl( ActorFlags flags );
341 // Size negotiation helpers
344 * @brief Request a relayout, which means performing a size negotiation on this actor, its parent and children (and potentially whole scene).
346 * This method can also be called from a derived class every time it needs a different size.
347 * At the end of event processing, the relayout process starts and
348 * all controls which requested Relayout will have their sizes (re)negotiated.
351 * @note RelayoutRequest() can be called multiple times; the size negotiation is still
352 * only performed once, i.e. there is no need to keep track of this in the calling side.
354 void RelayoutRequest();
357 * @brief Provides the Actor implementation of GetHeightForWidth.
359 * @param width Width to use.
360 * @return The height based on the width.
362 float GetHeightForWidthBase( float width );
365 * @brief Provides the Actor implementation of GetWidthForHeight.
367 * @param height Height to use.
368 * @return The width based on the height.
370 float GetWidthForHeightBase( float height );
373 * @brief Calculate the size for a child using the base actor object.
376 * @param[in] child The child actor to calculate the size for
377 * @param[in] dimension The dimension to calculate the size for. E.g. width or height
378 * @return Return the calculated size for the given dimension. If more than one dimension is requested, just return the first one found.
380 float CalculateChildSizeBase( const Dali::Actor& child, Dimension::Type dimension );
383 * @brief Determine if this actor is dependent on it's children for relayout from the base class.
386 * @param dimension The dimension(s) to check for
387 * @return Return if the actor is dependent on it's children.
389 bool RelayoutDependentOnChildrenBase( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
391 public: // Not intended for application developers
394 * @brief Initialize a CustomActor.
396 * @param[in] owner The owning object
397 * @pre The CustomActorImpl is not already owned.
398 * @note Called when ownership of the CustomActorImpl is passed to a CustomActor.
400 void Initialize(Internal::CustomActor& owner);
403 * @brief Get the owner.
405 * This method is needed when creating additional handle objects to existing objects.
406 * Owner is the Dali::Internal::CustomActor that owns the implementation of the custom actor
407 * inside core. Creation of a handle to Dali public API Actor requires this pointer.
409 * @return A pointer to the Actor implementation that owns this custom actor implementation
411 Internal::CustomActor* GetOwner() const;
414 * @brief Returns whether the OnTouchEvent() callback is required.
416 * @return True if the OnTouchEvent() callback is required.
417 * @note Called when ownership of the CustomActorImpl is passed to a CustomActor.
419 bool RequiresTouchEvents() const;
422 * @brief Returns whether the OnHoverEvent() callback is required.
424 * @return True if the OnHoverEvent() callback is required.
425 * @note Called when ownership of the CustomActorImpl is passed to a CustomActor.
427 bool RequiresHoverEvents() const;
430 * @brief Returns whether the OnWheelEvent() callback is required.
432 * @return True if the OnWheelEvent() callback is required.
433 * @note Called when ownership of the CustomActorImpl is passed to a CustomActor.
435 bool RequiresWheelEvents() const;
438 * @brief Returns whether relayout is enabled.
440 * @return Return true if relayout is enabled on the custom actor.
441 * @note Called when ownership of the CustomActorImpl is passed to a CustomActor.
443 bool IsRelayoutEnabled() const;
447 Internal::CustomActor* mOwner; ///< Internal owner of this custom actor implementation
448 ActorFlags mFlags :ACTOR_FLAG_COUNT; ///< ActorFlags flags to determine behaviour
456 #endif // __DALI_CUSTOM_ACTOR_IMPL_H__