X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fpublic-api%2Factors%2Fcustom-actor-impl.h;h=6fc6240501fe1b1ce402c7035f19393f193ee5b3;hb=e08e2992259823c5f9832ad959ffa510b0445a6c;hp=18803df0a0629a12694e10b00f873d42cb47883f;hpb=6a51fca768ccd75d552b73c0a67056721dc86e44;p=platform%2Fcore%2Fuifw%2Fdali-core.git diff --git a/dali/public-api/actors/custom-actor-impl.h b/dali/public-api/actors/custom-actor-impl.h index 18803df..6fc6240 100644 --- a/dali/public-api/actors/custom-actor-impl.h +++ b/dali/public-api/actors/custom-actor-impl.h @@ -2,7 +2,7 @@ #define __DALI_CUSTOM_ACTOR_IMPL_H__ /* - * Copyright (c) 2015 Samsung Electronics Co., Ltd. + * Copyright (c) 2018 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -18,8 +18,10 @@ * */ +// EXTERNAL INCLUDES +#include // uint32_t + // INTERNAL INCLUDES -#include #include #include #include @@ -27,6 +29,10 @@ namespace Dali { +/** + * @addtogroup dali_core_actors + * @{ + */ namespace Internal DALI_INTERNAL { @@ -41,13 +47,13 @@ class RelayoutContainer; struct KeyEvent; struct TouchEvent; struct HoverEvent; -struct MouseWheelEvent; +struct WheelEvent; struct Vector2; struct Vector3; - /** * @brief Pointer to Dali::CustomActorImpl object. + * @SINCE_1_0.0 */ typedef IntrusivePtr CustomActorImplPtr; @@ -55,20 +61,27 @@ typedef IntrusivePtr CustomActorImplPtr; * @brief CustomActorImpl is an abstract base class for custom control implementations. * * This provides a series of pure virtual methods, which are called when actor-specific events occur. - * An CustomActorImpl is typically owned by a single CustomActor instance; see also CustomActor::New(CustomActorImplPtr). + * And CustomActorImpl is typically owned by a single CustomActor instance; see also CustomActor::CustomActor( CustomActorImpl &implementation ). + * @SINCE_1_0.0 */ -class DALI_IMPORT_API CustomActorImpl : public Dali::RefObject +class DALI_CORE_API CustomActorImpl : public Dali::RefObject { public: + class Extension; ///< Forward declare future extension interface + +protected: /** - * @brief Virtual destructor. + * @brief Virtual destructor + * @SINCE_1_0.0 */ virtual ~CustomActorImpl(); +public: /** * @brief Used by derived CustomActorImpl instances, to access the public Actor interface. * + * @SINCE_1_0.0 * @return A pointer to self, or an uninitialized pointer if the CustomActorImpl is not owned. */ CustomActor Self() const; @@ -77,110 +90,131 @@ public: * @brief Called after the actor has been connected to the stage. * * When an actor is connected, it will be directly or indirectly parented to the root Actor. - * @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected. + * @SINCE_1_0.0 + * @param[in] depth The depth in the hierarchy for the actor * - * @note When the parent of a set of actors is connected to the stage, then all of the children + * @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected. + * When the parent of a set of actors is connected to the stage, then all of the children * will received this callback. - * * For the following actor tree, the callback order will be A, B, D, E, C, and finally F. * + * @code + * * A (parent) * / \ * B C * / \ \ * D E F + * + * @endcode + * @param[in] depth The depth in the hierarchy for the actor */ - virtual void OnStageConnection() = 0; + virtual void OnStageConnection( int32_t depth ) = 0; /** - * @brief Called after the actor has been disconnected from the stage. + * @brief Called after the actor has been disconnected from Stage. * - * If an actor is disconnected it either has no parent, or is parented to a disconnected actor. + * If an actor is disconnected, it either has no parent or is parented to a disconnected actor. * + * @SINCE_1_0.0 * @note When the parent of a set of actors is disconnected to the stage, then all of the children * will received this callback, starting with the leaf actors. - * * For the following actor tree, the callback order will be D, E, B, F, C, and finally A. * + * @code + * * A (parent) * / \ * B C * / \ \ * D E F + * + * @endcode */ virtual void OnStageDisconnection() = 0; /** * @brief Called after a child has been added to the owning actor. * - * @param[in] child The child which has been added. + * @SINCE_1_0.0 + * @param[in] child The child which has been added */ virtual void OnChildAdd(Actor& child) = 0; /** - * @brief Called after a child has been removed from the owning actor. + * @brief Called after the owning actor has attempted to remove a child (regardless of whether it succeeded or not). * - * @param[in] child The child being removed. + * @SINCE_1_0.0 + * @param[in] child The child being removed */ virtual void OnChildRemove(Actor& child) = 0; /** * @brief Called when the owning actor property is set. * - * @param[in] index The Property index that was set. - * @param[in] propertyValue The value to set. + * @SINCE_1_0.0 + * @param[in] index The Property index that was set + * @param[in] propertyValue The value to set */ - virtual void OnPropertySet( Property::Index index, Property::Value propertyValue ) ; + virtual void OnPropertySet( Property::Index index, Property::Value propertyValue ); /** * @brief Called when the owning actor's size is set e.g. using Actor::SetSize(). * - * @param[in] targetSize The target size. Note that this target size may not match the size returned via Actor::GetSize(). + * @SINCE_1_0.0 + * @param[in] targetSize The target size. Note that this target size may not match the size returned via @ref Actor::GetTargetSize */ virtual void OnSizeSet(const Vector3& targetSize) = 0; /** * @brief Called when the owning actor's size is animated e.g. using Animation::AnimateTo( Property( actor, Actor::Property::SIZE ), ... ). * - * @param[in] animation The object which is animating the owning actor. - * @param[in] targetSize The target size. Note that this target size may not match the size returned via Actor::GetSize(). + * @SINCE_1_0.0 + * @param[in] animation The object which is animating the owning actor + * @param[in] targetSize The target size. Note that this target size may not match the size returned via @ref Actor::GetTargetSize */ virtual void OnSizeAnimation(Animation& animation, const Vector3& targetSize) = 0; /** + * @DEPRECATED_1_1.37 Connect to TouchSignal() instead. + * * @brief Called after a touch-event is received by the owning actor. * - * @note This must be enabled during construction; see CustomActorImpl::CustomActorImpl(bool) - * @param[in] event The touch event. - * @return True if the event should be consumed. + * @SINCE_1_0.0 + * @param[in] event The touch event + * @return True if the event should be consumed + * @note CustomActorImpl::REQUIRES_TOUCH_EVENTS must be enabled during construction. See CustomActorImpl::CustomActorImpl( ActorFlags flags ). */ - virtual bool OnTouchEvent(const TouchEvent& event) = 0; + virtual bool OnTouchEvent(const TouchEvent& event) DALI_DEPRECATED_API = 0; /** * @brief Called after a hover-event is received by the owning actor. * - * @note This must be enabled during construction; see CustomActorImpl::SetRequiresHoverEvents(bool) - * @param[in] event The hover event. - * @return True if the event should be consumed. + * @SINCE_1_0.0 + * @param[in] event The hover event + * @return True if the event should be consumed + * @note CustomActorImpl::REQUIRES_HOVER_EVENTS must be enabled during construction. See CustomActorImpl::CustomActorImpl( ActorFlags flags ). */ virtual bool OnHoverEvent(const HoverEvent& event) = 0; /** * @brief Called after a key-event is received by the actor that has had its focus set. * - * @param[in] event the Key Event - * @return True if the event should be consumed. + * @SINCE_1_0.0 + * @param[in] event The Key Event + * @return True if the event should be consumed */ virtual bool OnKeyEvent(const KeyEvent& event) = 0; /** - * @brief Called after a mouse-wheel-event is received by the owning actor. + * @brief Called after a wheel-event is received by the owning actor. * - * @note This must be enabled during construction; see CustomActorImpl::SetRequiresMouseWheelEvents(bool) - * @param[in] event The mouse wheel event. - * @return True if the event should be consumed. + * @SINCE_1_0.0 + * @param[in] event The wheel event + * @return True if the event should be consumed + * @note CustomActorImpl::REQUIRES_WHEEL_EVENTS must be enabled during construction. See CustomActorImpl::CustomActorImpl( ActorFlags flags ). */ - virtual bool OnMouseWheelEvent(const MouseWheelEvent& event) = 0; + virtual bool OnWheelEvent(const WheelEvent& event) = 0; /** * @brief Called after the size negotiation has been finished for this control. @@ -191,35 +225,38 @@ public: * actors differently after certain operations like add or remove * actors, resize or after changing specific properties. * - * Note! As this function is called from inside the size negotiation algorithm, you cannot - * call RequestRelayout (the call would just be ignored) - * - * @param[in] size The allocated size. + * @SINCE_1_0.0 + * @param[in] size The allocated size * @param[in,out] container The control should add actors to this container that it is not able - * to allocate a size for. + * to allocate a size for + * @note As this function is called from inside the size negotiation algorithm, you cannot + * call RequestRelayout (the call would just be ignored). */ virtual void OnRelayout( const Vector2& size, RelayoutContainer& container ) = 0; /** - * @brief Notification for deriving classes + * @brief Notification for deriving classes. * + * @SINCE_1_0.0 * @param[in] policy The policy being set * @param[in] dimension The dimension the policy is being set for */ virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension ) = 0; /** - * Return the natural size of the actor + * @brief Returns the natural size of the actor. * + * @SINCE_1_0.0 * @return The actor's natural size */ virtual Vector3 GetNaturalSize() = 0; /** - * @brief Calculate the size for a child + * @brief Calculates the size for a child. * + * @SINCE_1_0.0 * @param[in] child The child actor to calculate the size for - * @param[in] dimension The dimension to calculate the size for. E.g. width or height. + * @param[in] dimension The dimension to calculate the size for. E.g. width or height * @return Return the calculated size for the given dimension */ virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension ) = 0; @@ -229,8 +266,9 @@ public: * * Derived classes should override this if they wish to customize the height returned. * - * @param width to use. - * @return the height based on the width. + * @SINCE_1_0.0 + * @param[in] width Width to use + * @return The height based on the width */ virtual float GetHeightForWidth( float width ) = 0; @@ -239,83 +277,123 @@ public: * * Derived classes should override this if they wish to customize the width returned. * - * @param height to use. - * @return the width based on the width. + * @SINCE_1_0.0 + * @param[in] height Height to use + * @return The width based on the width */ virtual float GetWidthForHeight( float height ) = 0; /** - * @brief Determine if this actor is dependent on it's children for relayout + * @brief Determines if this actor is dependent on its children for relayout. * - * @param dimension The dimension(s) to check for + * @SINCE_1_0.0 + * @param[in] dimension The dimension(s) to check for * @return Return if the actor is dependent on it's children */ virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ) = 0; /** * @brief Virtual method to notify deriving classes that relayout dependencies have been - * met and the size for this object is about to be calculated for the given dimension + * met and the size for this object is about to be calculated for the given dimension. * - * @param dimension The dimension that is about to be calculated + * @SINCE_1_0.0 + * @param[in] dimension The dimension that is about to be calculated */ virtual void OnCalculateRelayoutSize( Dimension::Type dimension ) = 0; /** * @brief Virtual method to notify deriving classes that the size for a dimension - * has just been negotiated + * has just been negotiated. * + * @SINCE_1_0.0 * @param[in] size The new size for the given dimension * @param[in] dimension The dimension that was just negotiated */ virtual void OnLayoutNegotiated( float size, Dimension::Type dimension ) = 0; + /** + * @brief Retrieves the extension for this control. + * + * @SINCE_1_0.0 + * @return The extension if available, NULL otherwise + */ + virtual Extension* GetExtension() + { + return NULL; + } + protected: // For derived classes - // Flags for the constructor + /** + * @brief Enumeration for the constructor flags. + * @SINCE_1_0.0 + */ enum ActorFlags { - ACTOR_BEHAVIOUR_NONE = 0, - DISABLE_SIZE_NEGOTIATION = 1 << 0, ///< True if control does not need size negotiation, i.e. it can be skipped in the algorithm - REQUIRES_TOUCH_EVENTS = 1 << 1, ///< True if the OnTouchEvent() callback is required. - REQUIRES_HOVER_EVENTS = 1 << 2, ///< True if the OnHoverEvent() callback is required. - REQUIRES_MOUSE_WHEEL_EVENTS = 1 << 3, ///< True if the OnMouseWheelEvent() callback is required. + ACTOR_BEHAVIOUR_DEFAULT = 0, ///< Use to provide default behaviour (size negotiation is on, event callbacks are not called). @SINCE_1_2_10 + 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 + REQUIRES_TOUCH_EVENTS = 1 << 1, ///< True if the OnTouchEvent() callback is required. @SINCE_1_0.0 + REQUIRES_HOVER_EVENTS = 1 << 2, ///< True if the OnHoverEvent() callback is required. @SINCE_1_0.0 + REQUIRES_WHEEL_EVENTS = 1 << 3, ///< True if the OnWheelEvent() callback is required. @SINCE_1_0.0 - LAST_ACTOR_FLAG ///< Special marker for last actor flag + LAST_ACTOR_FLAG ///< Special marker for last actor flag @SINCE_1_0.0 }; - static const int ACTOR_FLAG_COUNT = Log< LAST_ACTOR_FLAG - 1 >::value + 1; ///< Value for deriving classes to continue on the flag enum + static const int32_t ACTOR_FLAG_COUNT = Log< LAST_ACTOR_FLAG - 1 >::value + 1; ///< Value for deriving classes to continue on the flag enum /** - * @brief Create a CustomActorImpl. + * @brief Creates a CustomActorImpl. + * @SINCE_1_0.0 * @param[in] flags Bitfield of ActorFlags to define behaviour */ CustomActorImpl( ActorFlags flags ); + // Size negotiation helpers + /** - * @brief Request a relayout, which means performing a size negotiation on this actor, its parent and children (and potentially whole scene) + * @brief Requests a relayout, which means performing a size negotiation on this actor, its parent and children (and potentially whole scene). * * This method can also be called from a derived class every time it needs a different size. * At the end of event processing, the relayout process starts and * all controls which requested Relayout will have their sizes (re)negotiated. * + * @SINCE_1_0.0 * @note RelayoutRequest() can be called multiple times; the size negotiation is still * only performed once, i.e. there is no need to keep track of this in the calling side. */ void RelayoutRequest(); /** - * @brief Calculate the size for a child using the base actor object + * @brief Provides the Actor implementation of GetHeightForWidth. + * @SINCE_1_0.0 + * @param[in] width Width to use + * @return The height based on the width + */ + float GetHeightForWidthBase( float width ); + + /** + * @brief Provides the Actor implementation of GetWidthForHeight. + * @SINCE_1_0.0 + * @param[in] height Height to use + * @return The width based on the height + */ + float GetWidthForHeightBase( float height ); + + /** + * @brief Calculates the size for a child using the base actor object. * + * @SINCE_1_0.0 * @param[in] child The child actor to calculate the size for - * @param[in] dimension The dimension to calculate the size for. E.g. width or height. - * @return Return the calculated size for the given dimension + * @param[in] dimension The dimension to calculate the size for. E.g. width or height + * @return Return the calculated size for the given dimension. If more than one dimension is requested, just return the first one found */ float CalculateChildSizeBase( const Dali::Actor& child, Dimension::Type dimension ); /** - * @brief Determine if this actor is dependent on it's children for relayout from the base class + * @brief Determines if this actor is dependent on its children for relayout from the base class. * - * @param dimension The dimension(s) to check for + * @SINCE_1_0.0 + * @param[in] dimension The dimension(s) to check for * @return Return if the actor is dependent on it's children */ bool RelayoutDependentOnChildrenBase( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ); @@ -323,43 +401,54 @@ protected: // For derived classes public: // Not intended for application developers /** - * @brief Called when ownership of the CustomActorImpl is passed to a CustomActor. + * @brief Initializes a CustomActor. + * @SINCE_1_0.0 + * @param[in] owner The owning object * @pre The CustomActorImpl is not already owned. - * @param[in] owner The owning object. + * @note Called when ownership of the CustomActorImpl is passed to a CustomActor. */ void Initialize(Internal::CustomActor& owner); /** - * @brief Get the owner. + * @brief Gets the owner. * * This method is needed when creating additional handle objects to existing objects. * Owner is the Dali::Internal::CustomActor that owns the implementation of the custom actor * inside core. Creation of a handle to Dali public API Actor requires this pointer. - * @return a pointer to the Actor implementation that owns this custom actor implementation + * @SINCE_1_0.0 + * @return A pointer to the Actor implementation that owns this custom actor implementation */ Internal::CustomActor* GetOwner() const; /** - * @brief Called when ownership of the CustomActorImpl is passed to a CustomActor. - * @return True if the OnTouchEvent() callback is required. + * @brief Returns whether the OnTouchEvent() callback is required. + * @SINCE_1_0.0 + * @return True if the OnTouchEvent() callback is required + * @note Called when ownership of the CustomActorImpl is passed to a CustomActor. */ bool RequiresTouchEvents() const; /** - * @brief Called when ownership of the CustomActorImpl is passed to a CustomActor. - * @return True if the OnHoverEvent() callback is required. + * @brief Returns whether the OnHoverEvent() callback is required. + * @SINCE_1_0.0 + * @return True if the OnHoverEvent() callback is required + * @note Called when ownership of the CustomActorImpl is passed to a CustomActor. */ bool RequiresHoverEvents() const; /** - * @brief Called when ownership of the CustomActorImpl is passed to a CustomActor. - * @return True if the OnMouseWheelEvent() callback is required. + * @brief Returns whether the OnWheelEvent() callback is required. + * @SINCE_1_0.0 + * @return True if the OnWheelEvent() callback is required + * @note Called when ownership of the CustomActorImpl is passed to a CustomActor. */ - bool RequiresMouseWheelEvents() const; + bool RequiresWheelEvents() const; /** - * @brief Called when ownership of the CustomActorImpl is passed to a CustomActor. + * @brief Returns whether relayout is enabled. + * @SINCE_1_0.0 * @return Return true if relayout is enabled on the custom actor + * @note Called when ownership of the CustomActorImpl is passed to a CustomActor. */ bool IsRelayoutEnabled() const; @@ -369,6 +458,9 @@ private: ActorFlags mFlags :ACTOR_FLAG_COUNT; ///< ActorFlags flags to determine behaviour }; +/** + * @} + */ } // namespace Dali #endif // __DALI_CUSTOM_ACTOR_IMPL_H__