X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fpublic-api%2Factors%2Fcustom-actor-impl.h;h=698e62586aaf201012ace5201d3d581bda24ba6a;hb=5eb804983e9ac526ee4866453ffeb24358917938;hp=975d4fe1b393a4ab07489993924edf6c15ffb6c4;hpb=3ebd19dd0b1e9beec0b01da6ac6c812dc6f6b95c;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 975d4fe..698e625 100644 --- a/dali/public-api/actors/custom-actor-impl.h +++ b/dali/public-api/actors/custom-actor-impl.h @@ -1,8 +1,8 @@ -#ifndef __DALI_CUSTOM_ACTOR_IMPL_H__ -#define __DALI_CUSTOM_ACTOR_IMPL_H__ +#ifndef DALI_CUSTOM_ACTOR_IMPL_H +#define DALI_CUSTOM_ACTOR_IMPL_H /* - * Copyright (c) 2015 Samsung Electronics Co., Ltd. + * Copyright (c) 2020 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,6 +18,9 @@ * */ +// EXTERNAL INCLUDES +#include // uint32_t + // INTERNAL INCLUDES #include #include @@ -42,9 +45,8 @@ class CustomActor; class CustomActorImpl; class RelayoutContainer; struct KeyEvent; -struct TouchEvent; -struct HoverEvent; -struct WheelEvent; +class HoverEvent; +class WheelEvent; struct Vector2; struct Vector3; @@ -61,18 +63,20 @@ typedef IntrusivePtr 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 * @SINCE_1_0.0 */ virtual ~CustomActorImpl(); +public: /** * @brief Used by derived CustomActorImpl instances, to access the public Actor interface. * @@ -82,14 +86,14 @@ public: CustomActor Self() const; /** - * @brief Called after the actor has been connected to the stage. + * @brief Called after the actor has been connected to the Scene. * * When an actor is connected, it will be directly or indirectly parented to the root Actor. - * @SINCE_1_0.0 + * @SINCE_1_9.24 * @param[in] depth The depth in the hierarchy for the actor * - * @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 + * @note The root Actor is provided automatically by the Scene, and is always considered to be connected. + * When the parent of a set of actors is connected to the scene, 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. * @@ -104,15 +108,15 @@ public: * @endcode * @param[in] depth The depth in the hierarchy for the actor */ - virtual void OnStageConnection( int depth ) = 0; + virtual void OnSceneConnection( int32_t depth ) = 0; /** - * @brief Called after the actor has been disconnected from Stage. + * @brief Called after the actor has been disconnected from the Scene. * - * 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 + * @SINCE_1_9.24 + * @note When the parent of a set of actors is disconnected to the scene, 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. * @@ -126,7 +130,7 @@ public: * * @endcode */ - virtual void OnStageDisconnection() = 0; + virtual void OnSceneDisconnection() = 0; /** * @brief Called after a child has been added to the owning actor. @@ -137,7 +141,7 @@ public: 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). * * @SINCE_1_0.0 * @param[in] child The child being removed @@ -157,7 +161,7 @@ public: * @brief Called when the owning actor's size is set e.g. using Actor::SetSize(). * * @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. + * @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; @@ -165,27 +169,17 @@ public: * @brief Called when the owning actor's size is animated e.g. using Animation::AnimateTo( Property( actor, Actor::Property::SIZE ), ... ). * * @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. + * @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; /** - * @brief Called after a touch-event is received by the owning actor. - * - * @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; - - /** * @brief Called after a hover-event is received by the owning actor. * * @SINCE_1_0.0 * @param[in] event The hover event - * @return True if the event should be consumed. + * @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; @@ -194,8 +188,8 @@ public: * @brief Called after a key-event is received by the actor that has had its focus set. * * @SINCE_1_0.0 - * @param[in] event the Key Event - * @return True if the event should be consumed. + * @param[in] event The Key Event + * @return True if the event should be consumed */ virtual bool OnKeyEvent(const KeyEvent& event) = 0; @@ -204,7 +198,7 @@ public: * * @SINCE_1_0.0 * @param[in] event The wheel event - * @return True if the event should be consumed. + * @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 OnWheelEvent(const WheelEvent& event) = 0; @@ -219,16 +213,16 @@ public: * actors, resize or after changing specific properties. * * @SINCE_1_0.0 - * @param[in] size The allocated size. + * @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 @@ -237,7 +231,7 @@ public: virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension ) = 0; /** - * @brief 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 @@ -245,12 +239,12 @@ public: 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. - * @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 */ virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension ) = 0; @@ -260,8 +254,8 @@ public: * Derived classes should override this if they wish to customize the height returned. * * @SINCE_1_0.0 - * @param width Width to use. - * @return The height based on the width. + * @param[in] width Width to use + * @return The height based on the width */ virtual float GetHeightForWidth( float width ) = 0; @@ -271,32 +265,32 @@ public: * Derived classes should override this if they wish to customize the width returned. * * @SINCE_1_0.0 - * @param height Height to use. - * @return The width based on the width. + * @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. * * @SINCE_1_0.0 - * @param dimension The dimension(s) to check for - * @return Return if the actor is dependent on it's children. + * @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. * * @SINCE_1_0.0 - * @param dimension The dimension that is about to be calculated + * @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 @@ -305,7 +299,7 @@ public: virtual void OnLayoutNegotiated( float size, Dimension::Type dimension ) = 0; /** - * @brief Retrieve the extension for this control. + * @brief Retrieves the extension for this control. * * @SINCE_1_0.0 * @return The extension if available, NULL otherwise @@ -317,10 +311,13 @@ public: protected: // For derived classes - // Flags for the constructor + /** + * @brief Enumeration for the constructor flags. + * @SINCE_1_0.0 + */ enum ActorFlags { - ACTOR_BEHAVIOUR_NONE = 0, + 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 @@ -329,10 +326,10 @@ protected: // For derived classes 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 */ @@ -341,7 +338,7 @@ protected: // For derived classes // 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 @@ -356,42 +353,42 @@ protected: // For derived classes /** * @brief Provides the Actor implementation of GetHeightForWidth. * @SINCE_1_0.0 - * @param width Width to use. - * @return The height based on the width. + * @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 height Height to use. - * @return The width based on the height. + * @param[in] height Height to use + * @return The width based on the height */ float GetWidthForHeightBase( float height ); /** - * @brief Calculate the size for a child using the base actor object. + * @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. If more than one dimension is requested, just return the first one found. + * @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. * * @SINCE_1_0.0 - * @param dimension The dimension(s) to check for - * @return Return if the actor is dependent on it's children. + * @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 ); public: // Not intended for application developers /** - * @brief Initialize a CustomActor. + * @brief Initializes a CustomActor. * @SINCE_1_0.0 * @param[in] owner The owning object * @pre The CustomActorImpl is not already owned. @@ -400,7 +397,7 @@ public: // Not intended for application developers 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 @@ -413,7 +410,7 @@ public: // Not intended for application developers /** * @brief Returns whether the OnTouchEvent() callback is required. * @SINCE_1_0.0 - * @return True if the OnTouchEvent() callback is required. + * @return True if the OnTouchEvent() callback is required * @note Called when ownership of the CustomActorImpl is passed to a CustomActor. */ bool RequiresTouchEvents() const; @@ -421,7 +418,7 @@ public: // Not intended for application developers /** * @brief Returns whether the OnHoverEvent() callback is required. * @SINCE_1_0.0 - * @return True if the OnHoverEvent() callback is required. + * @return True if the OnHoverEvent() callback is required * @note Called when ownership of the CustomActorImpl is passed to a CustomActor. */ bool RequiresHoverEvents() const; @@ -429,7 +426,7 @@ public: // Not intended for application developers /** * @brief Returns whether the OnWheelEvent() callback is required. * @SINCE_1_0.0 - * @return True if the OnWheelEvent() callback is required. + * @return True if the OnWheelEvent() callback is required * @note Called when ownership of the CustomActorImpl is passed to a CustomActor. */ bool RequiresWheelEvents() const; @@ -437,7 +434,7 @@ public: // Not intended for application developers /** * @brief Returns whether relayout is enabled. * @SINCE_1_0.0 - * @return Return true if relayout is enabled on the custom actor. + * @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; @@ -453,4 +450,4 @@ private: */ } // namespace Dali -#endif // __DALI_CUSTOM_ACTOR_IMPL_H__ +#endif // DALI_CUSTOM_ACTOR_IMPL_H