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/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>
  30
  31 namespace Dali
  32 {
  33 class KeyEvent;
  34 class TouchEvent;
  35 class WheelEvent;
  36 class RenderTaskList;
  37 struct TouchPoint;
  38
  39 namespace DevelWindow
  40 {
  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
  58
  59 /**
  60  * @brief Creates an initialized handle to a new Window.
  61  *
  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
  68  */
  69 DALI_ADAPTOR_API Window New(Any surface, PositionSize windowPosition, const std::string& name, bool isTransparent = false);
  70
  71 /**
  72  * @brief Creates an initialized handle to a new Window.
  73  *
  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
  81  */
  82 DALI_ADAPTOR_API Window New(Any surface, PositionSize windowPosition, const std::string& name, const std::string& className, bool isTransparent = false);
  83
  84 /**
  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.
  86  *
  87  * @param[in] window The window instance
  88  * @param[in] positionSize The new window position and size
  89  */
  90 DALI_ADAPTOR_API void SetPositionSize(Window window, PositionSize positionSize);
  91
  92 /**
  93  * @brief Retrieve the window that the given actor is added to.
  94  *
  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.
  97  */
  98 DALI_ADAPTOR_API Window Get(Actor actor);
  99
 100 /**
 101  * @brief This signal is emitted just after the event processing is finished.
 102  *
 103  * @param[in] window The window instance
 104  * @return The signal to connect to
 105  */
 106 DALI_ADAPTOR_API EventProcessingFinishedSignalType& EventProcessingFinishedSignal(Window window);
 107
 108 /**
 109  * @brief This signal is emitted when wheel event is received.
 110  *
 111  * A callback of the following type may be connected:
 112  * @code
 113  *   void YourCallbackName(const WheelEvent& event);
 114  * @endcode
 115  * @param[in] window The window instance
 116  * @return The signal to connect to
 117  */
 118 DALI_ADAPTOR_API WheelEventSignalType& WheelEventSignal(Window window);
 119
 120 /**
 121  * @brief This signal is emitted when the window is shown or hidden.
 122  *
 123  * A callback of the following type may be connected:
 124  * @code
 125  *   void YourCallbackName( Window window, bool visible );
 126  * @endcode
 127  * @param[in] window The window instance
 128  * @return The signal to connect to
 129  */
 130 DALI_ADAPTOR_API VisibilityChangedSignalType& VisibilityChangedSignal(Window window);
 131
 132 /**
 133  * @brief This signal is emitted for transition effect.
 134  *
 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:
 139  * @code
 140  *   void YourCallbackName( Window window, EffectState state, EffectType type );
 141  * @endcode
 142  * @param[in] window The window instance
 143  * @return The signal to connect to
 144  */
 145 DALI_ADAPTOR_API TransitionEffectEventSignalType& TransitionEffectEventSignal(Window window);
 146
 147 /**
 148  * @brief This signal is emitted just after the keyboard repeat setting is changed globally.
 149  *
 150  * @param[in] window The window instance
 151  * @return The signal to connect to
 152  */
 153 DALI_ADAPTOR_API KeyboardRepeatSettingsChangedSignalType& KeyboardRepeatSettingsChangedSignal(Window window);
 154
 155 /**
 156  * @brief This signal is emitted when window's auxiliary was changed then display server sent the message.
 157  *
 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.
 162  *
 163  * @param[in] window The window instance
 164  * @return The signal to connect to
 165  */
 166 DALI_ADAPTOR_API AuxiliaryMessageSignalType& AuxiliaryMessageSignal(Window window);
 167
 168 /**
 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.
 173  *
 174  * This signal is emitted by Dali::Accessibility::Component::GrabHighlight
 175  * and Dali::Accessibility::Component::ClearHighlight
 176  *
 177  * A callback of the following type may be connected:
 178  * @code
 179  *   void YourCallbackName( Window window, bool highlight );
 180  * @endcode
 181  *
 182  * @param[in] window The window instance
 183  * @return The signal to connect to
 184  */
 185 DALI_ADAPTOR_API AccessibilityHighlightSignalType& AccessibilityHighlightSignal(Window window);
 186
 187 /**
 188  * @brief Sets parent window of the window.
 189  *
 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.
 193  *
 194  * @param[in] window The window instance
 195  * @param[in] parent The parent window instance
 196  */
 197 DALI_ADAPTOR_API void SetParent(Window window, Window parent);
 198
 199 /**
 200  * @brief Sets parent window of the window.
 201  *
 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.
 204  *
 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.
 208  */
 209 DALI_ADAPTOR_API void SetParent(Window window, Window parent, bool belowParent);
 210
 211 /**
 212  * @brief Unsets parent window of the window.
 213  *
 214  * After unsetting, the window is disconnected his parent window.
 215  *
 216  * @param[in] window The window instance
 217  */
 218 DALI_ADAPTOR_API void Unparent(Window window);
 219
 220 /**
 221  * @brief Gets parent window of the window.
 222  *
 223  * @param[in] window The window instance
 224  * @return The parent window of the window
 225  */
 226 DALI_ADAPTOR_API Window GetParent(Window window);
 227
 228 /**
 229  * @brief Gets current orientation of the window.
 230  *
 231  * @param[in] window The window instance
 232  * @return The current window orientation if previously set, or none
 233  */
 234 DALI_ADAPTOR_API WindowOrientation GetCurrentOrientation(Window window);
 235
 236 /**
 237  * @brief Gets current physical orientation of the window.
 238  *
 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.
 244  *
 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.
 247  */
 248 DALI_ADAPTOR_API int GetPhysicalOrientation(Window window);
 249
 250 /**
 251  * @brief Sets available orientations of the window.
 252  *
 253  * This API is for setting several orientations one time.
 254  *
 255  * @param[in] window The window instance
 256  * @param[in] orientations The available orientation list to add
 257  */
 258 DALI_ADAPTOR_API void SetAvailableOrientations(Window window, const Dali::Vector<WindowOrientation>& orientations);
 259
 260 /**
 261  * @brief Gets current window ID.
 262  *
 263  * @param[in] window The window instance
 264  */
 265 DALI_ADAPTOR_API int32_t GetNativeId(Window window);
 266
 267 /**
 268  * @brief Adds a callback that is called when the frame rendering is done by the graphics driver.
 269  *
 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.
 273  *
 274  * @note A callback of the following type may be used:
 275  * @code
 276  *   void MyFunction( int frameId );
 277  * @endcode
 278  * This callback will be deleted once it is called.
 279  *
 280  * @note Ownership of the callback is passed onto this class.
 281  */
 282 DALI_ADAPTOR_API void AddFrameRenderedCallback(Window window, std::unique_ptr<CallbackBase> callback, int32_t frameId);
 283
 284 /**
 285  * @brief Adds a callback that is called when the frame is displayed on the display.
 286  *
 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.
 290  *
 291  * @note A callback of the following type may be used:
 292  * @code
 293  *   void MyFunction( int frameId );
 294  * @endcode
 295  * This callback will be deleted once it is called.
 296  *
 297  * @note Ownership of the callback is passed onto this class.
 298  */
 299 DALI_ADAPTOR_API void AddFramePresentedCallback(Window window, std::unique_ptr<CallbackBase> callback, int32_t frameId);
 300
 301 /**
 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.
 305  *
 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
 309  *
 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.
 313  */
 314 DALI_ADAPTOR_API void SetPositionSizeWithOrientation(Window window, PositionSize positionSize, WindowOrientation orientation);
 315
 316 /**
 317  * @brief Requests to display server for the window is moved by display server.
 318  *
 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.
 322  *
 323  * @param[in] window The window instance
 324  */
 325 DALI_ADAPTOR_API void RequestMoveToServer(Window window);
 326
 327 /**
 328  * @brief Requests to display server for the window is resized by display server.
 329  *
 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.
 334  *
 335  * @param[in] window The window instance
 336  * @param[in] direction it is indicated the window's side or edge for starting point.
 337  */
 338 DALI_ADAPTOR_API void RequestResizeToServer(Window window, WindowResizeDirection direction);
 339
 340 /**
 341  * @brief Enables the floating mode of window.
 342  *
 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.
 346  *
 347  * A special display server(as a Tizen display server) supports this mode.
 348  *
 349  * @param[in] window The window instance.
 350  * @param[in] enable Enable floating mode or not.
 351  */
 352 DALI_ADAPTOR_API void EnableFloatingMode(Window window, bool enable);
 353
 354 /**
 355  * @brief Returns whether the window is floating mode or not.
 356  *
 357  * @param[in] window The window instance.
 358  * @return True if the window is enabled floating mode, false otherwise.
 359  */
 360 DALI_ADAPTOR_API bool IsFloatingModeEnabled(Window window);
 361
 362 /**
 363  * @brief Includes input region.
 364  *
 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.
 368  *
 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.
 372  *
 373  * @param[in] window The window instance.
 374  * @param[in] inputRegion The added region to accept input events.
 375  */
 376 DALI_ADAPTOR_API void IncludeInputRegion(Window window, const Rect<int>& inputRegion);
 377
 378 /**
 379  * @brief Excludes input region.
 380  *
 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.
 385  *
 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.
 389  *
 390  * @param[in] window The window instance.
 391  * @param[in] inputRegion The subtracted region to except input events.
 392  */
 393 DALI_ADAPTOR_API void ExcludeInputRegion(Window window, const Rect<int>& inputRegion);
 394
 395 /**
 396  * @brief Sets the necessary for window rotation Acknowledgement.
 397  * After this function called, SendRotationCompletedAcknowledgement() should be called to complete window rotation.
 398  *
 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.
 404  *
 405  * @param[in] window The window instance.
 406  * @param[in] needAcknowledgement the flag is true if window rotation acknowledge is sent.
 407  */
 408 DALI_ADAPTOR_API void SetNeedsRotationCompletedAcknowledgement(Window window, bool needAcknowledgement);
 409
 410 /**
 411  * @brief send the Acknowledgement to complete window rotation.
 412  * For this function, SetNeedsRotationCompletedAcknowledgement should be already called with true.
 413  *
 414  * @param[in] window The window instance.
 415  */
 416 DALI_ADAPTOR_API void SendRotationCompletedAcknowledgement(Window window);
 417
 418 /**
 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
 423  */
 424 DALI_ADAPTOR_API void FeedTouchPoint(Window window, const Dali::TouchPoint& point, int32_t timeStamp);
 425
 426 /**
 427  * @brief Feed (Send) wheel event to window
 428  * @param[in] window The window instance
 429  * @param[in] wheelEvent The wheel event
 430  */
 431 DALI_ADAPTOR_API void FeedWheelEvent(Window window, const Dali::WheelEvent& wheelEvent);
 432
 433 /**
 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.
 437  */
 438 DALI_ADAPTOR_API void FeedKeyEvent(Window window, const Dali::KeyEvent& keyEvent);
 439
 440 /**
 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
 444  */
 445 DALI_ADAPTOR_API void FeedHoverEvent(Window window, const Dali::TouchPoint& point);
 446
 447 /**
 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.
 452  *
 453  * It is for client application.
 454  * If window border is supported by display server, it is not necessary.
 455  *
 456  * @param[in] window The window instance.
 457  * @param[in] maximize If window is maximized or unmaximized.
 458  */
 459 DALI_ADAPTOR_API void Maximize(Window window, bool maximize);
 460
 461 /**
 462  * @brief Returns whether the window is maximized or not.
 463  *
 464  * @param[in] window The window instance.
 465  * @return True if the window is maximized, false otherwise.
 466  */
 467 DALI_ADAPTOR_API bool IsMaximized(Window window);
 468
 469 /**
 470  * @brief Sets window's maximum size.
 471  *
 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().
 474  *
 475  * After setting, if Maximize() is called, window is resized with the setting size and move the center.
 476  *
 477  * @param[in] window The window instance.
 478  * @param[in] size the maximum size
 479  */
 480 DALI_ADAPTOR_API void SetMaximumSize(Window window, Dali::Window::WindowSize size);
 481
 482 /**
 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.
 487  *
 488  * It is for client application.
 489  * If window border is supported by display server, it is not necessary.
 490  *
 491  * @param[in] window The window instance.
 492  * @param[in] minimize If window is minimized or unminimized(activated).
 493  */
 494 DALI_ADAPTOR_API void Minimize(Window window, bool minimize);
 495
 496 /**
 497  * @brief Returns whether the window is minimized or not.
 498  *
 499  * @param[in] window The window instance.
 500  * @return True if the window is minimized, false otherwise.
 501  */
 502 DALI_ADAPTOR_API bool IsMinimized(Window window);
 503
 504 /**
 505  * @brief Sets window's minimum size.
 506  *
 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().
 509  *
 510  * @param[in] window The window instance.
 511  * @param[in] size the minimum size
 512  */
 513 DALI_ADAPTOR_API void SetMimimumSize(Window window, Dali::Window::WindowSize size);
 514
 515 /**
 516  * @brief Query whether window is rotating or not.
 517  *
 518  * @param[in] window The window instance.
 519  * @return true if window is rotating, false otherwise.
 520  */
 521 DALI_ADAPTOR_API bool IsWindowRotating(Window window);
 522
 523 /**
 524  * @brief Gets the last key event the window gets.
 525  *
 526  * @param[in] window The window instance.
 527  * @return The last key event the window gets.
 528  */
 529 DALI_ADAPTOR_API const KeyEvent& GetLastKeyEvent(Window window);
 530
 531 /**
 532  * @brief Gets the last touch event the window gets.
 533  *
 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.
 537  */
 538 DALI_ADAPTOR_API const TouchEvent& GetLastTouchEvent(Window window);
 539
 540 /**
 541  * @brief Sets the pointer constraints lock.
 542  *
 543  * @param[in] window The window instance.
 544  * @return Returns true if PointerConstraintsLock succeeds.
 545  */
 546 DALI_ADAPTOR_API bool PointerConstraintsLock(Window window);
 547
 548 /**
 549  * @brief Sets the pointer constraints unlock.
 550  *
 551  * @param[in] window The window instance.
 552  * @return Returns true if PointerConstraintsUnlock succeeds.
 553  */
 554 DALI_ADAPTOR_API bool PointerConstraintsUnlock(Window window);
 555
 556 /**
 557  * @brief Sets the locked pointer region
 558  *
 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
 564  */
 565 DALI_ADAPTOR_API void LockedPointerRegionSet(Window window, int32_t x, int32_t y, int32_t width, int32_t height);
 566
 567 /**
 568  * @brief Sets the locked pointer cursor position hintset
 569  *
 570  * @param[in] window The window instance.
 571  * @param[in] x The x position.
 572  * @param[in] y The y position.
 573  */
 574 DALI_ADAPTOR_API void LockedPointerCursorPositionHintSet(Window window, int32_t x, int32_t y);
 575
 576 /**
 577  * @brief Sets the pointer warp. The pointer moves to the set coordinates.
 578  *
 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.
 583  */
 584 DALI_ADAPTOR_API bool PointerWarp(Window window, int32_t x, int32_t y);
 585
 586 /**
 587  * @brief Sets visibility on/off of cursor
 588  *
 589  * @param[in] window The window instance.
 590  * @param[in] visible The visibility of cursor
 591  */
 592 DALI_ADAPTOR_API void CursorVisibleSet(Window window, bool visible);
 593
 594 /**
 595  * @brief The user would connect to this signal to intercept a KeyEvent at window.
 596  *
 597  * Intercepts KeyEvents in the window before dispatching KeyEvents to the control.
 598  * If a KeyEvent is consumed, no KeyEvent is delivered to the control.
 599  *
 600  * @param[in] window The window instance.
 601  * @return The signal to connect to
 602  */
 603 DALI_ADAPTOR_API InterceptKeyEventSignalType& InterceptKeyEventSignal(Window window);
 604
 605 /**
 606  * @brief This signal is emitted when the window is moved.
 607  *
 608  * A callback of the following type may be connected:
 609  * @code
 610  *   void YourCallbackName( Window window, Dali::Window::WindowPosition position );
 611  * @endcode
 612  * The parameters are the moved x and y coordinates.
 613  * and window means this signal was called from what window
 614  *
 615  * @param[in] window The window instance.
 616  * @return The signal to connect to
 617  */
 618 DALI_ADAPTOR_API MovedSignalType& MovedSignal(Window window);
 619
 620 /**
 621  * @brief This signal is emitted when the window orientation is changed.
 622  *
 623  * To emit Window Orientation signal, AddAvailableOrientation() or SetPreferredOrientation() should be called before device is rotated.
 624  * Most of cases, AddAvailableOrientation() or SetPreferredOrientation() is callled in onCreate().
 625  *
 626  * A callback of the following type may be connected:
 627  * @code
 628  *   void YourCallbackName( Window window, Dali::WindowOrientation orientation );
 629  * @endcode
 630  * The parameter is the changed window orientation.
 631  * and window means this signal was called from what window
 632  *
 633  * @param[in] window The window instance.
 634  * @return The signal to connect to
 635  */
 636 DALI_ADAPTOR_API OrientationChangedSignalType& OrientationChangedSignal(Window window);
 637
 638 /**
 639  * @brief This signal is emitted when the mouse in or out event is received.
 640  *
 641  * A callback of the following type may be connected:
 642  * @code
 643  *   void YourCallbackName( Window window, Dali::MouseInOutEvent event );
 644  * @endcode
 645  *
 646  * @param[in] window The window instance.
 647  * @return The signal to connect to
 648  */
 649 DALI_ADAPTOR_API MouseInOutEventSignalType& MouseInOutEventSignal(Window window);
 650
 651 /**
 652  * @brief This signal is emitted when the mouse relative event is received.
 653  *
 654  * A callback of the following type may be connected:
 655  * @code
 656  *   void YourCallbackName( Window window, Dali::MouseRelativeEvent event );
 657  * @endcode
 658  *
 659  * @param[in] window The window instance.
 660  * @return The signal to connect to
 661  */
 662 DALI_ADAPTOR_API MouseRelativeEventSignalType& MouseRelativeEventSignal(Window window);
 663
 664 /**
 665  * @brief This signal is emitted when window has been moved by the display server.
 666  * To make the window move by display server, RequestMoveToServer() should be called.
 667  * After the moving job is completed, this function will be called.
 668  *
 669  * A callback of the following type may be connected:
 670  * @code
 671  *   void YourCallbackName( Window window, Dali::Window::WindowPosition position );
 672  * @endcode
 673  * The parameters are the moved x and y coordinates.
 674  * and window means this signal was called from what window
 675  *
 676  * @param[in] window The window instance.
 677  * @return The signal to connect to
 678  */
 679 DALI_ADAPTOR_API MoveCompletedSignalType& MoveCompletedSignal(Window window);
 680
 681 /**
 682  * @brief This signal is emitted when window has been resized by the display server.
 683  * To make the window move by display server, RequestResizeToServer() should be called.
 684  * After the resizing job is completed, this function will be called.
 685  *
 686  * A callback of the following type may be connected:
 687  * @code
 688  *   void YourCallbackName( Window window, Dali::Window::WindowPosition position );
 689  * @endcode
 690  * The parameters are the resized width and height coordinates.
 691  * and window means this signal was called from what window
 692  *
 693  * @param[in] window The window instance.
 694  * @return The signal to connect to
 695  */
 696 DALI_ADAPTOR_API ResizeCompletedSignalType& ResizeCompletedSignal(Window window);
 697
 698 /**
 699  * @brief This signal is emitted when window insets are changed by appearing or disappearing indicator, virtual keyboard, or clipboard.
 700  *
 701  * @param[in] window The window instance
 702  * @return The signal to connect to
 703  */
 704 DALI_ADAPTOR_API InsetsChangedSignalType& InsetsChangedSignal(Window window);
 705
 706 } // namespace DevelWindow
 707
 708 } // namespace Dali
 709
 710 #endif // DALI_WINDOW_DEVEL_H