X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fdevel-api%2Fadaptor-framework%2Fwindow-devel.h;h=da532d3b51d2fafc3ea7da40c9a475976f240260;hb=7f88db61bcdf7f900878752c47b7e8e0a5a31bd5;hp=9ed8a18d38373a72897fb9ffedbc0124a960add5;hpb=371c360a9d1f5fcf0b28ab01bfcd3ab718c752dc;p=platform%2Fcore%2Fuifw%2Fdali-adaptor.git diff --git a/dali/devel-api/adaptor-framework/window-devel.h b/dali/devel-api/adaptor-framework/window-devel.h index 9ed8a18..da532d3 100644 --- a/dali/devel-api/adaptor-framework/window-devel.h +++ b/dali/devel-api/adaptor-framework/window-devel.h @@ -2,7 +2,7 @@ #define DALI_WINDOW_DEVEL_H /* - * Copyright (c) 2018 Samsung Electronics Co., Ltd. + * Copyright (c) 2019 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. @@ -23,9 +23,42 @@ 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, 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. @@ -35,6 +68,124 @@ namespace DevelWindow */ DALI_ADAPTOR_API void SetPositionSize( Window window, PositionSize positionSize ); +/** + * @brief Retrieves the list of render-tasks in the window. + * + * @param[in] window The window instance + * @return A valid handle to a RenderTaskList + */ +DALI_ADAPTOR_API Dali::RenderTaskList GetRenderTaskList( Window window ); + +/** + * @brief Retrieve the window that the given actor is added to. + * + * @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 + * @return The signal to connect to + */ +DALI_ADAPTOR_API KeyEventSignalType& KeyEventSignal( Window 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 + * @return The touch signal to connect to + * @note Motion events are not emitted. + */ +DALI_ADAPTOR_API TouchSignalType& TouchSignal( Window window ); + +/** + * @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 signal to connect to + */ +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