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
+
+typedef Signal< void (const KeyEvent&) > KeyEventSignalType; ///< Key event signal type
+
+typedef Signal< void (const TouchData&) > TouchSignalType; ///< Touch signal type
+
+typedef Signal< void (const WheelEvent&) > WheelEventSignalType; ///< Touched signal type
+
+typedef Signal< void ( Window, bool ) > VisibilityChangedSignalType; ///< Visibility changed 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.
DALI_ADAPTOR_API void SetPositionSize( Window window, PositionSize positionSize );
/**
- * @brief Adds a child Actor to the Window.
+ * @brief Retrieves the list of render-tasks in 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.
+ * @return A valid handle to a RenderTaskList
*/
-DALI_ADAPTOR_API void Add( Window window, Dali::Actor actor );
+DALI_ADAPTOR_API Dali::RenderTaskList GetRenderTaskList( Window window );
/**
- * @brief Removes a child Actor from the Window.
+ * @brief Retrieve the window that the given actor is added to.
*
- * The child will be unreferenced.
+ * @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 Window Get( Actor actor );
+
+/**
+ * @brief This signal is emitted just after the event processing is finished.
+ *
+ * @param[in] window The window instance
+ * @return The signal to connect to
+ */
+DALI_ADAPTOR_API EventProcessingFinishedSignalType& EventProcessingFinishedSignal( Window window );
+
+/**
+ * @brief This signal is emitted when key event is received.
+ *
+ * A callback of the following type may be connected:
+ * @code
+ * void YourCallbackName(const KeyEvent& event);
+ * @endcode
* @param[in] window The window instance
- * @param[in] actor The child
- * @pre The actor has been added to the stage.
+ * @return The signal to connect to
*/
-DALI_ADAPTOR_API void Remove( Window window, Dali::Actor actor );
+DALI_ADAPTOR_API KeyEventSignalType& KeyEventSignal( Window window );
/**
- * @brief Sets the background color of the window.
+ * @brief This signal is emitted when the screen is touched and when the touch ends
+ * (i.e. the down & up touch events only).
+ *
+ * If there are multiple touch points, then this will be emitted when the first touch occurs and
+ * then when the last finger is lifted.
+ * An interrupted event will also be emitted (if it occurs).
+ * A callback of the following type may be connected:
+ * @code
+ * void YourCallbackName( TouchData event );
+ * @endcode
*
* @param[in] window The window instance
- * @param[in] color The new background color
+ * @return The touch signal to connect to
+ * @note Motion events are not emitted.
*/
-DALI_ADAPTOR_API void SetBackgroundColor( Window window, Vector4 color );
+DALI_ADAPTOR_API TouchSignalType& TouchSignal( Window window );
/**
- * @brief Gets the background color of the surface.
+ * @brief This signal is emitted when wheel event is received.
*
+ * A callback of the following type may be connected:
+ * @code
+ * void YourCallbackName(const WheelEvent& event);
+ * @endcode
* @param[in] window The window instance
- * @return The background color
+ * @return The signal to connect to
*/
-DALI_ADAPTOR_API Vector4 GetBackgroundColor( Window window );
+DALI_ADAPTOR_API WheelEventSignalType& WheelEventSignal( Window window );
/**
- * @brief Returns the Scene's Root Layer.
+ * @brief This signal is emitted when the window is shown or hidden.
*
+ * A callback of the following type may be connected:
+ * @code
+ * void YourCallbackName( Window window, bool visible );
+ * @endcode
* @param[in] window The window instance
- * @return The root layer
+ * @return The signal to connect to
*/
-DALI_ADAPTOR_API Dali::Layer GetRootLayer( Window window );
+DALI_ADAPTOR_API VisibilityChangedSignalType& VisibilityChangedSignal( Window window );
/**
- * @brief Queries the number of on-stage layers.
+ * @brief This signal is emitted for transition effect.
*
- * Note that a default layer is always provided (count >= 1).
+ * 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 number of layers
+ * @return The signal to connect to
*/
-DALI_ADAPTOR_API uint32_t GetLayerCount( Window window );
+DALI_ADAPTOR_API TransitionEffectEventSignalType& TransitionEffectEventSignal( Window window );
/**
- * @brief Retrieves the layer at a specified depth.
+ * @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] depth The depth
- * @return The layer found at the given depth
- * @pre Depth is less than layer count; see GetLayerCount().
+ * @param[in] parent The parent window instance
*/
-DALI_ADAPTOR_API Dali::Layer GetLayer( Window window, uint32_t depth );
+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 );
+
+/**
+ * @brief Gets current orientation of the window.
+ *
+ * @param[in] window The window instance
+ * @return The current window orientation if previously set, or none
+ */
+DALI_ADAPTOR_API Dali::Window::WindowOrientation GetCurrentOrientation( Window window );
+
+/**
+ * @brief Sets available orientations of the window.
+ *
+ * This API is for setting several orientations one time.
+ *
+ * @param[in] window The window instance
+ * @param[in] orientations The available orientation list to add
+ */
+DALI_ADAPTOR_API void SetAvailableOrientations( Window window, const Dali::Vector<Dali::Window::WindowOrientation>& orientations );
} // namespace DevelWindow
projects / platform / core / uifw / dali-adaptor.git / blobdiff