[Tizen] Add Effect Start/End signal

[platform/core/uifw/dali-adaptor.git] / dali / devel-api / adaptor-framework / window-devel.h

diff --git a/dali/devel-api/adaptor-framework/window-devel.h b/dali/devel-api/adaptor-framework/window-devel.h
index 90a8f7b..da532d3 100644 (file)
--- a/dali/devel-api/adaptor-framework/window-devel.h
+++ b/dali/devel-api/adaptor-framework/window-devel.h
@@ -26,9 +26,29 @@ namespace Dali
 class KeyEvent;
 class TouchData;
 class WheelEvent;
+class RenderTaskList;
 
 namespace DevelWindow
 {
+/**
+ * @brief Enumeration for transition effect's state.
+ */
+enum class EffectState
+{
+  NONE = 0,    ///< None state
+  START,       ///< Transition effect is started.
+  END          ///< Transition effect is ended.
+};
+
+/**
+ * @brief Enumeration for transition effect's type.
+ */
+enum class  EffectType
+{
+  NONE = 0,    ///< None type
+  SHOW,        ///< Window show effect.
+  HIDE,        ///< Window hide effect.
+};
 
 typedef Signal< void () > EventProcessingFinishedSignalType;       ///< Event Processing finished signal type
 
@@ -38,6 +58,8 @@ typedef Signal< void (const TouchData&) > TouchSignalType;         ///< Touch si
 
 typedef Signal< void (const WheelEvent&) > WheelEventSignalType;   ///< Touched signal type
 
+typedef Signal< void (Window, EffectState, EffectType) > TransitionEffectEventSignalType; ///< Effect signal type and state
+
 /**
  * @brief Sets position and size of the window. This API guarantees that both moving and resizing of window will appear on the screen at once.
  *
@@ -47,68 +69,20 @@ typedef Signal< void (const WheelEvent&) > WheelEventSignalType;   ///< Touched
 DALI_ADAPTOR_API void SetPositionSize( Window window, PositionSize positionSize );
 
 /**
- * @brief Adds a child Actor to the Window.
- *
- * The child will be referenced.
- * @param[in] window The window instance
- * @param[in] actor The child
- * @pre The actor has been initialized.
- * @pre The actor does not have a parent.
- */
-DALI_ADAPTOR_API void Add( Window window, Dali::Actor actor );
-
-/**
- * @brief Removes a child Actor from the Window.
- *
- * The child will be unreferenced.
- * @param[in] window The window instance
- * @param[in] actor The child
- * @pre The actor has been added to the stage.
- */
-DALI_ADAPTOR_API void Remove( Window window, Dali::Actor actor );
-
-/**
- * @brief Sets the background color of the window.
- *
- * @param[in] window The window instance
- * @param[in] color The new background color
- */
-DALI_ADAPTOR_API void SetBackgroundColor( Window window, Vector4 color );
-
-/**
- * @brief Gets the background color of the surface.
- *
- * @param[in] window The window instance
- * @return The background color
- */
-DALI_ADAPTOR_API Vector4 GetBackgroundColor( Window window );
-
-/**
- * @brief Returns the Scene's Root Layer.
- *
- * @param[in] window The window instance
- * @return The root layer
- */
-DALI_ADAPTOR_API Dali::Layer GetRootLayer( Window window );
-
-/**
- * @brief Queries the number of on-stage layers.
+ * @brief Retrieves the list of render-tasks in the window.
  *
- * Note that a default layer is always provided (count >= 1).
  * @param[in] window The window instance
- * @return The number of layers
+ * @return A valid handle to a RenderTaskList
  */
-DALI_ADAPTOR_API uint32_t GetLayerCount( Window window );
+DALI_ADAPTOR_API Dali::RenderTaskList GetRenderTaskList( Window window );
 
 /**
- * @brief Retrieves the layer at a specified depth.
+ * @brief Retrieve the window that the given actor is added to.
  *
- * @param[in] window The window instance
- * @param[in] depth The depth
- * @return The layer found at the given depth
- * @pre Depth is less than layer count; see GetLayerCount().
+ * @param[in] actor The actor
+ * @return The window the actor is added to or an empty handle if the actor is not added to any window.
  */
-DALI_ADAPTOR_API Dali::Layer GetLayer( Window window, uint32_t depth );
+DALI_ADAPTOR_API Window Get( Actor actor );
 
 /**
  * @brief This signal is emitted just after the event processing is finished.
@@ -160,6 +134,58 @@ DALI_ADAPTOR_API TouchSignalType& TouchSignal( Window window );
  */
 DALI_ADAPTOR_API WheelEventSignalType& WheelEventSignal( Window window );
 
+/**
+ * @brief This signal is emitted for transition effect.
+ *
+ * The transition animation is appeared when the window is shown/hidden.
+ * When the animation is started, START signal is emitted.
+ * Then the animation is ended, END signal is emitted, too.
+ * A callback of the following type may be connected:
+ * @code
+ *   void YourCallbackName( Window window, EffectState state, EffectType type );
+ * @endcode
+ * @param[in] window The window instance
+ * @return The signal to connect to
+ */
+DALI_ADAPTOR_API TransitionEffectEventSignalType& TransitionEffectEventSignal( Window window );
+
+/**
+ * @brief Sets parent window of the window.
+ *
+ * After setting that, these windows do together when raise-up, lower and iconified/deiconified.
+ * Initially, the window is located on top of the parent. The window can go below parent by calling Lower().
+ * If parent's window stack is changed by calling Raise() or Lower(), child windows are located on top of the parent again.
+ *
+ * @param[in] window The window instance
+ * @param[in] parent The parent window instance
+ */
+DALI_ADAPTOR_API void SetParent( Window window, Window parent );
+
+/**
+ * @brief Unsets parent window of the window.
+ *
+ * After unsetting, the window is disconnected his parent window.
+ *
+ * @param[in] window The window instance
+ */
+DALI_ADAPTOR_API void Unparent( Window window );
+
+/**
+ * @brief Gets parent window of the window.
+ *
+ * @param[in] window The window instance
+ * @return The parent window of the window
+ */
+DALI_ADAPTOR_API Window GetParent( Window window );
+
+/**
+ * @brief Downcast sceneHolder to window
+ *
+ * @param[in] handle The handle need to downcast
+ * @return The window cast from SceneHolder
+ */
+DALI_ADAPTOR_API Window DownCast(  BaseHandle handle );
+
 } // namespace DevelWindow
 
 } // namespace Dali