X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;ds=sidebyside;f=dali%2Fdevel-api%2Fadaptor-framework%2Fwindow-devel.h;h=199dea2010ba867e50f660ee0fc4b06d79bb88cb;hb=ac63e9f54ced9f1ebad3cfbe285d7c29887dd7c2;hp=47e676c88cbeb22b4a7d088a5d0fe8c978fe5303;hpb=5335c09864d29162f9c5e176061a2c4c29f8e9af;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 47e676c..199dea2 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) 2021 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,44 +18,72 @@ * */ +// 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 -typedef Signal< void ( Window, bool ) > VisibilityChangedSignalType; ///< Visibility changed signal type +typedef Signal AuxiliaryMessageSignalType; ///< Auxiliary message 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. @@ -63,7 +91,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. @@ -71,61 +99,67 @@ 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 when the window is shown or hidden. + * @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 This signal is emitted when window's auxiliary was changed then display server sent the message. + * + * Auxiliary message is sent by display server. + * When client application added the window's auxiliary hint and if the auxiliary is changed, + * display server send the auxiliary message. + * Auxiliary message has the key, value and options. * - * 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 signal to connect to */ -DALI_ADAPTOR_API VisibilityChangedSignalType& VisibilityChangedSignal( Window window ); +DALI_ADAPTOR_API AuxiliaryMessageSignalType& AuxiliaryMessageSignal(Window window); /** * @brief Sets parent window of the window. @@ -137,7 +171,19 @@ DALI_ADAPTOR_API VisibilityChangedSignalType& VisibilityChangedSignal( Window wi * @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 Sets parent window of the window. + * + * After setting that, these windows do together when raise-up, lower and iconified/deiconified. + * This function has the additional flag whether the child is located above or below of the parent. + * + * @param[in] window The window instance + * @param[in] parent The parent window instance + * @param[in] belowParent The flag is whether the child is located above or below of the parent. + */ +DALI_ADAPTOR_API void SetParent(Window window, Window parent, bool belowParent); /** * @brief Unsets parent window of the window. @@ -146,7 +192,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. @@ -154,7 +200,7 @@ 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 @@ -162,7 +208,189 @@ DALI_ADAPTOR_API Window GetParent( Window window ); * @param[in] handle The handle need to downcast * @return The window cast from SceneHolder */ -DALI_ADAPTOR_API Window DownCast( BaseHandle handle ); +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 Gets current physical orientation of the window. + * + * It means current physical rotation angle of the window. + * If the height of the display device's area is greater than the width, + * default current orientation is PORTRAIT and current physical orientation angle is 0. + * If the width of the display device's area is greater than the height, + * default current orientation is LANDSCAPE and current physical orientation angle is 0. + * + * @param[in] window The window instance + * @return The current physical orientation degree of the window. It is one of them as 0, 90, 180 and 270. + */ +DALI_ADAPTOR_API int GetPhysicalOrientation(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); + +/** + * @brief Sets window position and size for specific orientation. + * This api reserves the position and size per orientation to display server. + * When the device is rotated, the window is moved/resized with the reserved position/size by display server. + * + * @param[in] window The window instance + * @param[in] positionSize The reserved position and size for the orientation + * @param[in] orientation The orientation + * + * @note Currently, it only works when the window's type is WindowType::IME. + * @note To set WindowType::IME, use Application New(... WindowType type), not Window::SetType(). + * @note This function is only useful in Tizen world. + */ +DALI_ADAPTOR_API void SetPositionSizeWithOrientation(Window window, PositionSize positionSize, WindowOrientation orientation); + +/** + * @brief Requests to display server for the window is moved by display server. + * + * This function should be called in mouse down event callback function. + * After this function is called in mouse down event callback function, the window is moved with mouse move event. + * When mouse up event happens, the window moved work is finished. + * + * @param[in] window The window instance + */ +DALI_ADAPTOR_API void RequestMoveToServer(Window window); + +/** + * @brief Requests to display server for the window is resized by display server. + * + * This function should be called in mouse down event callback function. + * After this function is called in mouse down event callback function, the window is resized with mouse move event. + * The direction is selected one of eight ways. + * When mouse up event happens, the window resized work is finished. + * + * @param[in] window The window instance + * @param[in] direction it is indicated the window's side or edge for starting point. + */ +DALI_ADAPTOR_API void RequestResizeToServer(Window window, WindowResizeDirection direction); + +/** + * @brief Enables the floating mode of window. + * + * The floating mode is to support making partial size window easliy. + * It is useful to make popup style window and this window is always upper than the other normal window. + * In addition, it is easy to change between popup style and normal style window. + * + * A special display server(as a Tizen display server) supports this mode. + * + * @param[in] window The window instance. + * @param[in] enable Enable floating mode or not. + */ +DALI_ADAPTOR_API void EnableFloatingMode(Window window, bool enable); + +/** + * @brief Includes input region. + * + * This function inlcudes input regions. + * It can be used multiple times and supports multiple regions. + * It means input region will be extended. + * + * This input is related to mouse and touch event. + * If device has touch screen, this function is useful. + * Otherwise device does not have that, we can use it after connecting mouse to the device. + * + * @param[in] window The window instance. + * @param[in] inputRegion The added region to accept input events. + */ +DALI_ADAPTOR_API void IncludeInputRegion(Window window, const Rect& inputRegion); + +/** + * @brief Excludes input region. + * + * This function excludes input regions. + * It can be used multiple times and supports multiple regions. + * It means input region will be reduced. + * Nofice, should be set input area by IncludeInputRegion() before this function is used. + * + * This input is related to mouse and touch event. + * If device has touch screen, this function is useful. + * Otherwise device does not have that, we can use it after connecting mouse to the device. + * + * @param[in] window The window instance. + * @param[in] inputRegion The subtracted region to except input events. + */ +DALI_ADAPTOR_API void ExcludeInputRegion(Window window, const Rect& inputRegion); + +/** + * @brief Sets the necessary for window rotation Acknowledgement. + * After this function called, SendRotationCompletedAcknowledgement() should be called to complete window rotation. + * + * This function is supprot that application has the window rotation acknowledgement's control. + * It means display server waits when application's rotation work is finished. + * It is useful application has the other rendering engine which works asynchronous. + * For instance, GlView. + * It only works on Tizen device. + * + * @param[in] window The window instance. + * @param[in] needAcknowledgement the flag is true if window rotation acknowledge is sent. + */ +DALI_ADAPTOR_API void SetNeedsRotationCompletedAcknowledgement(Window window, bool needAcknowledgement); + +/** + * @brief send the Acknowledgement to complete window rotation. + * For this function, SetNeedsRotationCompletedAcknowledgement should be already called with true. + * + * @param[in] window The window instance. + */ +DALI_ADAPTOR_API void SendRotationCompletedAcknowledgement(Window window); } // namespace DevelWindow