Apply deprecate macro and LOG

[platform/core/uifw/dali-core.git] / dali / public-api / actors / custom-actor-impl.h

diff --git a/dali/public-api/actors/custom-actor-impl.h b/dali/public-api/actors/custom-actor-impl.h
index 370aaf2..b447244 100644 (file)
--- 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.
@@ -68,12 +68,6 @@ public:
   class Extension; ///< Forward declare future extension interface
 
   /**
-   * @brief Virtual destructor
-   * @SINCE_1_0.0
-   */
-  virtual ~CustomActorImpl();
-
-  /**
    * @brief Used by derived CustomActorImpl instances, to access the public Actor interface.
    *
    * @SINCE_1_0.0
@@ -137,7 +131,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 +151,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::GetSize.
+   * @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;
 
@@ -166,11 +160,13 @@ public:
    *
    * @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::GetSize.
+   * @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.
    *
    * @SINCE_1_0.0
@@ -178,7 +174,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.
@@ -317,10 +313,14 @@ public:
 
 protected: // For derived classes
 
-  // Flags for the constructor
+  /**
+   * @brief Flags for the constructor
+   * @SINCE_1_0.0
+   */
   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
@@ -338,6 +338,12 @@ protected: // For derived classes
    */
   CustomActorImpl( ActorFlags flags );
 
+  /**
+   * @brief Virtual destructor
+   * @SINCE_1_0.0
+   */
+  virtual ~CustomActorImpl();
+
   // Size negotiation helpers
 
   /**