1 #ifndef DALI_WINDOW_DEVEL_H
2 #define DALI_WINDOW_DEVEL_H
5 * Copyright (c) 2023 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
25 #include <dali/devel-api/adaptor-framework/mouse-in-out-event.h>
26 #include <dali/devel-api/adaptor-framework/mouse-relative-event.h>
27 #include <dali/public-api/adaptor-framework/window-enumerations.h>
28 #include <dali/public-api/adaptor-framework/window.h>
29 #include <dali/public-api/common/vector-wrapper.h>
41 typedef Signal<void()> EventProcessingFinishedSignalType; ///< Event Processing finished signal type
42 typedef Signal<void(const KeyEvent&)> KeyEventSignalType; ///< Key event signal type
43 typedef Signal<void(const TouchEvent&)> TouchEventSignalType; ///< Touch signal type
44 typedef Signal<void(const WheelEvent&)> WheelEventSignalType; ///< Wheel signal type
45 typedef Signal<void(Window, bool)> VisibilityChangedSignalType; ///< Visibility changed signal type
46 typedef Signal<void(Window, WindowEffectState, WindowEffectType)> TransitionEffectEventSignalType; ///< Effect signal type and state
47 typedef Signal<void()> KeyboardRepeatSettingsChangedSignalType; ///< Keyboard repeat settings changed signal type
48 typedef Signal<void(const std::string&, const std::string&, const Property::Array&)> AuxiliaryMessageSignalType; ///< Auxiliary message signal type
49 typedef Signal<void(Window, bool)> AccessibilityHighlightSignalType; ///< Accessibility Highlight signal type
50 typedef Signal<bool(const KeyEvent&)> InterceptKeyEventSignalType; ///< Intercept Key event signal type
51 typedef Signal<void(Window, Dali::Window::WindowPosition)> MovedSignalType; ///< Window Moved signal type
52 typedef Signal<void(Window, Dali::WindowOrientation)> OrientationChangedSignalType; ///< Window orientation changed signal type
53 typedef Signal<void(Window, const Dali::DevelWindow::MouseInOutEvent&)> MouseInOutEventSignalType; ///< MouseInOutEvent signal type
54 typedef Signal<void(Window, const Dali::DevelWindow::MouseRelativeEvent&)> MouseRelativeEventSignalType; ///< MouseRelativeEvent signal type
55 typedef Signal<void(Window, Dali::Window::WindowPosition)> MoveCompletedSignalType; ///< Window Moved by Server signal type
56 typedef Signal<void(Window, Dali::Window::WindowSize)> ResizeCompletedSignalType; ///< Window Resized by Server signal type
57 typedef Signal<void(WindowInsetsPartType, WindowInsetsPartState, const Extents&)> InsetsChangedSignalType; ///< InsetsChanged signal type
60 * @brief Creates an initialized handle to a new Window.
62 * @param[in] surface Can be a window or pixmap.
63 * @param[in] windowPosition The position and size of the Window
64 * @param[in] name The Window title
65 * @param[in] isTransparent Whether Window is transparent
66 * @return A new window
67 * @note This creates an extra window in addition to the default main window
69 DALI_ADAPTOR_API Window New(Any surface, PositionSize windowPosition, const std::string& name, bool isTransparent = false);
72 * @brief Creates an initialized handle to a new Window.
74 * @param[in] surface Can be a window or pixmap.
75 * @param[in] windowPosition The position and size of the Window
76 * @param[in] name The Window title
77 * @param[in] className The Window class name
78 * @param[in] isTransparent Whether Window is transparent
79 * @note This creates an extra window in addition to the default main window
80 * @return A new Window
82 DALI_ADAPTOR_API Window New(Any surface, PositionSize windowPosition, const std::string& name, const std::string& className, bool isTransparent = false);
85 * @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.
87 * @param[in] window The window instance
88 * @param[in] positionSize The new window position and size
90 DALI_ADAPTOR_API void SetPositionSize(Window window, PositionSize positionSize);
93 * @brief Retrieve the window that the given actor is added to.
95 * @param[in] actor The actor
96 * @return The window the actor is added to or an empty handle if the actor is not added to any window.
98 DALI_ADAPTOR_API Window Get(Actor actor);
101 * @brief This signal is emitted just after the event processing is finished.
103 * @param[in] window The window instance
104 * @return The signal to connect to
106 DALI_ADAPTOR_API EventProcessingFinishedSignalType& EventProcessingFinishedSignal(Window window);
109 * @brief This signal is emitted when wheel event is received.
111 * A callback of the following type may be connected:
113 * void YourCallbackName(const WheelEvent& event);
115 * @param[in] window The window instance
116 * @return The signal to connect to
118 DALI_ADAPTOR_API WheelEventSignalType& WheelEventSignal(Window window);
121 * @brief This signal is emitted when the window is shown or hidden.
123 * A callback of the following type may be connected:
125 * void YourCallbackName( Window window, bool visible );
127 * @param[in] window The window instance
128 * @return The signal to connect to
130 DALI_ADAPTOR_API VisibilityChangedSignalType& VisibilityChangedSignal(Window window);
133 * @brief This signal is emitted for transition effect.
135 * The transition animation is appeared when the window is shown/hidden.
136 * When the animation is started, START signal is emitted.
137 * Then the animation is ended, END signal is emitted, too.
138 * A callback of the following type may be connected:
140 * void YourCallbackName( Window window, EffectState state, EffectType type );
142 * @param[in] window The window instance
143 * @return The signal to connect to
145 DALI_ADAPTOR_API TransitionEffectEventSignalType& TransitionEffectEventSignal(Window window);
148 * @brief This signal is emitted just after the keyboard repeat setting is changed globally.
150 * @param[in] window The window instance
151 * @return The signal to connect to
153 DALI_ADAPTOR_API KeyboardRepeatSettingsChangedSignalType& KeyboardRepeatSettingsChangedSignal(Window window);
156 * @brief This signal is emitted when window's auxiliary was changed then display server sent the message.
158 * Auxiliary message is sent by display server.
159 * When client application added the window's auxiliary hint and if the auxiliary is changed,
160 * display server send the auxiliary message.
161 * Auxiliary message has the key, value and options.
163 * @param[in] window The window instance
164 * @return The signal to connect to
166 DALI_ADAPTOR_API AuxiliaryMessageSignalType& AuxiliaryMessageSignal(Window window);
169 * @brief This signal is emitted when the window needs to grab or clear accessibility highlight.
170 * The highlight indicates that it is an object to interact with the user regardless of focus.
171 * After setting the highlight on the object, you can do things that the object can do, such as
172 * giving or losing focus.
174 * This signal is emitted by Dali::Accessibility::Component::GrabHighlight
175 * and Dali::Accessibility::Component::ClearHighlight
177 * A callback of the following type may be connected:
179 * void YourCallbackName( Window window, bool highlight );
182 * @param[in] window The window instance
183 * @return The signal to connect to
185 DALI_ADAPTOR_API AccessibilityHighlightSignalType& AccessibilityHighlightSignal(Window window);
188 * @brief Sets parent window of the window.
190 * After setting that, these windows do together when raise-up, lower and iconified/deiconified.
191 * Initially, the window is located on top of the parent. The window can go below parent by calling Lower().
192 * If parent's window stack is changed by calling Raise() or Lower(), child windows are located on top of the parent again.
194 * @param[in] window The window instance
195 * @param[in] parent The parent window instance
197 DALI_ADAPTOR_API void SetParent(Window window, Window parent);
200 * @brief Sets parent window of the window.
202 * After setting that, these windows do together when raise-up, lower and iconified/deiconified.
203 * This function has the additional flag whether the child is located above or below of the parent.
205 * @param[in] window The window instance
206 * @param[in] parent The parent window instance
207 * @param[in] belowParent The flag is whether the child is located above or below of the parent.
209 DALI_ADAPTOR_API void SetParent(Window window, Window parent, bool belowParent);
212 * @brief Unsets parent window of the window.
214 * After unsetting, the window is disconnected his parent window.
216 * @param[in] window The window instance
218 DALI_ADAPTOR_API void Unparent(Window window);
221 * @brief Gets parent window of the window.
223 * @param[in] window The window instance
224 * @return The parent window of the window
226 DALI_ADAPTOR_API Window GetParent(Window window);
229 * @brief Gets current orientation of the window.
231 * @param[in] window The window instance
232 * @return The current window orientation if previously set, or none
234 DALI_ADAPTOR_API WindowOrientation GetCurrentOrientation(Window window);
237 * @brief Gets current physical orientation of the window.
239 * It means current physical rotation angle of the window.
240 * If the height of the display device's area is greater than the width,
241 * default current orientation is PORTRAIT and current physical orientation angle is 0.
242 * If the width of the display device's area is greater than the height,
243 * default current orientation is LANDSCAPE and current physical orientation angle is 0.
245 * @param[in] window The window instance
246 * @return The current physical orientation degree of the window. It is one of them as 0, 90, 180 and 270.
248 DALI_ADAPTOR_API int GetPhysicalOrientation(Window window);
251 * @brief Sets available orientations of the window.
253 * This API is for setting several orientations one time.
255 * @param[in] window The window instance
256 * @param[in] orientations The available orientation list to add
258 DALI_ADAPTOR_API void SetAvailableOrientations(Window window, const Dali::Vector<WindowOrientation>& orientations);
261 * @brief Gets current window ID.
263 * @param[in] window The window instance
265 DALI_ADAPTOR_API int32_t GetNativeId(Window window);
268 * @brief Adds a callback that is called when the frame rendering is done by the graphics driver.
270 * @param[in] window The window instance
271 * @param[in] callback The function to call
272 * @param[in] frameId The Id to specify the frame. It will be passed when the callback is called.
274 * @note A callback of the following type may be used:
276 * void MyFunction( int frameId );
278 * This callback will be deleted once it is called.
280 * @note Ownership of the callback is passed onto this class.
282 DALI_ADAPTOR_API void AddFrameRenderedCallback(Window window, std::unique_ptr<CallbackBase> callback, int32_t frameId);
285 * @brief Adds a callback that is called when the frame is displayed on the display.
287 * @param[in] window The window instance
288 * @param[in] callback The function to call
289 * @param[in] frameId The Id to specify the frame. It will be passed when the callback is called.
291 * @note A callback of the following type may be used:
293 * void MyFunction( int frameId );
295 * This callback will be deleted once it is called.
297 * @note Ownership of the callback is passed onto this class.
299 DALI_ADAPTOR_API void AddFramePresentedCallback(Window window, std::unique_ptr<CallbackBase> callback, int32_t frameId);
302 * @brief Sets window position and size for specific orientation.
303 * This api reserves the position and size per orientation to display server.
304 * When the device is rotated, the window is moved/resized with the reserved position/size by display server.
306 * @param[in] window The window instance
307 * @param[in] positionSize The reserved position and size for the orientation
308 * @param[in] orientation The orientation
310 * @note Currently, it only works when the window's type is WindowType::IME.
311 * @note To set WindowType::IME, use Application New(... WindowType type), not Window::SetType().
312 * @note This function is only useful in Tizen world.
314 DALI_ADAPTOR_API void SetPositionSizeWithOrientation(Window window, PositionSize positionSize, WindowOrientation orientation);
317 * @brief Requests to display server for the window is moved by display server.
319 * This function should be called in mouse down event callback function.
320 * After this function is called in mouse down event callback function, the window is moved with mouse move event.
321 * When mouse up event happens, the window moved work is finished.
323 * @param[in] window The window instance
325 DALI_ADAPTOR_API void RequestMoveToServer(Window window);
328 * @brief Requests to display server for the window is resized by display server.
330 * This function should be called in mouse down event callback function.
331 * After this function is called in mouse down event callback function, the window is resized with mouse move event.
332 * The direction is selected one of eight ways.
333 * When mouse up event happens, the window resized work is finished.
335 * @param[in] window The window instance
336 * @param[in] direction it is indicated the window's side or edge for starting point.
338 DALI_ADAPTOR_API void RequestResizeToServer(Window window, WindowResizeDirection direction);
341 * @brief Enables the floating mode of window.
343 * The floating mode is to support making partial size window easliy.
344 * It is useful to make popup style window and this window is always upper than the other normal window.
345 * In addition, it is easy to change between popup style and normal style window.
347 * A special display server(as a Tizen display server) supports this mode.
349 * @param[in] window The window instance.
350 * @param[in] enable Enable floating mode or not.
352 DALI_ADAPTOR_API void EnableFloatingMode(Window window, bool enable);
355 * @brief Returns whether the window is floating mode or not.
357 * @param[in] window The window instance.
358 * @return True if the window is enabled floating mode, false otherwise.
360 DALI_ADAPTOR_API bool IsFloatingModeEnabled(Window window);
363 * @brief Includes input region.
365 * This function inlcudes input regions.
366 * It can be used multiple times and supports multiple regions.
367 * It means input region will be extended.
369 * This input is related to mouse and touch event.
370 * If device has touch screen, this function is useful.
371 * Otherwise device does not have that, we can use it after connecting mouse to the device.
373 * @param[in] window The window instance.
374 * @param[in] inputRegion The added region to accept input events.
376 DALI_ADAPTOR_API void IncludeInputRegion(Window window, const Rect<int>& inputRegion);
379 * @brief Excludes input region.
381 * This function excludes input regions.
382 * It can be used multiple times and supports multiple regions.
383 * It means input region will be reduced.
384 * Nofice, should be set input area by IncludeInputRegion() before this function is used.
386 * This input is related to mouse and touch event.
387 * If device has touch screen, this function is useful.
388 * Otherwise device does not have that, we can use it after connecting mouse to the device.
390 * @param[in] window The window instance.
391 * @param[in] inputRegion The subtracted region to except input events.
393 DALI_ADAPTOR_API void ExcludeInputRegion(Window window, const Rect<int>& inputRegion);
396 * @brief Sets the necessary for window rotation Acknowledgement.
397 * After this function called, SendRotationCompletedAcknowledgement() should be called to complete window rotation.
399 * This function is supprot that application has the window rotation acknowledgement's control.
400 * It means display server waits when application's rotation work is finished.
401 * It is useful application has the other rendering engine which works asynchronous.
402 * For instance, GlView.
403 * It only works on Tizen device.
405 * @param[in] window The window instance.
406 * @param[in] needAcknowledgement the flag is true if window rotation acknowledge is sent.
408 DALI_ADAPTOR_API void SetNeedsRotationCompletedAcknowledgement(Window window, bool needAcknowledgement);
411 * @brief send the Acknowledgement to complete window rotation.
412 * For this function, SetNeedsRotationCompletedAcknowledgement should be already called with true.
414 * @param[in] window The window instance.
416 DALI_ADAPTOR_API void SendRotationCompletedAcknowledgement(Window window);
419 * @brief Feed (Send) touch event to window
420 * @param[in] window The window instance
421 * @param[in] point The touch point
422 * @param[in] timeStamp The time stamp
424 DALI_ADAPTOR_API void FeedTouchPoint(Window window, const Dali::TouchPoint& point, int32_t timeStamp);
427 * @brief Feed (Send) wheel event to window
428 * @param[in] window The window instance
429 * @param[in] wheelEvent The wheel event
431 DALI_ADAPTOR_API void FeedWheelEvent(Window window, const Dali::WheelEvent& wheelEvent);
434 * @brief Feed (Send) key event to window
435 * @param[in] window The window instance
436 * @param[in] keyEvent The key event holding the key information.
438 DALI_ADAPTOR_API void FeedKeyEvent(Window window, const Dali::KeyEvent& keyEvent);
441 * @brief Feed (Send) hover event to window
442 * @param[in] window The window instance
443 * @param[in] point The touch point that create a hover event
445 DALI_ADAPTOR_API void FeedHoverEvent(Window window, const Dali::TouchPoint& point);
448 * @brief Maximizes window's size.
449 * If this function is called with true, window will be resized with screen size.
450 * Otherwise window will be resized with previous size.
451 * It is for the window's MAX button in window's border.
453 * It is for client application.
454 * If window border is supported by display server, it is not necessary.
456 * @param[in] window The window instance.
457 * @param[in] maximize If window is maximized or unmaximized.
459 DALI_ADAPTOR_API void Maximize(Window window, bool maximize);
462 * @brief Returns whether the window is maximized or not.
464 * @param[in] window The window instance.
465 * @return True if the window is maximized, false otherwise.
467 DALI_ADAPTOR_API bool IsMaximized(Window window);
470 * @brief Sets window's maximum size.
472 * It is to set the maximized size when window is maximized or the window's size is increased by RequestResizeToServer().
473 * Although the size is set by this function, window's size can be increased over the limitation by SetPositionSize() or SetSize().
475 * After setting, if Maximize() is called, window is resized with the setting size and move the center.
477 * @param[in] window The window instance.
478 * @param[in] size the maximum size
480 DALI_ADAPTOR_API void SetMaximumSize(Window window, Dali::Window::WindowSize size);
483 * @brief Minimizes window's size.
484 * If this function is called with true, window will be iconified.
485 * Otherwise window will be activated.
486 * It is for the window's MIN button in window border.
488 * It is for client application.
489 * If window border is supported by display server, it is not necessary.
491 * @param[in] window The window instance.
492 * @param[in] minimize If window is minimized or unminimized(activated).
494 DALI_ADAPTOR_API void Minimize(Window window, bool minimize);
497 * @brief Returns whether the window is minimized or not.
499 * @param[in] window The window instance.
500 * @return True if the window is minimized, false otherwise.
502 DALI_ADAPTOR_API bool IsMinimized(Window window);
505 * @brief Sets window's minimum size.
507 * It is to set the minimum size when window's size is decreased by RequestResizeToServer().
508 * Although the size is set by this function, window's size can be decreased over the limitation by SetPositionSize() or SetSize().
510 * @param[in] window The window instance.
511 * @param[in] size the minimum size
513 DALI_ADAPTOR_API void SetMimimumSize(Window window, Dali::Window::WindowSize size);
516 * @brief Query whether window is rotating or not.
518 * @param[in] window The window instance.
519 * @return true if window is rotating, false otherwise.
521 DALI_ADAPTOR_API bool IsWindowRotating(Window window);
524 * @brief Gets the last key event the window gets.
526 * @param[in] window The window instance.
527 * @return The last key event the window gets.
529 DALI_ADAPTOR_API const KeyEvent& GetLastKeyEvent(Window window);
532 * @brief Gets the last touch event the window gets.
534 * @param[in] window The window instance.
535 * @return The last touch event the window gets.
536 * @note It returns the raw event the window gets. There is no hit-actor and local position information.
538 DALI_ADAPTOR_API const TouchEvent& GetLastTouchEvent(Window window);
541 * @brief Sets the pointer constraints lock.
543 * @param[in] window The window instance.
544 * @return Returns true if PointerConstraintsLock succeeds.
546 DALI_ADAPTOR_API bool PointerConstraintsLock(Window window);
549 * @brief Sets the pointer constraints unlock.
551 * @param[in] window The window instance.
552 * @return Returns true if PointerConstraintsUnlock succeeds.
554 DALI_ADAPTOR_API bool PointerConstraintsUnlock(Window window);
557 * @brief Sets the locked pointer region
559 * @param[in] window The window instance.
560 * @param[in] x The x position.
561 * @param[in] y The y position.
562 * @param[in] width The width.
563 * @param[in] height The height
565 DALI_ADAPTOR_API void LockedPointerRegionSet(Window window, int32_t x, int32_t y, int32_t width, int32_t height);
568 * @brief Sets the locked pointer cursor position hintset
570 * @param[in] window The window instance.
571 * @param[in] x The x position.
572 * @param[in] y The y position.
574 DALI_ADAPTOR_API void LockedPointerCursorPositionHintSet(Window window, int32_t x, int32_t y);
577 * @brief Sets the pointer warp. The pointer moves to the set coordinates.
579 * @param[in] window The window instance.
580 * @param[in] x The x position.
581 * @param[in] y The y position.
582 * @return Returns true if PointerWarp succeeds.
584 DALI_ADAPTOR_API bool PointerWarp(Window window, int32_t x, int32_t y);
587 * @brief The user would connect to this signal to intercept a KeyEvent at window.
589 * Intercepts KeyEvents in the window before dispatching KeyEvents to the control.
590 * If a KeyEvent is consumed, no KeyEvent is delivered to the control.
592 * @param[in] window The window instance.
593 * @return The signal to connect to
595 DALI_ADAPTOR_API InterceptKeyEventSignalType& InterceptKeyEventSignal(Window window);
598 * @brief This signal is emitted when the window is moved.
600 * A callback of the following type may be connected:
602 * void YourCallbackName( Window window, Dali::Window::WindowPosition position );
604 * The parameters are the moved x and y coordinates.
605 * and window means this signal was called from what window
607 * @param[in] window The window instance.
608 * @return The signal to connect to
610 DALI_ADAPTOR_API MovedSignalType& MovedSignal(Window window);
613 * @brief This signal is emitted when the window orientation is changed.
615 * To emit Window Orientation signal, AddAvailableOrientation() or SetPreferredOrientation() should be called before device is rotated.
616 * Most of cases, AddAvailableOrientation() or SetPreferredOrientation() is callled in onCreate().
618 * A callback of the following type may be connected:
620 * void YourCallbackName( Window window, Dali::WindowOrientation orientation );
622 * The parameter is the changed window orientation.
623 * and window means this signal was called from what window
625 * @param[in] window The window instance.
626 * @return The signal to connect to
628 DALI_ADAPTOR_API OrientationChangedSignalType& OrientationChangedSignal(Window window);
631 * @brief This signal is emitted when the mouse in or out event is received.
633 * A callback of the following type may be connected:
635 * void YourCallbackName( Window window, Dali::MouseInOutEvent event );
638 * @param[in] window The window instance.
639 * @return The signal to connect to
641 DALI_ADAPTOR_API MouseInOutEventSignalType& MouseInOutEventSignal(Window window);
644 * @brief This signal is emitted when the mouse relative event is received.
646 * A callback of the following type may be connected:
648 * void YourCallbackName( Window window, Dali::MouseRelativeEvent event );
651 * @param[in] window The window instance.
652 * @return The signal to connect to
654 DALI_ADAPTOR_API MouseRelativeEventSignalType& MouseRelativeEventSignal(Window window);
657 * @brief This signal is emitted when window has been moved by the display server.
658 * To make the window move by display server, RequestMoveToServer() should be called.
659 * After the moving job is completed, this function will be called.
661 * A callback of the following type may be connected:
663 * void YourCallbackName( Window window, Dali::Window::WindowPosition position );
665 * The parameters are the moved x and y coordinates.
666 * and window means this signal was called from what window
668 * @param[in] window The window instance.
669 * @return The signal to connect to
671 DALI_ADAPTOR_API MoveCompletedSignalType& MoveCompletedSignal(Window window);
674 * @brief This signal is emitted when window has been resized by the display server.
675 * To make the window move by display server, RequestResizeToServer() should be called.
676 * After the resizing job is completed, this function will be called.
678 * A callback of the following type may be connected:
680 * void YourCallbackName( Window window, Dali::Window::WindowPosition position );
682 * The parameters are the resized width and height coordinates.
683 * and window means this signal was called from what window
685 * @param[in] window The window instance.
686 * @return The signal to connect to
688 DALI_ADAPTOR_API ResizeCompletedSignalType& ResizeCompletedSignal(Window window);
691 * @brief This signal is emitted when window insets are changed by appearing or disappearing indicator, virtual keyboard, or clipboard.
693 * @param[in] window The window instance
694 * @return The signal to connect to
696 DALI_ADAPTOR_API InsetsChangedSignalType& InsetsChangedSignal(Window window);
698 } // namespace DevelWindow
702 #endif // DALI_WINDOW_DEVEL_H