X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fdevel-api%2Fadaptor-framework%2Fwindow-devel.h;h=ea3577a098e038bd7a73f4f863896b2e59652653;hb=9d6174cffaea69180402db990f4e27edb067481b;hp=cd94caa0c5d424bd1568eb84b1edbf971a9f40d2;hpb=d728dfeff88bdb79d8b001c6b876cbcf475767cd;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 cd94caa..ea3577a 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) 2019 Samsung Electronics Co., Ltd. + * Copyright (c) 2020 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. @@ -18,42 +18,70 @@ * */ +// EXTERNAL INCLUDES +#include + // INTERNAL INCLUDES #include +#include +#include namespace Dali { class KeyEvent; -class TouchData; +class TouchEvent; class WheelEvent; class RenderTaskList; namespace DevelWindow { -typedef Signal< void () > EventProcessingFinishedSignalType; ///< Event Processing finished signal type +typedef Signal EventProcessingFinishedSignalType; ///< Event Processing finished signal type + +typedef Signal KeyEventSignalType; ///< Key event signal type + +typedef Signal TouchEventSignalType; ///< Touch signal type + +typedef Signal WheelEventSignalType; ///< Touched signal type -typedef Signal< void (const KeyEvent&) > KeyEventSignalType; ///< Key event signal type +typedef Signal VisibilityChangedSignalType; ///< Visibility changed signal type -typedef Signal< void (const TouchData&) > TouchSignalType; ///< Touch signal type +typedef Signal TransitionEffectEventSignalType; ///< Effect signal type and state -typedef Signal< void (const WheelEvent&) > WheelEventSignalType; ///< Touched signal type +typedef Signal KeyboardRepeatSettingsChangedSignalType; ///< Keyboard repeat settings changed signal type /** - * @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. + * @brief Creates an initialized handle to a new Window. * - * @param[in] window The window instance - * @param[in] positionSize The new window position and size + * @param[in] surface Can be a window or pixmap. + * @param[in] windowPosition The position and size of the Window + * @param[in] name The Window title + * @param[in] isTransparent Whether Window is transparent + * @return A new window + * @note This creates an extra window in addition to the default main window +*/ +DALI_ADAPTOR_API Window New(Any surface, PositionSize windowPosition, const std::string& name, bool isTransparent = false); + +/** + * @brief Creates an initialized handle to a new Window. + * + * @param[in] surface Can be a window or pixmap. + * @param[in] windowPosition The position and size of the Window + * @param[in] name The Window title + * @param[in] className The Window class name + * @param[in] isTransparent Whether Window is transparent + * @note This creates an extra window in addition to the default main window + * @return A new Window */ -DALI_ADAPTOR_API void SetPositionSize( Window window, PositionSize positionSize ); +DALI_ADAPTOR_API Window New(Any surface, PositionSize windowPosition, const std::string& name, const std::string& className, bool isTransparent = false); /** - * @brief Retrieves the list of render-tasks in the window. + * @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. * * @param[in] window The window instance - * @return A valid handle to a RenderTaskList + * @param[in] positionSize The new window position and size */ -DALI_ADAPTOR_API Dali::RenderTaskList GetRenderTaskList( Window window ); +DALI_ADAPTOR_API void SetPositionSize(Window window, PositionSize positionSize); /** * @brief Retrieve the window that the given actor is added to. @@ -61,7 +89,7 @@ DALI_ADAPTOR_API Dali::RenderTaskList GetRenderTaskList( Window window ); * @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 ); +DALI_ADAPTOR_API Window Get(Actor actor); /** * @brief This signal is emitted just after the event processing is finished. @@ -69,59 +97,66 @@ DALI_ADAPTOR_API Window Get( Actor actor ); * @param[in] window The window instance * @return The signal to connect to */ -DALI_ADAPTOR_API EventProcessingFinishedSignalType& EventProcessingFinishedSignal( Window window ); +DALI_ADAPTOR_API EventProcessingFinishedSignalType& EventProcessingFinishedSignal(Window window); /** - * @brief This signal is emitted when key event is received. + * @brief This signal is emitted when wheel event is received. * * A callback of the following type may be connected: * @code - * void YourCallbackName(const KeyEvent& event); + * void YourCallbackName(const WheelEvent& event); * @endcode * @param[in] window The window instance * @return The signal to connect to */ -DALI_ADAPTOR_API KeyEventSignalType& KeyEventSignal( Window window ); +DALI_ADAPTOR_API WheelEventSignalType& WheelEventSignal(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). + * @brief This signal is emitted when the window is shown or hidden. * - * 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 ); + * void YourCallbackName( Window window, bool visible ); * @endcode - * * @param[in] window The window instance - * @return The touch signal to connect to - * @note Motion events are not emitted. + * @return The signal to connect to */ -DALI_ADAPTOR_API TouchSignalType& TouchSignal( Window window ); +DALI_ADAPTOR_API VisibilityChangedSignalType& VisibilityChangedSignal(Window window); /** - * @brief This signal is emitted when wheel event is received. + * @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(const WheelEvent& event); + * void YourCallbackName( Window window, EffectState state, EffectType type ); * @endcode * @param[in] window The window instance * @return The signal to connect to */ -DALI_ADAPTOR_API WheelEventSignalType& WheelEventSignal( Window window ); +DALI_ADAPTOR_API TransitionEffectEventSignalType& TransitionEffectEventSignal(Window window); + +/** + * @brief This signal is emitted just after the keyboard repeat setting is changed globally. + * + * @param[in] window The window instance + * @return The signal to connect to + */ +DALI_ADAPTOR_API KeyboardRepeatSettingsChangedSignalType& KeyboardRepeatSettingsChangedSignal(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 ); +DALI_ADAPTOR_API void SetParent(Window window, Window parent); /** * @brief Unsets parent window of the window. @@ -130,7 +165,7 @@ DALI_ADAPTOR_API void SetParent( Window window, Window parent ); * * @param[in] window The window instance */ -DALI_ADAPTOR_API void Unparent( Window window ); +DALI_ADAPTOR_API void Unparent(Window window); /** * @brief Gets parent window of the window. @@ -138,7 +173,74 @@ DALI_ADAPTOR_API void Unparent( Window window ); * @param[in] window The window instance * @return The parent window of the window */ -DALI_ADAPTOR_API Window GetParent( Window 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 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& orientations); + +/** + * @brief Gets current window ID. + * + * @param[in] window The window instance + */ +DALI_ADAPTOR_API int32_t GetNativeId(Window window); + +/** + * @brief Adds a callback that is called when the frame rendering is done by the graphics driver. + * + * @param[in] window The window instance + * @param[in] callback The function to call + * @param[in] frameId The Id to specify the frame. It will be passed when the callback is called. + * + * @note A callback of the following type may be used: + * @code + * void MyFunction( int frameId ); + * @endcode + * This callback will be deleted once it is called. + * + * @note Ownership of the callback is passed onto this class. + */ +DALI_ADAPTOR_API void AddFrameRenderedCallback(Window window, std::unique_ptr callback, int32_t frameId); + +/** + * @brief Adds a callback that is called when the frame is displayed on the display. + * + * @param[in] window The window instance + * @param[in] callback The function to call + * @param[in] frameId The Id to specify the frame. It will be passed when the callback is called. + * + * @note A callback of the following type may be used: + * @code + * void MyFunction( int frameId ); + * @endcode + * This callback will be deleted once it is called. + * + * @note Ownership of the callback is passed onto this class. + */ +DALI_ADAPTOR_API void AddFramePresentedCallback(Window window, std::unique_ptr callback, int32_t frameId); } // namespace DevelWindow