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