Automatic Control Clipping
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / public-api / controls / control-impl.h
index 92786d4..d850eb4 100644 (file)
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_CONTROL_IMPL_H
 
 /*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2017 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.
@@ -76,12 +76,14 @@ public:
    */
   static Toolkit::Control New();
 
+protected:
   /**
    * @brief Virtual destructor.
    * @SINCE_1_0.0
    */
   virtual ~Control();
 
+public:
   // Styling
 
   /**
@@ -306,12 +308,11 @@ protected: // For derived classes to call
    * @SINCE_1_2.0
    *
    * @param[in] index The Property index of the visual, used to reference visual
-   * @param[in] placementActor The actor used to by the visual.
    * @param[in] visual The visual to register
-   * @note Derived class should not call visual.SetOnStage(placementActor). It is the responsibility of the base class to connect/disconnect registered visual to stage.
+   * @note Derived class should not call visual.SetOnStage(actor). It is the responsibility of the base class to connect/disconnect registered visual to stage.
    *       Use below API with enabled set to false if derived class wishes to control when visual is staged.
    */
-  void RegisterVisual( Property::Index index, Actor& placementActor, Toolkit::Visual::Base& visual );
+  void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual );
 
   /**
    * @brief Register a visual by Property Index, linking an Actor to visual when required.
@@ -322,12 +323,11 @@ protected: // For derived classes to call
    * @SINCE_1_2.11
    *
    * @param[in] index The Property index of the visual, used to reference visual
-   * @param[in] placementActor The actor used to by the visual.
    * @param[in] visual The visual to register
    * @param[in] enabled false if derived class wants to control when visual is set on stage.
    *
    */
-  void RegisterVisual( Property::Index index, Actor& placementActor, Toolkit::Visual::Base& visual, bool enabled );
+  void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, bool enabled );
 
   /**
    * @brief Erase the entry matching the given index from the list of registered visuals
@@ -369,17 +369,6 @@ protected: // For derived classes to call
   bool IsVisualEnabled( Property::Index index ) const;
 
   /**
-   * @brief Retrieve the placement actor associated with the given index.
-   *
-   * @SINCE_1_2.2
-   *
-   * @@param[in] index The Property index of the visual.
-   * @return Then placement actor if exist, otherwise empty handle.
-   * @note For managing object life-cycle, do not store the returned placement actor as a member which increments its reference count.
-   */
-  Actor GetPlacementActor( Property::Index index ) const;
-
-  /**
    * @brief Create a transition effect on the control.
    *
    * @SINCE_1_2.12
@@ -404,7 +393,7 @@ protected: // From CustomActorImpl, not to be used by application developers
 
   /**
    * @copydoc CustomActorImpl::OnStageConnection()
-   * @note If overridden, then an up-call to Control::OnStageConnection MUST be made at the start.
+   * @note If overridden, then an up-call to Control::OnStageConnection MUST be made at the end.
    */
   virtual void OnStageConnection( int depth );
 
@@ -416,7 +405,7 @@ protected: // From CustomActorImpl, not to be used by application developers
 
   /**
    * @copydoc CustomActorImpl::OnChildAdd()
-   * @note If overridden, then an up-call to Control::OnChildAdd MUST be made at the start.
+   * @note If overridden, then an up-call to Control::OnChildAdd MUST be made at the end.
    */
   virtual void OnChildAdd( Actor& child );
 
@@ -427,14 +416,20 @@ protected: // From CustomActorImpl, not to be used by application developers
   virtual void OnChildRemove( Actor& child );
 
   /**
+   * @copydoc CustomActorImpl::OnPropertySet()
+   * @note If overridden, then an up-call to Control::OnChildRemove MUST be made at the end.
+   */
+  virtual void OnPropertySet( Property::Index index, Property::Value propertyValue );
+
+  /**
    * @copydoc CustomActorImpl::OnSizeSet()
-   * @note If overridden, then an up-call to Control::OnSizeSet MUST be made at the start.
+   * @note If overridden, then an up-call to Control::OnSizeSet MUST be made at the end.
    */
   virtual void OnSizeSet( const Vector3& targetSize );
 
   /**
    * @copydoc CustomActorImpl::OnSizeAnimation()
-   * @note If overridden, then an up-call to Control::OnSizeAnimation MUST be made at the start.
+   * @note If overridden, then an up-call to Control::OnSizeAnimation MUST be made at the end.
    */
   virtual void OnSizeAnimation( Animation& animation, const Vector3& targetSize );
 
@@ -560,7 +555,7 @@ public: // API for derived classes to override
    * @SINCE_1_0.0
    * @param[in] child The added actor.
    */
-  virtual void OnControlChildAdd( Actor& child );
+  virtual void OnControlChildAdd( Actor& child ) DALI_DEPRECATED_API;
 
   /**
    * @DEPRECATED_1_1.30. Override OnChildRemove instead.
@@ -572,7 +567,7 @@ public: // API for derived classes to override
    * @SINCE_1_0.0
    * @param[in] child The removed actor.
    */
-  virtual void OnControlChildRemove( Actor& child );
+  virtual void OnControlChildRemove( Actor& child ) DALI_DEPRECATED_API;
 
   // Styling