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 namespace Internal DALI_INTERNAL
38 class CustomActorImpl;
39 class RelayoutContainer;
49 * @brief Pointer to Dali::CustomActorImpl object.
51 typedef IntrusivePtr<CustomActorImpl> CustomActorImplPtr;
54 * @brief CustomActorImpl is an abstract base class for custom control implementations.
56 * This provides a series of pure virtual methods, which are called when actor-specific events occur.
57 * An CustomActorImpl is typically owned by a single CustomActor instance; see also CustomActor::New(CustomActorImplPtr).
59 class DALI_IMPORT_API CustomActorImpl : public Dali::RefObject
63 class Extension; ///< Forward declare future extension interface
66 * @brief Virtual destructor.
68 virtual ~CustomActorImpl();
71 * @brief Used by derived CustomActorImpl instances, to access the public Actor interface.
73 * @return A pointer to self, or an uninitialized pointer if the CustomActorImpl is not owned.
75 CustomActor Self() const;
78 * @brief Called after the actor has been connected to the stage.
80 * When an actor is connected, it will be directly or indirectly parented to the root Actor.
81 * @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected.
83 * @note When the parent of a set of actors is connected to the stage, then all of the children
84 * will received this callback.
86 * For the following actor tree, the callback order will be A, B, D, E, C, and finally F.
94 virtual void OnStageConnection() = 0;
97 * @brief Called after the actor has been disconnected from the stage.
99 * If an actor is disconnected it either has no parent, or is parented to a disconnected actor.
101 * @note When the parent of a set of actors is disconnected to the stage, then all of the children
102 * will received this callback, starting with the leaf actors.
104 * For the following actor tree, the callback order will be D, E, B, F, C, and finally A.
112 virtual void OnStageDisconnection() = 0;
115 * @brief Called after a child has been added to the owning actor.
117 * @param[in] child The child which has been added.
119 virtual void OnChildAdd(Actor& child) = 0;
122 * @brief Called after a child has been removed from the owning actor.
124 * @param[in] child The child being removed.
126 virtual void OnChildRemove(Actor& child) = 0;
129 * @brief Called when the owning actor property is set.
131 * @param[in] index The Property index that was set.
132 * @param[in] propertyValue The value to set.
134 virtual void OnPropertySet( Property::Index index, Property::Value propertyValue );
137 * @brief Called when the owning actor's size is set e.g. using Actor::SetSize().
139 * @param[in] targetSize The target size. Note that this target size may not match the size returned via Actor::GetSize().
141 virtual void OnSizeSet(const Vector3& targetSize) = 0;
144 * @brief Called when the owning actor's size is animated e.g. using Animation::AnimateTo( Property( actor, Actor::Property::SIZE ), ... ).
146 * @param[in] animation The object which is animating the owning actor.
147 * @param[in] targetSize The target size. Note that this target size may not match the size returned via Actor::GetSize().
149 virtual void OnSizeAnimation(Animation& animation, const Vector3& targetSize) = 0;
152 * @brief Called after a touch-event is received by the owning actor.
154 * @note This must be enabled during construction; see CustomActorImpl::CustomActorImpl(bool)
155 * @param[in] event The touch event.
156 * @return True if the event should be consumed.
158 virtual bool OnTouchEvent(const TouchEvent& event) = 0;
161 * @brief Called after a hover-event is received by the owning actor.
163 * @note This must be enabled during construction; see CustomActorImpl::SetRequiresHoverEvents(bool)
164 * @param[in] event The hover event.
165 * @return True if the event should be consumed.
167 virtual bool OnHoverEvent(const HoverEvent& event) = 0;
170 * @brief Called after a key-event is received by the actor that has had its focus set.
172 * @param[in] event the Key Event
173 * @return True if the event should be consumed.
175 virtual bool OnKeyEvent(const KeyEvent& event) = 0;
178 * @brief Called after a wheel-event is received by the owning actor.
180 * @note This must be enabled during construction; see CustomActorImpl::SetRequiresWheelEvents(bool)
181 * @param[in] event The wheel event.
182 * @return True if the event should be consumed.
184 virtual bool OnWheelEvent(const WheelEvent& event) = 0;
187 * @brief Called after the size negotiation has been finished for this control.
189 * The control is expected to assign this given size to itself/its children.
191 * Should be overridden by derived classes if they need to layout
192 * actors differently after certain operations like add or remove
193 * actors, resize or after changing specific properties.
195 * Note! As this function is called from inside the size negotiation algorithm, you cannot
196 * call RequestRelayout (the call would just be ignored)
198 * @param[in] size The allocated size.
199 * @param[in,out] container The control should add actors to this container that it is not able
200 * to allocate a size for.
202 virtual void OnRelayout( const Vector2& size, RelayoutContainer& container ) = 0;
205 * @brief Notification for deriving classes
207 * @param[in] policy The policy being set
208 * @param[in] dimension The dimension the policy is being set for
210 virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension ) = 0;
213 * Return the natural size of the actor
215 * @return The actor's natural size
217 virtual Vector3 GetNaturalSize() = 0;
220 * @brief Calculate the size for a child
222 * @param[in] child The child actor to calculate the size for
223 * @param[in] dimension The dimension to calculate the size for. E.g. width or height.
224 * @return Return the calculated size for the given dimension
226 virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension ) = 0;
229 * @brief This method is called during size negotiation when a height is required for a given width.
231 * Derived classes should override this if they wish to customize the height returned.
233 * @param width to use.
234 * @return the height based on the width.
236 virtual float GetHeightForWidth( float width ) = 0;
239 * @brief This method is called during size negotiation when a width is required for a given height.
241 * Derived classes should override this if they wish to customize the width returned.
243 * @param height to use.
244 * @return the width based on the width.
246 virtual float GetWidthForHeight( float height ) = 0;
249 * @brief Determine if this actor is dependent on it's children for relayout
251 * @param dimension The dimension(s) to check for
252 * @return Return if the actor is dependent on it's children
254 virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ) = 0;
257 * @brief Virtual method to notify deriving classes that relayout dependencies have been
258 * met and the size for this object is about to be calculated for the given dimension
260 * @param dimension The dimension that is about to be calculated
262 virtual void OnCalculateRelayoutSize( Dimension::Type dimension ) = 0;
265 * @brief Virtual method to notify deriving classes that the size for a dimension
266 * has just been negotiated
268 * @param[in] size The new size for the given dimension
269 * @param[in] dimension The dimension that was just negotiated
271 virtual void OnLayoutNegotiated( float size, Dimension::Type dimension ) = 0;
274 * Retrieve the extension for this control
276 * @return The extension if available, NULL otherwise
278 virtual Extension* GetExtension()
283 protected: // For derived classes
285 // Flags for the constructor
288 ACTOR_BEHAVIOUR_NONE = 0,
289 DISABLE_SIZE_NEGOTIATION = 1 << 0, ///< True if control does not need size negotiation, i.e. it can be skipped in the algorithm
290 REQUIRES_TOUCH_EVENTS = 1 << 1, ///< True if the OnTouchEvent() callback is required.
291 REQUIRES_HOVER_EVENTS = 1 << 2, ///< True if the OnHoverEvent() callback is required.
292 REQUIRES_WHEEL_EVENTS = 1 << 3, ///< True if the OnWheelEvent() callback is required.
294 LAST_ACTOR_FLAG ///< Special marker for last actor flag
297 static const int ACTOR_FLAG_COUNT = Log< LAST_ACTOR_FLAG - 1 >::value + 1; ///< Value for deriving classes to continue on the flag enum
300 * @brief Create a CustomActorImpl.
301 * @param[in] flags Bitfield of ActorFlags to define behaviour
303 CustomActorImpl( ActorFlags flags );
305 // Size negotiation helpers
308 * @brief Request a relayout, which means performing a size negotiation on this actor, its parent and children (and potentially whole scene)
310 * This method can also be called from a derived class every time it needs a different size.
311 * At the end of event processing, the relayout process starts and
312 * all controls which requested Relayout will have their sizes (re)negotiated.
314 * @note RelayoutRequest() can be called multiple times; the size negotiation is still
315 * only performed once, i.e. there is no need to keep track of this in the calling side.
317 void RelayoutRequest();
320 * @brief provides the Actor implementation of GetHeightForWidth
321 * @param width to use.
322 * @return the height based on the width.
324 float GetHeightForWidthBase( float width );
327 * @brief provides the Actor implementation of GetWidthForHeight
328 * @param height to use.
329 * @return the width based on the height.
331 float GetWidthForHeightBase( float height );
334 * @brief Calculate the size for a child using the base actor object
336 * @param[in] child The child actor to calculate the size for
337 * @param[in] dimension The dimension to calculate the size for. E.g. width or height.
338 * @return Return the calculated size for the given dimension
340 float CalculateChildSizeBase( const Dali::Actor& child, Dimension::Type dimension );
343 * @brief Determine if this actor is dependent on it's children for relayout from the base class
345 * @param dimension The dimension(s) to check for
346 * @return Return if the actor is dependent on it's children
348 bool RelayoutDependentOnChildrenBase( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
350 public: // Not intended for application developers
353 * @brief Called when ownership of the CustomActorImpl is passed to a CustomActor.
354 * @pre The CustomActorImpl is not already owned.
355 * @param[in] owner The owning object.
357 void Initialize(Internal::CustomActor& owner);
360 * @brief Get the owner.
362 * This method is needed when creating additional handle objects to existing objects.
363 * Owner is the Dali::Internal::CustomActor that owns the implementation of the custom actor
364 * inside core. Creation of a handle to Dali public API Actor requires this pointer.
365 * @return a pointer to the Actor implementation that owns this custom actor implementation
367 Internal::CustomActor* GetOwner() const;
370 * @brief Called when ownership of the CustomActorImpl is passed to a CustomActor.
371 * @return True if the OnTouchEvent() callback is required.
373 bool RequiresTouchEvents() const;
376 * @brief Called when ownership of the CustomActorImpl is passed to a CustomActor.
377 * @return True if the OnHoverEvent() callback is required.
379 bool RequiresHoverEvents() const;
382 * @brief Called when ownership of the CustomActorImpl is passed to a CustomActor.
383 * @return True if the OnWheelEvent() callback is required.
385 bool RequiresWheelEvents() const;
388 * @brief Called when ownership of the CustomActorImpl is passed to a CustomActor.
389 * @return Return true if relayout is enabled on the custom actor
391 bool IsRelayoutEnabled() const;
395 Internal::CustomActor* mOwner; ///< Internal owner of this custom actor implementation
396 ActorFlags mFlags :ACTOR_FLAG_COUNT; ///< ActorFlags flags to determine behaviour
401 #endif // __DALI_CUSTOM_ACTOR_IMPL_H__