1 #ifndef __DALI_CUSTOM_ACTOR_IMPL_H__
2 #define __DALI_CUSTOM_ACTOR_IMPL_H__
5 * Copyright (c) 2014 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/common/vector-wrapper.h>
23 #include <dali/public-api/object/property.h>
24 #include <dali/public-api/object/ref-object.h>
25 #include <dali/public-api/actors/actor-enumerations.h>
30 namespace Internal DALI_INTERNAL
38 class CustomActorImpl;
39 class RelayoutContainer;
43 struct MouseWheelEvent;
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
64 * @brief Virtual destructor.
66 virtual ~CustomActorImpl();
69 * @brief Used by derived CustomActorImpl instances, to access the public Actor interface.
71 * @return A pointer to self, or an uninitialized pointer if the CustomActorImpl is not owned.
73 CustomActor Self() const;
76 * @brief Called after the actor has been connected to the stage.
78 * When an actor is connected, it will be directly or indirectly parented to the root Actor.
79 * @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected.
81 * @note When the parent of a set of actors is connected to the stage, then all of the children
82 * will received this callback.
84 * For the following actor tree, the callback order will be A, B, D, E, C, and finally F.
92 virtual void OnStageConnection() = 0;
95 * @brief Called after the actor has been disconnected from the stage.
97 * If an actor is disconnected it either has no parent, or is parented to a disconnected actor.
99 * @note When the parent of a set of actors is disconnected to the stage, then all of the children
100 * will received this callback, starting with the leaf actors.
102 * For the following actor tree, the callback order will be D, E, B, F, C, and finally A.
110 virtual void OnStageDisconnection() = 0;
113 * @brief Called after a child has been added to the owning actor.
115 * @param[in] child The child which has been added.
117 virtual void OnChildAdd(Actor& child) = 0;
120 * @brief Called after a child has been removed from the owning actor.
122 * @param[in] child The child being removed.
124 virtual void OnChildRemove(Actor& child) = 0;
127 * @brief Called when the owning actor property is set.
129 * @param[in] index The Property index that was set.
130 * @param[in] propertyValue The value to set.
132 virtual void OnPropertySet( Property::Index index, Property::Value propertyValue ) ;
135 * @brief Called when the owning actor's size is set e.g. using Actor::SetSize().
137 * @param[in] targetSize The target size. Note that this target size may not match the size returned via Actor::GetSize().
139 virtual void OnSizeSet(const Vector3& targetSize) = 0;
142 * @brief Called when the owning actor's size is animated e.g. using Animation::Resize().
144 * @param[in] animation The object which is animating the owning actor.
145 * @param[in] targetSize The target size. Note that this target size may not match the size returned via Actor::GetSize().
147 virtual void OnSizeAnimation(Animation& animation, const Vector3& targetSize) = 0;
150 * @brief Called after a touch-event is received by the owning actor.
152 * @note This must be enabled during construction; see CustomActorImpl::CustomActorImpl(bool)
153 * @param[in] event The touch event.
154 * @return True if the event should be consumed.
156 virtual bool OnTouchEvent(const TouchEvent& event) = 0;
159 * @brief Called after a hover-event is received by the owning actor.
161 * @note This must be enabled during construction; see CustomActorImpl::SetRequiresHoverEvents(bool)
162 * @param[in] event The hover event.
163 * @return True if the event should be consumed.
165 virtual bool OnHoverEvent(const HoverEvent& event) = 0;
168 * @brief Called after a key-event is received by the actor that has had its focus set.
170 * @param[in] event the Key Event
171 * @return True if the event should be consumed.
173 virtual bool OnKeyEvent(const KeyEvent& event) = 0;
176 * @brief Called after a mouse-wheel-event is received by the owning actor.
178 * @note This must be enabled during construction; see CustomActorImpl::SetRequiresMouseWheelEvents(bool)
179 * @param[in] event The mouse wheel event.
180 * @return True if the event should be consumed.
182 virtual bool OnMouseWheelEvent(const MouseWheelEvent& event) = 0;
185 * @brief Called after the size negotiation has been finished for this control.
187 * The control is expected to assign this given size to itself/its children.
189 * Should be overridden by derived classes if they need to layout
190 * actors differently after certain operations like add or remove
191 * actors, resize or after changing specific properties.
193 * Note! As this function is called from inside the size negotiation algorithm, you cannot
194 * call RequestRelayout (the call would just be ignored)
196 * @param[in] size The allocated size.
197 * @param[in,out] container The control should add actors to this container that it is not able
198 * to allocate a size for.
200 virtual void OnRelayout( const Vector2& size, RelayoutContainer& container ) = 0;
203 * @brief Notification for deriving classes
205 * @param[in] policy The policy being set
206 * @param[in] dimension The dimension the policy is being set for
208 virtual void OnSetResizePolicy( ResizePolicy policy, Dimension dimension ) = 0;
211 * Return the natural size of the actor
213 * @return The actor's natural size
215 virtual Vector3 GetNaturalSize() = 0;
218 * @brief Calculate the size for a child
220 * @param[in] child The child actor to calculate the size for
221 * @param[in] dimension The dimension to calculate the size for. E.g. width or height.
222 * @return Return the calculated size for the given dimension
224 virtual float CalculateChildSize( const Dali::Actor& child, Dimension dimension ) = 0;
227 * @brief This method is called during size negotiation when a height is required for a given width.
229 * Derived classes should override this if they wish to customize the height returned.
231 * @param width to use.
232 * @return the height based on the width.
234 virtual float GetHeightForWidth( float width ) = 0;
237 * @brief This method is called during size negotiation when a width is required for a given height.
239 * Derived classes should override this if they wish to customize the width returned.
241 * @param height to use.
242 * @return the width based on the width.
244 virtual float GetWidthForHeight( float height ) = 0;
247 * @brief Determine if this actor is dependent on it's children for relayout
249 * @param dimension The dimension(s) to check for
250 * @return Return if the actor is dependent on it's children
252 virtual bool RelayoutDependentOnChildren( Dimension dimension = ALL_DIMENSIONS ) = 0;
255 * @brief Virtual method to notify deriving classes that relayout dependencies have been
256 * met and the size for this object is about to be calculated for the given dimension
258 * @param dimension The dimension that is about to be calculated
260 virtual void OnCalculateRelayoutSize( Dimension dimension ) = 0;
263 * @brief Virtual method to notify deriving classes that the size for a dimension
264 * has just been negotiated
266 * @param[in] size The new size for the given dimension
267 * @param[in] dimension The dimension that was just negotiated
269 virtual void OnLayoutNegotiated( float size, Dimension dimension ) = 0;
271 protected: // For derived classes
274 * @brief Create a CustomActorImpl.
275 * @param[in] requiresTouchEvents True if the OnTouchEvent() callback is required.
277 CustomActorImpl(bool requiresTouchEvents);
280 * @brief Set whether the custom actor requires hover events.
281 * @param[in] requiresHoverEvents True if the OnHoverEvent() callback is required.
283 void SetRequiresHoverEvents(bool requiresHoverEvents);
286 * @brief Set whether the custom actor requires mouse wheel events.
287 * @param[in] requiresMouseWheelEvents True if the OnMouseWheelEvent() callback is required.
289 void SetRequiresMouseWheelEvents(bool requiresMouseWheelEvents);
292 * @brief Request a relayout, which means performing a size negotiation on this actor, its parent and children (and potentially whole scene)
294 * This method can also be called from a derived class every time it needs a different size.
295 * At the end of event processing, the relayout process starts and
296 * all controls which requested Relayout will have their sizes (re)negotiated.
298 * @note RelayoutRequest() can be called multiple times; the size negotiation is still
299 * only performed once, i.e. there is no need to keep track of this in the calling side.
301 void RelayoutRequest();
304 * @brief Calculate the size for a child using the base actor object
306 * @param[in] child The child actor to calculate the size for
307 * @param[in] dimension The dimension to calculate the size for. E.g. width or height.
308 * @return Return the calculated size for the given dimension
310 float CalculateChildSizeBase( const Dali::Actor& child, Dimension dimension );
313 * @brief Determine if this actor is dependent on it's children for relayout from the base class
315 * @param dimension The dimension(s) to check for
316 * @return Return if the actor is dependent on it's children
318 bool RelayoutDependentOnChildrenBase( Dimension dimension = ALL_DIMENSIONS );
320 public: // Not intended for application developers
323 * @brief Called when ownership of the CustomActorImpl is passed to a CustomActor.
324 * @pre The CustomActorImpl is not already owned.
325 * @param[in] owner The owning object.
327 void Initialize(Internal::CustomActor& owner);
330 * @brief Get the owner.
332 * This method is needed when creating additional handle objects to existing objects.
333 * Owner is the Dali::Internal::CustomActor that owns the implementation of the custom actor
334 * inside core. Creation of a handle to Dali public API Actor requires this pointer.
335 * @return a pointer to the Actor implementation that owns this custom actor implementation
337 Internal::CustomActor* GetOwner() const;
340 * @brief Called when ownership of the CustomActorImpl is passed to a CustomActor.
341 * @return True if the OnTouchEvent() callback is required.
343 bool RequiresTouchEvents() const;
346 * @brief Called when ownership of the CustomActorImpl is passed to a CustomActor.
347 * @return True if the OnHoverEvent() callback is required.
349 bool RequiresHoverEvents() const;
352 * @brief Called when ownership of the CustomActorImpl is passed to a CustomActor.
353 * @return True if the OnMouseWheelEvent() callback is required.
355 bool RequiresMouseWheelEvents() const;
359 Internal::CustomActor* mOwner; ///< Internal owner of this custom actor implementation
360 bool mRequiresTouchEvents; ///< Whether the OnTouchEvent() callback is required
361 bool mRequiresHoverEvents; ///< Whether the OnHoverEvent() callback is required
362 bool mRequiresMouseWheelEvents; ///< Whether the OnMouseWheelEvent() callback is required
367 #endif // __DALI_CUSTOM_ACTOR_IMPL_H__