Doxygen grouping

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / public-api / controls / gaussian-blur-view / gaussian-blur-view.h

diff --git a/dali-toolkit/public-api/controls/gaussian-blur-view/gaussian-blur-view.h b/dali-toolkit/public-api/controls/gaussian-blur-view/gaussian-blur-view.h
index 913acde..a2c5ea6 100644 (file)
--- a/dali-toolkit/public-api/controls/gaussian-blur-view/gaussian-blur-view.h
+++ b/dali-toolkit/public-api/controls/gaussian-blur-view/gaussian-blur-view.h
@@ -1,26 +1,35 @@
 #ifndef __DALI_TOOLKIT_GAUSSIAN_BLUR_EFFECT_H__
 #define __DALI_TOOLKIT_GAUSSIAN_BLUR_EFFECT_H__
 
-//
-// Copyright (c) 2014 Samsung Electronics Co., Ltd.
-//
-// Licensed under the Flora License, Version 1.0 (the License);
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://floralicense.org/license/
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an AS IS BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
+/*
+ * Copyright (c) 2015 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.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+// EXTERNAL INCLUDES
+#include <dali/public-api/actors/camera-actor.h>
+#include <dali/public-api/actors/image-actor.h>
+#include <dali/public-api/common/dali-vector.h>
+#include <dali/public-api/images/frame-buffer-image.h>
+#include <dali/public-api/render-tasks/render-task.h>
+#include <dali/public-api/shader-effects/shader-effect.h>
 
 // INTERNAL INCLUDES
 #include <dali-toolkit/public-api/controls/control.h>
 
-namespace Dali DALI_IMPORT_API
+namespace Dali
 {
 
 namespace Toolkit
@@ -40,6 +49,10 @@ class GaussianBlurView;
 class BloomView;
 
 } // namespace Internal
+/**
+ * @addtogroup dali-toolkit-controls-gaussian-blur-view
+ * @{
+ */
 
 /**
  *
@@ -87,13 +100,13 @@ class BloomView;
  *  Stage::GetCurrent().Remove(gaussianBlurView);\n
  *  gaussianBlurView.Deactivate();\n
  */
-class GaussianBlurView : public Control
+class DALI_IMPORT_API GaussianBlurView : public Control
 {
 public:
   /**
    * Signal type for notifications
    */
-  typedef SignalV2< void (GaussianBlurView source) > GaussianBlurViewSignal;
+  typedef Signal< void (GaussianBlurView source) > GaussianBlurViewSignal;
 
   /**
    * Create an uninitialized GaussianBlurView; this can be initialized with GaussianBlurView::New()
@@ -112,9 +125,11 @@ public:
   GaussianBlurView& operator=(const GaussianBlurView& ZoomView);
 
   /**
-   * Virtual destructor.
+   * @brief Destructor
+   *
+   * This is non-virtual since derived Handle types must not contain data or virtual methods.
    */
-  virtual ~GaussianBlurView();
+  ~GaussianBlurView();
 
   /**
    * Downcast an Object handle to GaussianBlurView. If handle points to a GaussianBlurView the
@@ -170,7 +185,6 @@ public:
    * @param [in] child The child.
    * @post The child will be referenced by its parent. This means that the child will be kept alive,
    * even if the handle passed into this method is reset or destroyed.
-   * @post This may invalidate ActorContainer iterators.
    */
   void Add(Actor child);
 
@@ -180,7 +194,6 @@ public:
    * @pre This Actor (the parent) has been initialized.
    * @pre The child actor is not the same as the parent actor.
    * @param [in] child The child.
-   * @post This may invalidate ActorContainer iterators.
    */
   void Remove(Actor child);
 
@@ -219,7 +232,7 @@ public:
    * the GaussianBlurView object from the stage also.
    * @return Index of the property that can be used to fade the blur in / out
    */
-  Property::Index GetBlurStrengthPropertyIndex() const;
+  Dali::Property::Index GetBlurStrengthPropertyIndex() const;
 
   /**
    * Get the final blurred image.
@@ -255,18 +268,19 @@ public:
    * Creates a handle using the Toolkit::Internal implementation.
    * @param[in]  implementation  The UI Control implementation.
    */
-  GaussianBlurView( Internal::GaussianBlurView& implementation );
+  DALI_INTERNAL GaussianBlurView( Internal::GaussianBlurView& implementation );
 
   /**
    * Allows the creation of this UI Control from an Internal::CustomActor pointer.
    * @param[in]  internal  A pointer to the internal CustomActor.
    */
-  GaussianBlurView( Dali::Internal::CustomActor* internal );
-
-private:
+  DALI_INTERNAL GaussianBlurView( Dali::Internal::CustomActor* internal );
 
 };
 
+/**
+ * @}
+ */
 } // namespace Toolkit
 
 } // namespace Dali