dali/internal/window-system/common/window-base.h

   1 #ifndef DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_BASE_H
   2 #define DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_BASE_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 <dali/integration-api/events/key-event-integ.h>
  23 #include <dali/integration-api/events/point.h>
  24 #include <dali/integration-api/events/wheel-event-integ.h>
  25 #include <cstdint>
  26 #include <string>
  27 #include <vector>
  28
  29 // INTERNAL INCLUDES
  30 #include <dali/devel-api/adaptor-framework/mouse-in-out-event.h>
  31 #include <dali/devel-api/adaptor-framework/window-devel.h>
  32 #include <dali/internal/graphics/gles/egl-implementation.h>
  33 #include <dali/internal/window-system/common/damage-observer.h>
  34 #include <dali/internal/window-system/common/rotation-event.h>
  35 #include <dali/public-api/adaptor-framework/key-grab.h>
  36 #include <dali/public-api/adaptor-framework/style-change.h>
  37 #include <dali/public-api/adaptor-framework/window-enumerations.h>
  38 #include <dali/public-api/adaptor-framework/window.h>
  39
  40 namespace Dali
  41 {
  42 namespace Internal
  43 {
  44 namespace Adaptor
  45 {
  46 /**
  47  * WindowBase interface
  48  */
  49 class WindowBase
  50 {
  51 public:
  52   /**
  53    * @brief Struct used to retrieve accessibility information
  54    */
  55   struct AccessibilityInfo
  56   {
  57     int gestureValue;
  58     int startX;
  59     int startY;
  60     int endX;
  61     int endY;
  62     int state;
  63     int eventTime;
  64   };
  65
  66   // Window
  67   typedef Signal<void(bool)>                                                           IconifySignalType;
  68   typedef Signal<void(bool)>                                                           FocusSignalType;
  69   typedef Signal<void()>                                                               OutputSignalType;
  70   typedef Signal<void()>                                                               DeleteSignalType;
  71   typedef Signal<void(const DamageArea&)>                                              DamageSignalType;
  72   typedef Signal<void(const RotationEvent&)>                                           RotationSignalType;
  73   typedef Signal<void(WindowEffectState, WindowEffectType)>                            TransitionEffectEventSignalType;
  74   typedef Signal<void()>                                                               KeyboardRepeatSettingsChangedSignalType;
  75   typedef Signal<void()>                                                               WindowRedrawRequestSignalType;
  76   typedef Signal<void(Dali::PositionSize&)>                                            UpdatePositionSizeType;
  77   typedef Signal<void(const std::string&, const std::string&, const Property::Array&)> AuxiliaryMessageSignalType;
  78   typedef Signal<void(const Dali::DevelWindow::MouseInOutEvent&)>                      MouseInOutEventSignalType;
  79   typedef Signal<void(Dali::Int32Pair&)>                                               MoveCompletedSignalType;
  80   typedef Signal<void(Dali::Uint16Pair&)>                                              ResizeCompletedSignalType;
  81   typedef Signal<void(WindowInsetsPartType, WindowInsetsPartState, const Extents&)>    InsetsChangedSignalType;
  82
  83   // Input events
  84   typedef Signal<void(Integration::Point&, uint32_t)> TouchEventSignalType;
  85   typedef Signal<void(Integration::WheelEvent&)>      WheelEventSignalType;
  86   typedef Signal<void(Integration::KeyEvent&)>        KeyEventSignalType;
  87
  88   // Clipboard
  89   typedef Signal<void(void*)> SelectionSignalType;
  90
  91   // Accessibility
  92   typedef Signal<void(StyleChange::Type)> StyleSignalType;
  93
  94   /**
  95    * @brief Default constructor
  96    */
  97   WindowBase();
  98
  99   /**
 100    * @brief Destructor
 101    */
 102   virtual ~WindowBase();
 103
 104 public:
 105   /**
 106    * @brief Get the native window handle
 107    * @return The native window handle
 108    */
 109   virtual Any GetNativeWindow() = 0;
 110
 111   /**
 112    * @brief Get the native window id
 113    * @return The native window id
 114    */
 115   virtual int GetNativeWindowId() = 0;
 116
 117   /**
 118    * @brief Get the native window resource id assinged by window manager
 119    * @return The native window resource id
 120    */
 121   virtual std::string GetNativeWindowResourceId() = 0;
 122
 123   /**
 124    * @brief Create the egl window
 125    */
 126   virtual EGLNativeWindowType CreateEglWindow(int width, int height) = 0;
 127
 128   /**
 129    * @brief Destroy the egl window
 130    */
 131   virtual void DestroyEglWindow() = 0;
 132
 133   /**
 134    * @brief Set the egl window rotation
 135    */
 136   virtual void SetEglWindowRotation(int angle) = 0;
 137
 138   /**
 139    * @brief Set the egl window buffer transform
 140    */
 141   virtual void SetEglWindowBufferTransform(int angle) = 0;
 142
 143   /**
 144    * @brief Set the egl window transform
 145    */
 146   virtual void SetEglWindowTransform(int angle) = 0;
 147
 148   /**
 149    * @brief Resize the egl window
 150    */
 151   virtual void ResizeEglWindow(Dali::PositionSize positionSize) = 0;
 152
 153   /**
 154    * @brief Returns whether the egl window support rotation or not
 155    */
 156   virtual bool IsEglWindowRotationSupported() = 0;
 157
 158   /**
 159    * @brief Move the window
 160    */
 161   virtual void Move(Dali::PositionSize positionSize) = 0;
 162
 163   /**
 164    * @brief Resize the window
 165    */
 166   virtual void Resize(Dali::PositionSize positionSize) = 0;
 167
 168   /**
 169    * @brief Move and resize the window
 170    */
 171   virtual void MoveResize(Dali::PositionSize positionSize) = 0;
 172
 173   /**
 174    * @copydoc Dali::Window::SetLayout()
 175    */
 176   virtual void SetLayout(unsigned int numCols, unsigned int numRows, unsigned int column, unsigned int row, unsigned int colSpan, unsigned int rowSpan) = 0;
 177
 178   /**
 179    * @copydoc Dali::Window::SetClass()
 180    */
 181   virtual void SetClass(const std::string& name, const std::string& className) = 0;
 182
 183   /**
 184    * @copydoc Dali::Window::Raise()
 185    */
 186   virtual void Raise() = 0;
 187
 188   /**
 189    * @copydoc Dali::Window::Lower()
 190    */
 191   virtual void Lower() = 0;
 192
 193   /**
 194    * @copydoc Dali::Window::Activate()
 195    */
 196   virtual void Activate() = 0;
 197
 198   /**
 199    * @copydoc Dali::DevelWindow::Maximize()
 200    */
 201   virtual void Maximize(bool maximize) = 0;
 202
 203   /**
 204    * @copydoc Dali::DevelWindow::IsMaximized()
 205    */
 206   virtual bool IsMaximized() const = 0;
 207
 208   /**
 209    * @copydoc Dali::DevelWindow::SetMaximumSize()
 210    */
 211   virtual void SetMaximumSize(Dali::Window::WindowSize size) = 0;
 212
 213   /**
 214    * @copydoc Dali::DevelWindow::Minimize()
 215    */
 216   virtual void Minimize(bool minimize) = 0;
 217
 218   /**
 219    * @copydoc Dali::DevelWindow::IsMinimized()
 220    */
 221   virtual bool IsMinimized() const = 0;
 222
 223   /**
 224    * @copydoc Dali::DevelWindow::SetMimimumSize()
 225    */
 226   virtual void SetMimimumSize(Dali::Window::WindowSize size) = 0;
 227
 228   /**
 229    * @copydoc Dali::Window::SetAvailableOrientations()
 230    */
 231   virtual void SetAvailableAnlges(const std::vector<int>& angles) = 0;
 232
 233   /**
 234    * @copydoc Dali::Window::SetPreferredOrientation()
 235    */
 236   virtual void SetPreferredAngle(int angle) = 0;
 237
 238   /**
 239    * @copydoc Dali::Window::SetAcceptFocus()
 240    */
 241   virtual void SetAcceptFocus(bool accept) = 0;
 242
 243   /**
 244    * @copydoc Dali::Window::Show()
 245    */
 246   virtual void Show() = 0;
 247
 248   /**
 249    * @copydoc Dali::Window::Hide()
 250    */
 251   virtual void Hide() = 0;
 252
 253   /**
 254    * @copydoc Dali::Window::GetSupportedAuxiliaryHintCount()
 255    */
 256   virtual unsigned int GetSupportedAuxiliaryHintCount() const = 0;
 257
 258   /**
 259    * @copydoc Dali::Window::GetSupportedAuxiliaryHint()
 260    */
 261   virtual std::string GetSupportedAuxiliaryHint(unsigned int index) const = 0;
 262
 263   /**
 264    * @copydoc Dali::Window::AddAuxiliaryHint()
 265    */
 266   virtual unsigned int AddAuxiliaryHint(const std::string& hint, const std::string& value) = 0;
 267
 268   /**
 269    * @copydoc Dali::Window::RemoveAuxiliaryHint()
 270    */
 271   virtual bool RemoveAuxiliaryHint(unsigned int id) = 0;
 272
 273   /**
 274    * @copydoc Dali::Window::SetAuxiliaryHintValue()
 275    */
 276   virtual bool SetAuxiliaryHintValue(unsigned int id, const std::string& value) = 0;
 277
 278   /**
 279    * @copydoc Dali::Window::GetAuxiliaryHintValue()
 280    */
 281   virtual std::string GetAuxiliaryHintValue(unsigned int id) const = 0;
 282
 283   /**
 284    * @copydoc Dali::Window::GetAuxiliaryHintId()
 285    */
 286   virtual unsigned int GetAuxiliaryHintId(const std::string& hint) const = 0;
 287
 288   /**
 289    * @copydoc Dali::Window::SetInputRegion()
 290    */
 291   virtual void SetInputRegion(const Rect<int>& inputRegion) = 0;
 292
 293   /**
 294    * @copydoc Dali::Window::SetType()
 295    */
 296   virtual void SetType(Dali::WindowType type) = 0;
 297
 298   /**
 299    * @copydoc Dali::Window::GetType()
 300    */
 301   virtual Dali::WindowType GetType() const = 0;
 302
 303   /**
 304    * @copydoc Dali::Window::SetNotificationLevel()
 305    */
 306   virtual Dali::WindowOperationResult SetNotificationLevel(Dali::WindowNotificationLevel level) = 0;
 307
 308   /**
 309    * @copydoc Dali::Window::GetNotificationLevel()
 310    */
 311   virtual Dali::WindowNotificationLevel GetNotificationLevel() const = 0;
 312
 313   /**
 314    * @copydoc Dali::Window::SetOpaqueState()
 315    */
 316   virtual void SetOpaqueState(bool opaque) = 0;
 317
 318   /**
 319    * @copydoc Dali::Window::SetScreenOffMode()
 320    */
 321   virtual Dali::WindowOperationResult SetScreenOffMode(WindowScreenOffMode screenOffMode) = 0;
 322
 323   /**
 324    * @copydoc Dali::Window::GetScreenOffMode()
 325    */
 326   virtual WindowScreenOffMode GetScreenOffMode() const = 0;
 327
 328   /**
 329    * @copydoc Dali::Window::SetBrightness()
 330    */
 331   virtual Dali::WindowOperationResult SetBrightness(int brightness) = 0;
 332
 333   /**
 334    * @copydoc Dali::Window::GetBrightness()
 335    */
 336   virtual int GetBrightness() const = 0;
 337
 338   /**
 339    * @copydoc Dali::KeyGrab::GrabKey()
 340    */
 341   virtual bool GrabKey(Dali::KEY key, KeyGrab::KeyGrabMode grabMode) = 0;
 342
 343   /**
 344    * @copydoc Dali::KeyGrab::UngrabKey()
 345    */
 346   virtual bool UngrabKey(Dali::KEY key) = 0;
 347
 348   /**
 349    * @copydoc Dali::KeyGrab::GrabKeyList()
 350    */
 351   virtual bool GrabKeyList(const Dali::Vector<Dali::KEY>& key, const Dali::Vector<KeyGrab::KeyGrabMode>& grabMode, Dali::Vector<bool>& result) = 0;
 352
 353   /**
 354    * @copydoc Dali::KeyGrab::UngrabKeyList()
 355    */
 356   virtual bool UngrabKeyList(const Dali::Vector<Dali::KEY>& key, Dali::Vector<bool>& result) = 0;
 357
 358   /**
 359    * @brief Get DPI
 360    * @param[out] dpiHorizontal set to the horizontal dpi
 361    * @param[out] dpiVertical set to the vertical dpi
 362    */
 363   virtual void GetDpi(unsigned int& dpiHorizontal, unsigned int& dpiVertical) = 0;
 364
 365   /**
 366    * @brief Return the angle of the window's rotation.
 367    * @return The window orientation
 368    */
 369   virtual int GetWindowRotationAngle() const = 0;
 370
 371   /**
 372    * @brief Get the angle of screen rotation for the window
 373    * @return The screen orientation
 374    */
 375   virtual int GetScreenRotationAngle() = 0;
 376
 377   /**
 378    * @brief Set the screen rotation angle of the window
 379    */
 380   virtual void SetWindowRotationAngle(int degree) = 0;
 381
 382   /**
 383    * @brief Inform the window rotation is completed
 384    */
 385   virtual void WindowRotationCompleted(int degree, int width, int height) = 0;
 386
 387   /**
 388    * @brief starts the window is moved by display server
 389    */
 390   virtual void RequestMoveToServer() = 0;
 391
 392   /**
 393    * @brief starts the window is resized by display server
 394    *
 395    * @param[in] direction It is direction of the started edge/side.
 396    */
 397   virtual void RequestResizeToServer(WindowResizeDirection direction) = 0;
 398
 399   /**
 400    * @brief Enables the floating mode of window.
 401    *
 402    * The floating mode is to support making partial size window easliy.
 403    * It is useful to make popup style window
 404    * and this window is always upper than the other normal window.
 405    *
 406    * A special display server(as a Tizen display server) supports this mode.
 407    *
 408    * @param[in] enable Enable floating mode or not.
 409    */
 410   virtual void EnableFloatingMode(bool enable) = 0;
 411
 412   /**
 413    * @brief Gets whether floating mode is enabled or not.
 414    */
 415   virtual bool IsFloatingModeEnabled() const = 0;
 416
 417   /**
 418    * @copydoc Dali::Window::SetTransparency()
 419    */
 420   virtual void SetTransparency(bool transparent) = 0;
 421
 422   /**
 423    * @copydoc Dali::Window::SetParent()
 424    */
 425   virtual void SetParent(WindowBase* parentWinBase, bool belowParent) = 0;
 426
 427   /**
 428    * @brief Create a sync fence that can tell the frame is rendered by the graphics driver.
 429    * @return The file descriptor that tells when it is rendered.
 430    */
 431   virtual int CreateFrameRenderedSyncFence() = 0;
 432
 433   /**
 434    * @brief Create a sync fence that can tell the frame is presented by the display server.
 435    * @return The file descriptor that tells when it is presented.
 436    */
 437   virtual int CreateFramePresentedSyncFence() = 0;
 438
 439   /**
 440    * @copydoc Dali::Window::SetPositionSizeWithAngle()
 441    */
 442   virtual void SetPositionSizeWithAngle(PositionSize positionSize, int angle) = 0;
 443
 444   /**
 445    * @brief Initialize for Ime window.
 446    * It should be called when the window is only used for Ime keyboard window.
 447    */
 448   virtual void InitializeIme() = 0;
 449
 450   /**
 451    * @brief Send the signal to display server for Ime Window is ready to render.
 452    * It is used for compositing by display server.
 453    */
 454   virtual void ImeWindowReadyToRender() = 0;
 455
 456   /**
 457    * @brief Includes input region.
 458    * @param[in] inputRegion The added region to accept input events.
 459    */
 460   virtual void IncludeInputRegion(const Rect<int>& inputRegion) = 0;
 461
 462   /**
 463    * @brief Excludes input region.
 464    * @param[in] inputRegion The subtracted region to except input events.
 465    */
 466   virtual void ExcludeInputRegion(const Rect<int>& inputRegion) = 0;
 467
 468   // Signals
 469
 470   /**
 471    * @brief This signal is emitted when the window becomes iconified or deiconified.
 472    */
 473   IconifySignalType& IconifyChangedSignal();
 474
 475   /**
 476    * @brief This signal is emitted when the window focus is changed.
 477    */
 478   FocusSignalType& FocusChangedSignal();
 479
 480   /**
 481    * @brief This signal is emitted when the output is transformed.
 482    */
 483   OutputSignalType& OutputTransformedSignal();
 484
 485   /**
 486    * @brief This signal is emitted when the window receives a delete request.
 487    */
 488   DeleteSignalType& DeleteRequestSignal();
 489
 490   /**
 491    * @brief This signal is emitted when the window is damaged.
 492    */
 493   DamageSignalType& WindowDamagedSignal();
 494
 495   /**
 496    * @brief This signal is emitted when a rotation event is recevied.
 497    */
 498   RotationSignalType& RotationSignal();
 499
 500   /**
 501    * @brief This signal is emitted when a touch event is received.
 502    */
 503   TouchEventSignalType& TouchEventSignal();
 504
 505   /**
 506    * @brief This signal is emitted when a mouse wheel is received.
 507    */
 508   WheelEventSignalType& WheelEventSignal();
 509
 510   /**
 511    * @brief This signal is emitted when a key event is received.
 512    */
 513   KeyEventSignalType& KeyEventSignal();
 514
 515   /**
 516    * @brief This signal is emitted when the source window notifies us the content in clipboard is selected.
 517    */
 518   SelectionSignalType& SelectionDataSendSignal();
 519
 520   /**
 521    * @brief This signal is emitted when the source window sends us about the selected content.
 522    */
 523   SelectionSignalType& SelectionDataReceivedSignal();
 524
 525   /**
 526    * @brief This signal is emitted when the style is changed.
 527    */
 528   StyleSignalType& StyleChangedSignal();
 529
 530   /**
 531    * @brief This signal is emitted when window's transition animation is started or ended.
 532    */
 533   TransitionEffectEventSignalType& TransitionEffectEventSignal();
 534
 535   /**
 536    * @brief This signal is emitted when the keyboard repeat is changed.
 537    */
 538   KeyboardRepeatSettingsChangedSignalType& KeyboardRepeatSettingsChangedSignal();
 539
 540   /**
 541    * @brief This signal is emitted when the window redraw is requested.
 542    */
 543   WindowRedrawRequestSignalType& WindowRedrawRequestSignal();
 544
 545   /**
 546    * @brief This signal is emitted when the window's geometry data is changed by display server or client.
 547    * It is based on configure noification event.
 548    */
 549   UpdatePositionSizeType& UpdatePositionSizeSignal();
 550
 551   /**
 552    * @brief This signal is emitted when the window is received the auxiliary message from display server.
 553    */
 554   AuxiliaryMessageSignalType& AuxiliaryMessageSignal();
 555
 556   /**
 557    * @brief This signal is emitted when a mouse in or out event is recevied.
 558    */
 559   MouseInOutEventSignalType& MouseInOutEventSignal();
 560
 561   /**
 562    * @brief This signal is emitted when window has been moved by then display server.
 563    * To be moved the window by display server, RequestMoveToServer() should be called.
 564    * After the moving job is finished, this function will be called.
 565    */
 566   MoveCompletedSignalType& MoveCompletedSignal();
 567
 568   /**
 569    * @brief This signal is emitted when window has been resized by then display server.
 570    * To be resized the window by display server, RequestResizeToServer() should be called.
 571    * After the resizing job is finished, this function will be called.
 572    */
 573   ResizeCompletedSignalType& ResizeCompletedSignal();
 574
 575   /**
 576    * @brief This signal is emitted when window insets are changed by appearing or disappearing indicator, virtual keyboard, or clipboard.
 577    */
 578   InsetsChangedSignalType& InsetsChangedSignal();
 579
 580 protected:
 581   // Undefined
 582   WindowBase(const WindowBase&) = delete;
 583
 584   // Undefined
 585   WindowBase& operator=(const WindowBase& rhs) = delete;
 586
 587 protected:
 588   IconifySignalType                       mIconifyChangedSignal;
 589   FocusSignalType                         mFocusChangedSignal;
 590   OutputSignalType                        mOutputTransformedSignal;
 591   DeleteSignalType                        mDeleteRequestSignal;
 592   DamageSignalType                        mWindowDamagedSignal;
 593   RotationSignalType                      mRotationSignal;
 594   TouchEventSignalType                    mTouchEventSignal;
 595   WheelEventSignalType                    mWheelEventSignal;
 596   KeyEventSignalType                      mKeyEventSignal;
 597   SelectionSignalType                     mSelectionDataSendSignal;
 598   SelectionSignalType                     mSelectionDataReceivedSignal;
 599   StyleSignalType                         mStyleChangedSignal;
 600   TransitionEffectEventSignalType         mTransitionEffectEventSignal;
 601   KeyboardRepeatSettingsChangedSignalType mKeyboardRepeatSettingsChangedSignal;
 602   WindowRedrawRequestSignalType           mWindowRedrawRequestSignal;
 603   UpdatePositionSizeType                  mUpdatePositionSizeSignal;
 604   AuxiliaryMessageSignalType              mAuxiliaryMessageSignal;
 605   MouseInOutEventSignalType               mMouseInOutEventSignal;
 606   MoveCompletedSignalType                 mMoveCompletedSignal;
 607   ResizeCompletedSignalType               mResizeCompletedSignal;
 608   InsetsChangedSignalType                 mInsetsChangedSignal;
 609 };
 610
 611 } // namespace Adaptor
 612
 613 } // namespace Internal
 614
 615 } // namespace Dali
 616
 617 #endif // DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_BASE_H