Merge "CanvasRenderer: Add Gradient, LinearGradient, RadialGradient classes" into...
[platform/core/uifw/dali-adaptor.git] / dali / devel-api / adaptor-framework / canvas-renderer-drawable-group.h
index ae2dded..4c35e37 100644 (file)
@@ -43,23 +43,20 @@ class DrawableGroup;
 } // namespace DALI_INTERNAL
 
 /**
- * @brief A class enabling to hold many Drawable objects.
- * As a whole they can be transformed, their transparency can be changed.
+ * @brief A class that holds many Drawable object. As a whole they can be transformed, their transparency can be changed.
  */
 class DALI_ADAPTOR_API CanvasRenderer::DrawableGroup : public CanvasRenderer::Drawable
 {
 public:
   /**
    * @brief Creates an initialized handle to a new CanvasRenderer::DrawableGroup.
-   *
    * @return A handle to a newly allocated DrawableGroup
    */
   static DrawableGroup New();
 
 public:
   /**
-   * @brief Creates an empty handle.
-   * Use CanvasRenderer::DrawableGroup::New() to create an initialized object.
+   * @brief Creates an empty handle. Use CanvasRenderer::DrawableGroup::New() to create an initialized object.
    */
   DrawableGroup();
 
@@ -84,11 +81,18 @@ public:
   bool AddDrawable(Drawable& drawable);
 
   /**
-   * @brief Clears the drawable object added to the DrawableGroup.
-   * This method does not free the memory of the added drawable object.
+   * @brief Remove drawable object to the DrawableGroup.
+   * This method is similar to deregistration. Freeing memory is not concerned for drawables being removed.
+   * @param[in] drawable the drawable object.
+   * @return Returns True when it's successful. False otherwise.
+   */
+  bool RemoveDrawable(Drawable drawable);
+
+  /**
+   * @brief Remove all drawable objects added to the DrawableGroup.
    * @return Returns True when it's successful. False otherwise.
    */
-  bool Clear();
+  bool RemoveAllDrawables();
 
 public: // Not intended for application developers
   /// @cond internal