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