X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fpublic-api%2Factors%2Fcustom-actor-impl.h;h=8335aeb634988770538fefa865599b8a69753944;hb=refs%2Fheads%2Ftizen_3.0_tv;hp=a9c1a00122b6fd93193ba954b1f7a49774d48296;hpb=dbbe326c4c5dd97df1796c8e59d6ed2a1231d8f0;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 a9c1a00..8335aeb 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) 2016 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. @@ -67,12 +67,14 @@ 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. * @@ -180,7 +182,7 @@ public: * @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. @@ -262,7 +264,7 @@ public: * Derived classes should override this if they wish to customize the height returned. * * @SINCE_1_0.0 - * @param width Width to use. + * @param[in] width Width to use. * @return The height based on the width. */ virtual float GetHeightForWidth( float width ) = 0; @@ -273,7 +275,7 @@ public: * Derived classes should override this if they wish to customize the width returned. * * @SINCE_1_0.0 - * @param height Height to use. + * @param[in] height Height to use. * @return The width based on the width. */ virtual float GetWidthForHeight( float height ) = 0; @@ -282,7 +284,7 @@ public: * @brief Determine if this actor is dependent on it's children for relayout. * * @SINCE_1_0.0 - * @param dimension The dimension(s) to check for + * @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; @@ -292,7 +294,7 @@ public: * 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; @@ -325,7 +327,8 @@ protected: // For derived classes */ enum ActorFlags { - ACTOR_BEHAVIOUR_NONE = 0, + ACTOR_BEHAVIOUR_NONE = 0, ///< Use if no change to default behaviour is needed. @DEPRECATED_1_2_10 + 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 @@ -361,7 +364,7 @@ protected: // For derived classes /** * @brief Provides the Actor implementation of GetHeightForWidth. * @SINCE_1_0.0 - * @param width Width to use. + * @param[in] width Width to use. * @return The height based on the width. */ float GetHeightForWidthBase( float width ); @@ -369,7 +372,7 @@ protected: // For derived classes /** * @brief Provides the Actor implementation of GetWidthForHeight. * @SINCE_1_0.0 - * @param height Height to use. + * @param[in] height Height to use. * @return The width based on the height. */ float GetWidthForHeightBase( float height ); @@ -388,7 +391,7 @@ protected: // For derived classes * @brief Determine if this actor is dependent on it's children for relayout from the base class. * * @SINCE_1_0.0 - * @param dimension The dimension(s) to check for + * @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 );