dali/devel-api/adaptor-framework/window-devel.h

   1 #ifndef DALI_WINDOW_DEVEL_H
   2 #define DALI_WINDOW_DEVEL_H
   3
   4 /*
   5  * Copyright (c) 2023 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <memory>
  23
  24 // INTERNAL INCLUDES
  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/devel-api/adaptor-framework/pointer-constraints-event.h>
  28 #include <dali/public-api/adaptor-framework/window-enumerations.h>
  29 #include <dali/public-api/adaptor-framework/window.h>
  30 #include <dali/public-api/common/vector-wrapper.h>
  31
  32 namespace Dali
  33 {
  34 class KeyEvent;
  35 class TouchEvent;
  36 class WheelEvent;
  37 class RenderTaskList;
  38 struct TouchPoint;
  39
  40 namespace DevelWindow
  41 {
  42 typedef Signal<void()>                                                               EventProcessingFinishedSignalType;       ///< Event Processing finished signal type
  43 typedef Signal<void(const KeyEvent&)>                                                KeyEventSignalType;                      ///< Key event signal type
  44 typedef Signal<void(const TouchEvent&)>                                              TouchEventSignalType;                    ///< Touch signal type
  45 typedef Signal<void(const WheelEvent&)>                                              WheelEventSignalType;                    ///< Wheel signal type
  46 typedef Signal<void(Window, bool)>                                                   VisibilityChangedSignalType;             ///< Visibility changed signal type
  47 typedef Signal<void(Window, WindowEffectState, WindowEffectType)>                    TransitionEffectEventSignalType;         ///< Effect signal type and state
  48 typedef Signal<void()>                                                               KeyboardRepeatSettingsChangedSignalType; ///< Keyboard repeat settings changed signal type
  49 typedef Signal<void(const std::string&, const std::string&, const Property::Array&)> AuxiliaryMessageSignalType;              ///< Auxiliary message signal type
  50 typedef Signal<void(Window, bool)>                                                   AccessibilityHighlightSignalType;        ///< Accessibility Highlight signal type
  51 typedef Signal<bool(const KeyEvent&)>                                                InterceptKeyEventSignalType;             ///< Intercept Key event signal type
  52 typedef Signal<void(Window, Dali::Window::WindowPosition)>                           MovedSignalType;                         ///< Window Moved signal type
  53 typedef Signal<void(Window, Dali::WindowOrientation)>                                OrientationChangedSignalType;            ///< Window orientation changed signal type
  54 typedef Signal<void(Window, const Dali::DevelWindow::MouseInOutEvent&)>              MouseInOutEventSignalType;               ///< MouseInOutEvent signal type
  55 typedef Signal<void(Window, const Dali::DevelWindow::MouseRelativeEvent&)>           MouseRelativeEventSignalType;            ///< MouseRelativeEvent signal type
  56 typedef Signal<void(Window, Dali::Window::WindowPosition)>                           MoveCompletedSignalType;                 ///< Window Moved by Server signal type
  57 typedef Signal<void(Window, Dali::Window::WindowSize)>                               ResizeCompletedSignalType;               ///< Window Resized by Server signal type
  58 typedef Signal<void(WindowInsetsPartType, WindowInsetsPartState, const Extents&)>    InsetsChangedSignalType;                 ///< InsetsChanged signal type
  59 typedef Signal<void(Window, const Dali::DevelWindow::PointerConstraintsEvent&)>      PointerConstraintsSignalType;            ///< PointerConstraintsEvent signal type
  60
  61 /**
  62  * @brief Creates an initialized handle to a new Window.
  63  *
  64  * @param[in] surface Can be a window or pixmap.
  65  * @param[in] windowPosition The position and size of the Window
  66  * @param[in] name The Window title
  67  * @param[in] isTransparent Whether Window is transparent
  68  * @return A new window
  69  * @note This creates an extra window in addition to the default main window
  70  */
  71 DALI_ADAPTOR_API Window New(Any surface, PositionSize windowPosition, const std::string& name, bool isTransparent = false);
  72
  73 /**
  74  * @brief Creates an initialized handle to a new Window.
  75  *
  76  * @param[in] surface Can be a window or pixmap.
  77  * @param[in] windowPosition The position and size of the Window
  78  * @param[in] name The Window title
  79  * @param[in] className The Window class name
  80  * @param[in] isTransparent Whether Window is transparent
  81  * @note This creates an extra window in addition to the default main window
  82  * @return A new Window
  83  */
  84 DALI_ADAPTOR_API Window New(Any surface, PositionSize windowPosition, const std::string& name, const std::string& className, bool isTransparent = false);
  85
  86 /**
  87  * @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.
  88  *
  89  * @param[in] window The window instance
  90  * @param[in] positionSize The new window position and size
  91  */
  92 DALI_ADAPTOR_API void SetPositionSize(Window window, PositionSize positionSize);
  93
  94 /**
  95  * @brief Retrieve the window that the given actor is added to.
  96  *
  97  * @param[in] actor The actor
  98  * @return The window the actor is added to or an empty handle if the actor is not added to any window.
  99  */
 100 DALI_ADAPTOR_API Window Get(Actor actor);
 101
 102 /**
 103  * @brief This signal is emitted just after the event processing is finished.
 104  *
 105  * @param[in] window The window instance
 106  * @return The signal to connect to
 107  */
 108 DALI_ADAPTOR_API EventProcessingFinishedSignalType& EventProcessingFinishedSignal(Window window);
 109
 110 /**
 111  * @brief This signal is emitted when wheel event is received.
 112  *
 113  * A callback of the following type may be connected:
 114  * @code
 115  *   void YourCallbackName(const WheelEvent& event);
 116  * @endcode
 117  * @param[in] window The window instance
 118  * @return The signal to connect to
 119  */
 120 DALI_ADAPTOR_API WheelEventSignalType& WheelEventSignal(Window window);
 121
 122 /**
 123  * @brief This signal is emitted when the window is shown or hidden.
 124  *
 125  * A callback of the following type may be connected:
 126  * @code
 127  *   void YourCallbackName( Window window, bool visible );
 128  * @endcode
 129  * @param[in] window The window instance
 130  * @return The signal to connect to
 131  */
 132 DALI_ADAPTOR_API VisibilityChangedSignalType& VisibilityChangedSignal(Window window);
 133
 134 /**
 135  * @brief This signal is emitted for transition effect.
 136  *
 137  * The transition animation is appeared when the window is shown/hidden.
 138  * When the animation is started, START signal is emitted.
 139  * Then the animation is ended, END signal is emitted, too.
 140  * A callback of the following type may be connected:
 141  * @code
 142  *   void YourCallbackName( Window window, EffectState state, EffectType type );
 143  * @endcode
 144  * @param[in] window The window instance
 145  * @return The signal to connect to
 146  */
 147 DALI_ADAPTOR_API TransitionEffectEventSignalType& TransitionEffectEventSignal(Window window);
 148
 149 /**
 150  * @brief This signal is emitted just after the keyboard repeat setting is changed globally.
 151  *
 152  * @param[in] window The window instance
 153  * @return The signal to connect to
 154  */
 155 DALI_ADAPTOR_API KeyboardRepeatSettingsChangedSignalType& KeyboardRepeatSettingsChangedSignal(Window window);
 156
 157 /**
 158  * @brief This signal is emitted when window's auxiliary was changed then display server sent the message.
 159  *
 160  * Auxiliary message is sent by display server.
 161  * When client application added the window's auxiliary hint and if the auxiliary is changed,
 162  * display server send the auxiliary message.
 163  * Auxiliary message has the key, value and options.
 164  *
 165  * @param[in] window The window instance
 166  * @return The signal to connect to
 167  */
 168 DALI_ADAPTOR_API AuxiliaryMessageSignalType& AuxiliaryMessageSignal(Window window);
 169
 170 /**
 171  * @brief This signal is emitted when the window needs to grab or clear accessibility highlight.
 172  * The highlight indicates that it is an object to interact with the user regardless of focus.
 173  * After setting the highlight on the object, you can do things that the object can do, such as
 174  * giving or losing focus.
 175  *
 176  * This signal is emitted by Dali::Accessibility::Component::GrabHighlight
 177  * and Dali::Accessibility::Component::ClearHighlight
 178  *
 179  * A callback of the following type may be connected:
 180  * @code
 181  *   void YourCallbackName( Window window, bool highlight );
 182  * @endcode
 183  *
 184  * @param[in] window The window instance
 185  * @return The signal to connect to
 186  */
 187 DALI_ADAPTOR_API AccessibilityHighlightSignalType& AccessibilityHighlightSignal(Window window);
 188
 189 /**
 190  * @brief Sets parent window of the window.
 191  *
 192  * After setting that, these windows do together when raise-up, lower and iconified/deiconified.
 193  * Initially, the window is located on top of the parent. The window can go below parent by calling Lower().
 194  * If parent's window stack is changed by calling Raise() or Lower(), child windows are located on top of the parent again.
 195  *
 196  * @param[in] window The window instance
 197  * @param[in] parent The parent window instance
 198  */
 199 DALI_ADAPTOR_API void SetParent(Window window, Window parent);
 200
 201 /**
 202  * @brief Sets parent window of the window.
 203  *
 204  * After setting that, these windows do together when raise-up, lower and iconified/deiconified.
 205  * This function has the additional flag whether the child is located above or below of the parent.
 206  *
 207  * @param[in] window The window instance
 208  * @param[in] parent The parent window instance
 209  * @param[in] belowParent The flag is whether the child is located above or below of the parent.
 210  */
 211 DALI_ADAPTOR_API void SetParent(Window window, Window parent, bool belowParent);
 212
 213 /**
 214  * @brief Unsets parent window of the window.
 215  *
 216  * After unsetting, the window is disconnected his parent window.
 217  *
 218  * @param[in] window The window instance
 219  */
 220 DALI_ADAPTOR_API void Unparent(Window window);
 221
 222 /**
 223  * @brief Gets parent window of the window.
 224  *
 225  * @param[in] window The window instance
 226  * @return The parent window of the window
 227  */
 228 DALI_ADAPTOR_API Window GetParent(Window window);
 229
 230 /**
 231  * @brief Gets current orientation of the window.
 232  *
 233  * @param[in] window The window instance
 234  * @return The current window orientation if previously set, or none
 235  */
 236 DALI_ADAPTOR_API WindowOrientation GetCurrentOrientation(Window window);
 237
 238 /**
 239  * @brief Gets current physical orientation of the window.
 240  *
 241  * It means current physical rotation angle of the window.
 242  * If the height of the display device's area is greater than the width,
 243  * default current orientation is PORTRAIT and current physical orientation angle is 0.
 244  * If the width of the display device's area is greater than the height,
 245  * default current orientation is LANDSCAPE and current physical orientation angle is 0.
 246  *
 247  * @param[in] window The window instance
 248  * @return The current physical orientation degree of the window. It is one of them as 0, 90, 180 and 270.
 249  */
 250 DALI_ADAPTOR_API int GetPhysicalOrientation(Window window);
 251
 252 /**
 253  * @brief Sets available orientations of the window.
 254  *
 255  * This API is for setting several orientations one time.
 256  *
 257  * @param[in] window The window instance
 258  * @param[in] orientations The available orientation list to add
 259  */
 260 DALI_ADAPTOR_API void SetAvailableOrientations(Window window, const Dali::Vector<WindowOrientation>& orientations);
 261
 262 /**
 263  * @brief Gets current window ID.
 264  *
 265  * @param[in] window The window instance
 266  */
 267 DALI_ADAPTOR_API int32_t GetNativeId(Window window);
 268
 269 /**
 270  * @brief Adds a callback that is called when the frame rendering is done by the graphics driver.
 271  *
 272  * @param[in] window The window instance
 273  * @param[in] callback The function to call
 274  * @param[in] frameId The Id to specify the frame. It will be passed when the callback is called.
 275  *
 276  * @note A callback of the following type may be used:
 277  * @code
 278  *   void MyFunction( int frameId );
 279  * @endcode
 280  * This callback will be deleted once it is called.
 281  *
 282  * @note Ownership of the callback is passed onto this class.
 283  */
 284 DALI_ADAPTOR_API void AddFrameRenderedCallback(Window window, std::unique_ptr<CallbackBase> callback, int32_t frameId);
 285
 286 /**
 287  * @brief Adds a callback that is called when the frame is displayed on the display.
 288  *
 289  * @param[in] window The window instance
 290  * @param[in] callback The function to call
 291  * @param[in] frameId The Id to specify the frame. It will be passed when the callback is called.
 292  *
 293  * @note A callback of the following type may be used:
 294  * @code
 295  *   void MyFunction( int frameId );
 296  * @endcode
 297  * This callback will be deleted once it is called.
 298  *
 299  * @note Ownership of the callback is passed onto this class.
 300  */
 301 DALI_ADAPTOR_API void AddFramePresentedCallback(Window window, std::unique_ptr<CallbackBase> callback, int32_t frameId);
 302
 303 /**
 304  * @brief Sets window position and size for specific orientation.
 305  * This api reserves the position and size per orientation to display server.
 306  * When the device is rotated, the window is moved/resized with the reserved position/size by display server.
 307  *
 308  * @param[in] window The window instance
 309  * @param[in] positionSize The reserved position and size for the orientation
 310  * @param[in] orientation The orientation
 311  *
 312  * @note Currently, it only works when the window's type is WindowType::IME.
 313  * @note To set WindowType::IME, use Application New(... WindowType type), not Window::SetType().
 314  * @note This function is only useful in Tizen world.
 315  */
 316 DALI_ADAPTOR_API void SetPositionSizeWithOrientation(Window window, PositionSize positionSize, WindowOrientation orientation);
 317
 318 /**
 319  * @brief Requests to display server for the window is moved by display server.
 320  *
 321  * This function should be called in mouse down event callback function.
 322  * After this function is called in mouse down event callback function, the window is moved with mouse move event.
 323  * When mouse up event happens, the window moved work is finished.
 324  *
 325  * @param[in] window The window instance
 326  */
 327 DALI_ADAPTOR_API void RequestMoveToServer(Window window);
 328
 329 /**
 330  * @brief Requests to display server for the window is resized by display server.
 331  *
 332  * This function should be called in mouse down event callback function.
 333  * After this function is called in mouse down event callback function, the window is resized with mouse move event.
 334  * The direction is selected one of eight ways.
 335  * When mouse up event happens, the window resized work is finished.
 336  *
 337  * @param[in] window The window instance
 338  * @param[in] direction it is indicated the window's side or edge for starting point.
 339  */
 340 DALI_ADAPTOR_API void RequestResizeToServer(Window window, WindowResizeDirection direction);
 341
 342 /**
 343  * @brief Enables the floating mode of window.
 344  *
 345  * The floating mode is to support making partial size window easliy.
 346  * It is useful to make popup style window and this window is always upper than the other normal window.
 347  * In addition, it is easy to change between popup style and normal style window.
 348  *
 349  * A special display server(as a Tizen display server) supports this mode.
 350  *
 351  * @param[in] window The window instance.
 352  * @param[in] enable Enable floating mode or not.
 353  */
 354 DALI_ADAPTOR_API void EnableFloatingMode(Window window, bool enable);
 355
 356 /**
 357  * @brief Returns whether the window is floating mode or not.
 358  *
 359  * @param[in] window The window instance.
 360  * @return True if the window is enabled floating mode, false otherwise.
 361  */
 362 DALI_ADAPTOR_API bool IsFloatingModeEnabled(Window window);
 363
 364 /**
 365  * @brief Includes input region.
 366  *
 367  * This function inlcudes input regions.
 368  * It can be used multiple times and supports multiple regions.
 369  * It means input region will be extended.
 370  *
 371  * This input is related to mouse and touch event.
 372  * If device has touch screen, this function is useful.
 373  * Otherwise device does not have that, we can use it after connecting mouse to the device.
 374  *
 375  * @param[in] window The window instance.
 376  * @param[in] inputRegion The added region to accept input events.
 377  */
 378 DALI_ADAPTOR_API void IncludeInputRegion(Window window, const Rect<int>& inputRegion);
 379
 380 /**
 381  * @brief Excludes input region.
 382  *
 383  * This function excludes input regions.
 384  * It can be used multiple times and supports multiple regions.
 385  * It means input region will be reduced.
 386  * Nofice, should be set input area by IncludeInputRegion() before this function is used.
 387  *
 388  * This input is related to mouse and touch event.
 389  * If device has touch screen, this function is useful.
 390  * Otherwise device does not have that, we can use it after connecting mouse to the device.
 391  *
 392  * @param[in] window The window instance.
 393  * @param[in] inputRegion The subtracted region to except input events.
 394  */
 395 DALI_ADAPTOR_API void ExcludeInputRegion(Window window, const Rect<int>& inputRegion);
 396
 397 /**
 398  * @brief Sets the necessary for window rotation Acknowledgement.
 399  * After this function called, SendRotationCompletedAcknowledgement() should be called to complete window rotation.
 400  *
 401  * This function is supprot that application has the window rotation acknowledgement's control.
 402  * It means display server waits when application's rotation work is finished.
 403  * It is useful application has the other rendering engine which works asynchronous.
 404  * For instance, GlView.
 405  * It only works on Tizen device.
 406  *
 407  * @param[in] window The window instance.
 408  * @param[in] needAcknowledgement the flag is true if window rotation acknowledge is sent.
 409  */
 410 DALI_ADAPTOR_API void SetNeedsRotationCompletedAcknowledgement(Window window, bool needAcknowledgement);
 411
 412 /**
 413  * @brief send the Acknowledgement to complete window rotation.
 414  * For this function, SetNeedsRotationCompletedAcknowledgement should be already called with true.
 415  *
 416  * @param[in] window The window instance.
 417  */
 418 DALI_ADAPTOR_API void SendRotationCompletedAcknowledgement(Window window);
 419
 420 /**
 421  * @brief Feed (Send) touch event to window
 422  * @param[in] window The window instance
 423  * @param[in] point The touch point
 424  * @param[in] timeStamp The time stamp
 425  */
 426 DALI_ADAPTOR_API void FeedTouchPoint(Window window, const Dali::TouchPoint& point, int32_t timeStamp);
 427
 428 /**
 429  * @brief Feed (Send) wheel event to window
 430  * @param[in] window The window instance
 431  * @param[in] wheelEvent The wheel event
 432  */
 433 DALI_ADAPTOR_API void FeedWheelEvent(Window window, const Dali::WheelEvent& wheelEvent);
 434
 435 /**
 436  * @brief Feed (Send) key event to window
 437  * @param[in] window The window instance
 438  * @param[in] keyEvent The key event holding the key information.
 439  */
 440 DALI_ADAPTOR_API void FeedKeyEvent(Window window, const Dali::KeyEvent& keyEvent);
 441
 442 /**
 443  * @brief Feed (Send) hover event to window
 444  * @param[in] window The window instance
 445  * @param[in] point The touch point that create a hover event
 446  */
 447 DALI_ADAPTOR_API void FeedHoverEvent(Window window, const Dali::TouchPoint& point);
 448
 449 /**
 450  * @brief Maximizes window's size.
 451  * If this function is called with true, window will be resized with screen size.
 452  * Otherwise window will be resized with previous size.
 453  * It is for the window's MAX button in window's border.
 454  *
 455  * It is for client application.
 456  * If window border is supported by display server, it is not necessary.
 457  *
 458  * @param[in] window The window instance.
 459  * @param[in] maximize If window is maximized or unmaximized.
 460  */
 461 DALI_ADAPTOR_API void Maximize(Window window, bool maximize);
 462
 463 /**
 464  * @brief Returns whether the window is maximized or not.
 465  *
 466  * @param[in] window The window instance.
 467  * @return True if the window is maximized, false otherwise.
 468  */
 469 DALI_ADAPTOR_API bool IsMaximized(Window window);
 470
 471 /**
 472  * @brief Sets window's maximum size.
 473  *
 474  * It is to set the maximized size when window is maximized or the window's size is increased by RequestResizeToServer().
 475  * Although the size is set by this function, window's size can be increased over the limitation by SetPositionSize() or SetSize().
 476  *
 477  * After setting, if Maximize() is called, window is resized with the setting size and move the center.
 478  *
 479  * @param[in] window The window instance.
 480  * @param[in] size the maximum size
 481  */
 482 DALI_ADAPTOR_API void SetMaximumSize(Window window, Dali::Window::WindowSize size);
 483
 484 /**
 485  * @brief Minimizes window's size.
 486  * If this function is called with true, window will be iconified.
 487  * Otherwise window will be activated.
 488  * It is for the window's MIN button in window border.
 489  *
 490  * It is for client application.
 491  * If window border is supported by display server, it is not necessary.
 492  *
 493  * @param[in] window The window instance.
 494  * @param[in] minimize If window is minimized or unminimized(activated).
 495  */
 496 DALI_ADAPTOR_API void Minimize(Window window, bool minimize);
 497
 498 /**
 499  * @brief Returns whether the window is minimized or not.
 500  *
 501  * @param[in] window The window instance.
 502  * @return True if the window is minimized, false otherwise.
 503  */
 504 DALI_ADAPTOR_API bool IsMinimized(Window window);
 505
 506 /**
 507  * @brief Sets window's minimum size.
 508  *
 509  * It is to set the minimum size when window's size is decreased by RequestResizeToServer().
 510  * Although the size is set by this function, window's size can be decreased over the limitation by SetPositionSize() or SetSize().
 511  *
 512  * @param[in] window The window instance.
 513  * @param[in] size the minimum size
 514  */
 515 DALI_ADAPTOR_API void SetMimimumSize(Window window, Dali::Window::WindowSize size);
 516
 517 /**
 518  * @brief Query whether window is rotating or not.
 519  *
 520  * @param[in] window The window instance.
 521  * @return true if window is rotating, false otherwise.
 522  */
 523 DALI_ADAPTOR_API bool IsWindowRotating(Window window);
 524
 525 /**
 526  * @brief Gets the last key event the window gets.
 527  *
 528  * @param[in] window The window instance.
 529  * @return The last key event the window gets.
 530  */
 531 DALI_ADAPTOR_API const KeyEvent& GetLastKeyEvent(Window window);
 532
 533 /**
 534  * @brief Gets the last touch event the window gets.
 535  *
 536  * @param[in] window The window instance.
 537  * @return The last touch event the window gets.
 538  * @note It returns the raw event the window gets. There is no hit-actor and local position information.
 539  */
 540 DALI_ADAPTOR_API const TouchEvent& GetLastTouchEvent(Window window);
 541
 542 /**
 543  * @brief Sets the pointer constraints lock.
 544  *
 545  * @param[in] window The window instance.
 546  * @return Returns true if PointerConstraintsLock succeeds.
 547  */
 548 DALI_ADAPTOR_API bool PointerConstraintsLock(Window window);
 549
 550 /**
 551  * @brief Sets the pointer constraints unlock.
 552  *
 553  * @param[in] window The window instance.
 554  * @return Returns true if PointerConstraintsUnlock succeeds.
 555  */
 556 DALI_ADAPTOR_API bool PointerConstraintsUnlock(Window window);
 557
 558 /**
 559  * @brief Sets the locked pointer region
 560  *
 561  * @param[in] window The window instance.
 562  * @param[in] x The x position.
 563  * @param[in] y The y position.
 564  * @param[in] width The width.
 565  * @param[in] height The height
 566  */
 567 DALI_ADAPTOR_API void LockedPointerRegionSet(Window window, int32_t x, int32_t y, int32_t width, int32_t height);
 568
 569 /**
 570  * @brief Sets the locked pointer cursor position hintset
 571  *
 572  * @param[in] window The window instance.
 573  * @param[in] x The x position.
 574  * @param[in] y The y position.
 575  */
 576 DALI_ADAPTOR_API void LockedPointerCursorPositionHintSet(Window window, int32_t x, int32_t y);
 577
 578 /**
 579  * @brief Sets the pointer warp. The pointer moves to the set coordinates.
 580  *
 581  * @param[in] window The window instance.
 582  * @param[in] x The x position.
 583  * @param[in] y The y position.
 584  * @return Returns true if PointerWarp succeeds.
 585  */
 586 DALI_ADAPTOR_API bool PointerWarp(Window window, int32_t x, int32_t y);
 587
 588 /**
 589  * @brief Sets visibility on/off of cursor
 590  *
 591  * @param[in] window The window instance.
 592  * @param[in] visible The visibility of cursor
 593  */
 594 DALI_ADAPTOR_API void CursorVisibleSet(Window window, bool visible);
 595
 596 /**
 597  * @brief Requests grab key events according to the requested device subtype
 598  *
 599  * @param[in] window The window instance.
 600  * @param[in] deviceSubclass The deviceSubclass type.
 601  * @return Returns true if KeyboardGrab succeeds.
 602  */
 603 DALI_ADAPTOR_API bool KeyboardGrab(Window window, Device::Subclass::Type deviceSubclass);
 604
 605 /**
 606  * @brief Requests ungrab key events
 607  *
 608  * @param[in] window The window instance.
 609  * @return Returns true if KeyboardUnGrab succeeds.
 610  */
 611 DALI_ADAPTOR_API bool KeyboardUnGrab(Window window);
 612
 613 /**
 614  * @brief The user would connect to this signal to intercept a KeyEvent at window.
 615  *
 616  * Intercepts KeyEvents in the window before dispatching KeyEvents to the control.
 617  * If a KeyEvent is consumed, no KeyEvent is delivered to the control.
 618  *
 619  * @param[in] window The window instance.
 620  * @return The signal to connect to
 621  */
 622 DALI_ADAPTOR_API InterceptKeyEventSignalType& InterceptKeyEventSignal(Window window);
 623
 624 /**
 625  * @brief This signal is emitted when the window is moved.
 626  *
 627  * A callback of the following type may be connected:
 628  * @code
 629  *   void YourCallbackName( Window window, Dali::Window::WindowPosition position );
 630  * @endcode
 631  * The parameters are the moved x and y coordinates.
 632  * and window means this signal was called from what window
 633  *
 634  * @param[in] window The window instance.
 635  * @return The signal to connect to
 636  */
 637 DALI_ADAPTOR_API MovedSignalType& MovedSignal(Window window);
 638
 639 /**
 640  * @brief This signal is emitted when the window orientation is changed.
 641  *
 642  * To emit Window Orientation signal, AddAvailableOrientation() or SetPreferredOrientation() should be called before device is rotated.
 643  * Most of cases, AddAvailableOrientation() or SetPreferredOrientation() is callled in onCreate().
 644  *
 645  * A callback of the following type may be connected:
 646  * @code
 647  *   void YourCallbackName( Window window, Dali::WindowOrientation orientation );
 648  * @endcode
 649  * The parameter is the changed window orientation.
 650  * and window means this signal was called from what window
 651  *
 652  * @param[in] window The window instance.
 653  * @return The signal to connect to
 654  */
 655 DALI_ADAPTOR_API OrientationChangedSignalType& OrientationChangedSignal(Window window);
 656
 657 /**
 658  * @brief This signal is emitted when the mouse in or out event is received.
 659  *
 660  * A callback of the following type may be connected:
 661  * @code
 662  *   void YourCallbackName( Window window, Dali::MouseInOutEvent event );
 663  * @endcode
 664  *
 665  * @param[in] window The window instance.
 666  * @return The signal to connect to
 667  */
 668 DALI_ADAPTOR_API MouseInOutEventSignalType& MouseInOutEventSignal(Window window);
 669
 670 /**
 671  * @brief This signal is emitted when the mouse relative event is received.
 672  *
 673  * A callback of the following type may be connected:
 674  * @code
 675  *   void YourCallbackName( Window window, Dali::MouseRelativeEvent event );
 676  * @endcode
 677  *
 678  * @param[in] window The window instance.
 679  * @return The signal to connect to
 680  */
 681 DALI_ADAPTOR_API MouseRelativeEventSignalType& MouseRelativeEventSignal(Window window);
 682
 683 /**
 684  * @brief This signal is emitted when window has been moved by the display server.
 685  * To make the window move by display server, RequestMoveToServer() should be called.
 686  * After the moving job is completed, this function will be called.
 687  *
 688  * A callback of the following type may be connected:
 689  * @code
 690  *   void YourCallbackName( Window window, Dali::Window::WindowPosition position );
 691  * @endcode
 692  * The parameters are the moved x and y coordinates.
 693  * and window means this signal was called from what window
 694  *
 695  * @param[in] window The window instance.
 696  * @return The signal to connect to
 697  */
 698 DALI_ADAPTOR_API MoveCompletedSignalType& MoveCompletedSignal(Window window);
 699
 700 /**
 701  * @brief This signal is emitted when window has been resized by the display server.
 702  * To make the window move by display server, RequestResizeToServer() should be called.
 703  * After the resizing job is completed, this function will be called.
 704  *
 705  * A callback of the following type may be connected:
 706  * @code
 707  *   void YourCallbackName( Window window, Dali::Window::WindowPosition position );
 708  * @endcode
 709  * The parameters are the resized width and height coordinates.
 710  * and window means this signal was called from what window
 711  *
 712  * @param[in] window The window instance.
 713  * @return The signal to connect to
 714  */
 715 DALI_ADAPTOR_API ResizeCompletedSignalType& ResizeCompletedSignal(Window window);
 716
 717 /**
 718  * @brief This signal is emitted when window insets are changed by appearing or disappearing indicator, virtual keyboard, or clipboard.
 719  *
 720  * @param[in] window The window instance
 721  * @return The signal to connect to
 722  */
 723 DALI_ADAPTOR_API InsetsChangedSignalType& InsetsChangedSignal(Window window);
 724
 725 /**
 726  * @brief This signal is emitted when pointer is locked/unlocked
 727  *
 728  * @param[in] window The window instance
 729  * @return The signal to connect to
 730  */
 731 DALI_ADAPTOR_API PointerConstraintsSignalType& PointerConstraintsSignal(Window window);
 732
 733 } // namespace DevelWindow
 734
 735 } // namespace Dali
 736
 737 #endif // DALI_WINDOW_DEVEL_H