#define DALI_WINDOW_DEVEL_H
/*
- * Copyright (c) 2020 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.
#include <memory>
// INTERNAL INCLUDES
-#include <dali/public-api/common/vector-wrapper.h>
+#include <dali/public-api/adaptor-framework/window-enumerations.h>
#include <dali/public-api/adaptor-framework/window.h>
+#include <dali/public-api/common/vector-wrapper.h>
namespace Dali
{
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 () > EventProcessingFinishedSignalType; ///< Event Processing finished signal type
+typedef Signal<void(const KeyEvent&)> KeyEventSignalType; ///< Key event signal type
-typedef Signal< void (const KeyEvent&) > KeyEventSignalType; ///< Key event signal type
+typedef Signal<void(const TouchEvent&)> TouchEventSignalType; ///< Touch signal type
-typedef Signal< void (const TouchEvent&) > TouchSignalType; ///< Touch signal type
+typedef Signal<void(const WheelEvent&)> WheelEventSignalType; ///< Touched 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, bool ) > VisibilityChangedSignalType; ///< Visibility changed signal type
+typedef Signal<void(Window, WindowEffectState, WindowEffectType)> TransitionEffectEventSignalType; ///< Effect signal type and state
-typedef Signal< void (Window, EffectState, EffectType) > TransitionEffectEventSignalType; ///< Effect signal type and state
+typedef Signal<void()> KeyboardRepeatSettingsChangedSignalType; ///< Keyboard repeat settings changed signal type
-typedef Signal< void () > KeyboardRepeatSettingsChangedSignalType; ///< Keyboard repeat settings changed signal type
+typedef Signal<void(const std::string&, const std::string&, const Property::Array&)> AuxiliaryMessageSignalType; ///< Auxiliary message signal type
/**
* @brief Creates an initialized handle to a new Window.
* @param[in] window The window instance
* @param[in] positionSize The new window position and size
*/
-DALI_ADAPTOR_API void SetPositionSize( Window window, PositionSize positionSize );
+DALI_ADAPTOR_API void SetPositionSize(Window window, PositionSize positionSize);
/**
* @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 );
+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 );
+DALI_ADAPTOR_API EventProcessingFinishedSignalType& EventProcessingFinishedSignal(Window window);
/**
* @brief This signal is emitted when wheel event is received.
* @param[in] window The window instance
* @return The signal to connect to
*/
-DALI_ADAPTOR_API WheelEventSignalType& WheelEventSignal( Window window );
+DALI_ADAPTOR_API WheelEventSignalType& WheelEventSignal(Window window);
/**
* @brief This signal is emitted when the window is shown or hidden.
* @param[in] window The window instance
* @return The signal to connect to
*/
-DALI_ADAPTOR_API VisibilityChangedSignalType& VisibilityChangedSignal( Window window );
+DALI_ADAPTOR_API VisibilityChangedSignalType& VisibilityChangedSignal(Window window);
/**
* @brief This signal is emitted for transition effect.
* @param[in] window The window instance
* @return The signal to connect to
*/
-DALI_ADAPTOR_API TransitionEffectEventSignalType& TransitionEffectEventSignal( 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 );
+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.
+ *
+ * @param[in] window The window instance
+ * @return The signal to connect to
+ */
+DALI_ADAPTOR_API AuxiliaryMessageSignalType& AuxiliaryMessageSignal(Window window);
/**
* @brief Sets parent window of the window.
* @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.
*
* @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.
* @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 );
+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 );
+DALI_ADAPTOR_API WindowOrientation GetCurrentOrientation(Window window);
/**
- * @brief Sets available orientations of the window.
+ * @brief Gets current physical orientation of the window.
*
- * This API is for setting several orientations one time.
+ * 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
- * @param[in] orientations The available orientation list to add
+ * @return The current physical orientation degree of the window. It is one of them as 0, 90, 180 and 270.
*/
-DALI_ADAPTOR_API void SetAvailableOrientations( Window window, const Dali::Vector<Dali::Window::WindowOrientation>& orientations );
+DALI_ADAPTOR_API int GetPhysicalOrientation(Window window);
/**
- * @brief Gets current window ID.
+ * @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 int32_t GetNativeId( Window window );
+DALI_ADAPTOR_API void SetAvailableOrientations(Window window, const Dali::Vector<WindowOrientation>& orientations);
/**
- * @brief Sets damaged areas of the window.
- *
- * This API is for setting static damaged areas of the window for partial update.
+ * @brief Gets current window ID.
*
* @param[in] window The window instance
- * @param[in] areas The damaged areas list to set
*/
-DALI_ADAPTOR_API void SetDamagedAreas(Window window, std::vector<Dali::Rect<int>>& areas);
+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.
*
* @note Ownership of the callback is passed onto this class.
*/
-DALI_ADAPTOR_API void AddFrameRenderedCallback( Window window, std::unique_ptr< CallbackBase > callback, int32_t frameId );
+DALI_ADAPTOR_API void AddFrameRenderedCallback(Window window, std::unique_ptr<CallbackBase> callback, int32_t frameId);
/**
* @brief Adds a callback that is called when the frame is displayed on the display.
*
* @note Ownership of the callback is passed onto this class.
*/
-DALI_ADAPTOR_API void AddFramePresentedCallback( Window window, std::unique_ptr< CallbackBase > callback, int32_t frameId );
+DALI_ADAPTOR_API void AddFramePresentedCallback(Window window, std::unique_ptr<CallbackBase> 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<int>& 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<int>& 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
projects / platform / core / uifw / dali-adaptor.git / blobdiff