Merge "Typo fixed in Control implementation doc." into tizen

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / public-api / transition-effects / cube-transition-effect.h

diff --git a/dali-toolkit/public-api/transition-effects/cube-transition-effect.h b/dali-toolkit/public-api/transition-effects/cube-transition-effect.h
index 6692cff..e640296 100644 (file)
--- a/dali-toolkit/public-api/transition-effects/cube-transition-effect.h
+++ b/dali-toolkit/public-api/transition-effects/cube-transition-effect.h
@@ -1,29 +1,28 @@
 #ifndef __DALI_TOOLKIT_CUBE_TRANSITION_EFFECT_H__
 #define __DALI_TOOLKIT_CUBE_TRANSITION_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) 2014 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 <boost/function.hpp>
-
-// INTERNAL INCLUDES
-#include <dali/dali.h>
+#include <dali/public-api/actors/actor.h>
+#include <dali/public-api/actors/image-actor.h>
 
-namespace Dali DALI_IMPORT_API
+namespace Dali
 {
 
 namespace Toolkit
@@ -74,8 +73,13 @@ class CubeTransitionEffect;
  * cubeEffect.StartTransition( );
  *
  * @endcode
+ *
+ * Signals
+ * | %Signal Name         | Method                           |
+ * |----------------------|----------------------------------|
+ * | transition-completed | @ref TransitionCompletedSignal() |
  */
-class CubeTransitionEffect : public BaseHandle
+class DALI_IMPORT_API CubeTransitionEffect : public BaseHandle
 {
 public:
 
@@ -91,6 +95,17 @@ public:
   ~CubeTransitionEffect();
 
   /**
+   * @brief Downcast an Object handle to a CubeTransitionEffect handle.
+   *
+   * If handle points to a CubeTransitionEffect object the downcast produces
+   * a valid handle. If not the returned handle is left uninitialized.
+   *
+   * @param[in] handle A handle to an object
+   * @return A handle to a CubeTransitionEffect object or an uninitialized handle
+   */
+  static CubeTransitionEffect DownCast( BaseHandle handle );
+
+  /**
    * Set the duration of transition animation
    * @param[in] duration The duration of transition animation
    */
@@ -175,11 +190,8 @@ public:
 
 public: //Signal
 
-  //signal name
-  static const char* const SIGNAL_TRANSITION_COMPLETED;
-
   //Transition animation completed signal
-  typedef SignalV2< void ( CubeTransitionEffect, ImageActor ) > TransitionCompletedSignalV2;
+  typedef Signal< void ( CubeTransitionEffect, ImageActor ) > TransitionCompletedSignalType;
 
   /**
    * Signal emitted when the transition has completed animation
@@ -189,11 +201,11 @@ public: //Signal
    * @endcode
    * @return The Signal to connect to.
    */
-  TransitionCompletedSignalV2& TransitionCompletedSignal();
+  TransitionCompletedSignalType& TransitionCompletedSignal();
 
 public: // Not intended for developer use
 
-  CubeTransitionEffect( Internal::CubeTransitionEffect* impl );
+  explicit DALI_INTERNAL CubeTransitionEffect( Internal::CubeTransitionEffect* impl );
 
 }; //class CubeTransitionEffect