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

   1 #ifndef DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_IMPL_H
   2 #define DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_IMPL_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/public-api/actors/layer.h>
  23 #include <dali/public-api/adaptor-framework/window-enumerations.h>
  24 #include <dali/public-api/object/base-object.h>
  25 #include <dali/public-api/object/property-array.h>
  26 #include <dali/public-api/object/ref-object.h>
  27 #include <dali/public-api/render-tasks/render-task-list.h>
  28
  29 // INTERNAL INCLUDES
  30 #include <dali/devel-api/adaptor-framework/window-devel.h>
  31 #include <dali/integration-api/adaptor-framework/scene-holder-impl.h>
  32 #include <dali/internal/adaptor/common/adaptor-impl.h>
  33 #include <dali/internal/window-system/common/event-handler.h>
  34 #include <dali/public-api/adaptor-framework/key-grab.h>
  35 #include <dali/public-api/adaptor-framework/window.h>
  36
  37 namespace Dali
  38 {
  39 class Adaptor;
  40 class Actor;
  41 class RenderSurfaceInterface;
  42
  43 namespace Internal
  44 {
  45 namespace Adaptor
  46 {
  47 class Orientation;
  48 class WindowRenderSurface;
  49 class WindowBase;
  50
  51 class Window;
  52 using WindowPtr       = IntrusivePtr<Window>;
  53 using OrientationPtr  = IntrusivePtr<Orientation>;
  54 using EventHandlerPtr = IntrusivePtr<EventHandler>;
  55
  56 /**
  57  * Window provides a surface to render onto with orientation & indicator properties.
  58  */
  59 class Window : public Dali::Internal::Adaptor::SceneHolder, public EventHandler::Observer, public ConnectionTracker
  60 {
  61 public:
  62   typedef Dali::Window::FocusChangeSignalType                        FocusChangeSignalType;
  63   typedef Dali::Window::ResizeSignalType                             ResizeSignalType;
  64   typedef Dali::DevelWindow::VisibilityChangedSignalType             VisibilityChangedSignalType;
  65   typedef Dali::DevelWindow::TransitionEffectEventSignalType         TransitionEffectEventSignalType;
  66   typedef Dali::DevelWindow::KeyboardRepeatSettingsChangedSignalType KeyboardRepeatSettingsChangedSignalType;
  67   typedef Signal<void()>                                             SignalType;
  68
  69   /**
  70    * @brief Create a new Window. This should only be called once by the Application class
  71    * @param[in] positionSize The position and size of the window
  72    * @param[in] name The window title
  73    * @param[in] className The window class name
  74    * @param[in] isTransparent Whether window is transparent
  75    * @return A newly allocated Window
  76    */
  77   static Window* New(const PositionSize& positionSize, const std::string& name, const std::string& className, bool isTransparent = false);
  78
  79   /**
  80    * @brief Create a new Window. This should only be called once by the Application class
  81    * @param[in] surface The surface used to render on.
  82    * @param[in] positionSize The position and size of the window
  83    * @param[in] name The window title
  84    * @param[in] className The window class name
  85    * @param[in] isTransparent Whether window is transparent
  86    * @return A newly allocated Window
  87    */
  88   static Window* New(Any surface, const PositionSize& positionSize, const std::string& name, const std::string& className, bool isTransparent = false);
  89
  90   /**
  91    * @copydoc Dali::Window::SetClass()
  92    */
  93   void SetClass(std::string name, std::string className);
  94
  95   /**
  96    * @brief Gets the window class name.
  97    * @return The class of the window
  98    */
  99   std::string GetClassName() const;
 100
 101   /**
 102    * @copydoc Dali::Window::Raise()
 103    */
 104   void Raise();
 105
 106   /**
 107    * @copydoc Dali::Window::Lower()
 108    */
 109   void Lower();
 110
 111   /**
 112    * @copydoc Dali::Window::Activate()
 113    */
 114   void Activate();
 115
 116   /**
 117    * @copydoc Dali::Window::GetLayerCount()
 118    */
 119   uint32_t GetLayerCount() const;
 120
 121   /**
 122    * @copydoc Dali::Window::GetLayer()
 123    */
 124   Dali::Layer GetLayer(uint32_t depth) const;
 125
 126   /**
 127    * @copydoc Dali::DevelWindow::GetRenderTaskList()
 128    */
 129   Dali::RenderTaskList GetRenderTaskList() const;
 130
 131   /**
 132    * @copydoc Dali::Window::AddAvailableOrientation()
 133    */
 134   void AddAvailableOrientation(WindowOrientation orientation);
 135
 136   /**
 137    * @copydoc Dali::Window::RemoveAvailableOrientation()
 138    */
 139   void RemoveAvailableOrientation(WindowOrientation orientation);
 140
 141   /**
 142    * @copydoc Dali::Window::SetPreferredOrientation()
 143    */
 144   void SetPreferredOrientation(WindowOrientation orientation);
 145
 146   /**
 147    * @copydoc Dali::Window::GetPreferredOrientation()
 148    */
 149   WindowOrientation GetPreferredOrientation();
 150
 151   /**
 152    * @copydoc Dali::Window::SetAcceptFocus()
 153    */
 154   void SetAcceptFocus(bool accept);
 155
 156   /**
 157    * @copydoc Dali::Window::IsFocusAcceptable()
 158    */
 159   bool IsFocusAcceptable() const;
 160
 161   /**
 162    * @copydoc Dali::Window::Show()
 163    */
 164   void Show();
 165
 166   /**
 167    * @copydoc Dali::Window::Hide()
 168    */
 169   void Hide();
 170
 171   /**
 172    * @copydoc Dali::Window::GetSupportedAuxiliaryHintCount()
 173    */
 174   unsigned int GetSupportedAuxiliaryHintCount() const;
 175
 176   /**
 177    * @copydoc Dali::Window::GetSupportedAuxiliaryHint()
 178    */
 179   std::string GetSupportedAuxiliaryHint(unsigned int index) const;
 180
 181   /**
 182    * @copydoc Dali::Window::AddAuxiliaryHint()
 183    */
 184   unsigned int AddAuxiliaryHint(const std::string& hint, const std::string& value);
 185
 186   /**
 187    * @copydoc Dali::Window::RemoveAuxiliaryHint()
 188    */
 189   bool RemoveAuxiliaryHint(unsigned int id);
 190
 191   /**
 192    * @copydoc Dali::Window::SetAuxiliaryHintValue()
 193    */
 194   bool SetAuxiliaryHintValue(unsigned int id, const std::string& value);
 195
 196   /**
 197    * @copydoc Dali::Window::GetAuxiliaryHintValue()
 198    */
 199   std::string GetAuxiliaryHintValue(unsigned int id) const;
 200
 201   /**
 202    * @copydoc Dali::Window::GetAuxiliaryHintId()
 203    */
 204   unsigned int GetAuxiliaryHintId(const std::string& hint) const;
 205
 206   /**
 207    * @copydoc Dali::Window::SetInputRegion()
 208    */
 209   void SetInputRegion(const Rect<int>& inputRegion);
 210
 211   /**
 212    * @copydoc Dali::Window::SetType()
 213    */
 214   void SetType(WindowType type);
 215
 216   /**
 217    * @copydoc Dali::Window::GetType() const
 218    */
 219   WindowType GetType() const;
 220
 221   /**
 222    * @copydoc Dali::Window::SetNotificationLevel()
 223    */
 224   bool SetNotificationLevel(WindowNotificationLevel level);
 225
 226   /**
 227    * @copydoc Dali::Window::GetNotificationLevel()
 228    */
 229   WindowNotificationLevel GetNotificationLevel() const;
 230
 231   /**
 232    * @copydoc Dali::Window::SetOpaqueState()
 233    */
 234   void SetOpaqueState(bool opaque);
 235
 236   /**
 237    * @copydoc Dali::Window::IsOpaqueState()
 238    */
 239   bool IsOpaqueState() const;
 240
 241   /**
 242    * @copydoc Dali::Window::SetScreenOffMode()
 243    */
 244   bool SetScreenOffMode(WindowScreenOffMode screenOffMode);
 245
 246   /**
 247    * @copydoc Dali::Window::GetScreenOffMode()
 248    */
 249   WindowScreenOffMode GetScreenOffMode() const;
 250
 251   /**
 252    * @copydoc Dali::Window::SetBrightness()
 253    */
 254   bool SetBrightness(int brightness);
 255
 256   /**
 257    * @copydoc Dali::Window::GetBrightness()
 258    */
 259   int GetBrightness() const;
 260
 261   /**
 262    * @copydoc Dali::Window::SetSize()
 263    */
 264   void SetSize(Dali::Window::WindowSize size);
 265
 266   /**
 267    * @copydoc Dali::Window::GetSize()
 268    */
 269   Dali::Window::WindowSize GetSize() const;
 270
 271   /**
 272    * @copydoc Dali::Window::SetPosition()
 273    */
 274   void SetPosition(Dali::Window::WindowPosition position);
 275
 276   /**
 277    * @copydoc Dali::Window::GetPosition()
 278    */
 279   Dali::Window::WindowPosition GetPosition() const;
 280
 281   /**
 282    * @copydoc Dali::DevelWindow::SetPositionSize()
 283    */
 284   void SetPositionSize(PositionSize positionSize);
 285
 286   /**
 287    * @copydoc Dali::Window::GetRootLayer()
 288    */
 289   Dali::Layer GetRootLayer() const;
 290
 291   /**
 292    * @copydoc Dali::Window::SetTransparency()
 293    */
 294   void SetTransparency(bool transparent);
 295
 296   /**
 297    * @copydoc Dali::KeyGrab::GrabKey()
 298    */
 299   bool GrabKey(Dali::KEY key, KeyGrab::KeyGrabMode grabMode);
 300
 301   /**
 302    * @copydoc Dali::KeyGrab::UngrabKey()
 303    */
 304   bool UngrabKey(Dali::KEY key);
 305
 306   /**
 307    * @copydoc Dali::KeyGrab::GrabKeyList()
 308    */
 309   bool GrabKeyList(const Dali::Vector<Dali::KEY>& key, const Dali::Vector<KeyGrab::KeyGrabMode>& grabMode, Dali::Vector<bool>& result);
 310
 311   /**
 312    * @copydoc Dali::KeyGrab::UngrabKeyList()
 313    */
 314   bool UngrabKeyList(const Dali::Vector<Dali::KEY>& key, Dali::Vector<bool>& result);
 315
 316   /**
 317    * @copydoc Dali::DevelWindow::Get()
 318    */
 319   static Dali::Window Get(Dali::Actor actor);
 320
 321   /**
 322    * @copydoc Dali::DevelWindow::SetParent()
 323    */
 324   void SetParent(Dali::Window& parent);
 325
 326   /**
 327    * @copydoc Dali::DevelWindow::Unparent()
 328    */
 329   void Unparent();
 330
 331   /**
 332    * @copydoc Dali::DevelWindow::GetParent()
 333    */
 334   Dali::Window GetParent();
 335
 336   /**
 337    * @copydoc Dali::DevelWindow::GetCurrentOrientation()
 338    */
 339   WindowOrientation GetCurrentOrientation() const;
 340
 341   /**
 342    * @copydoc Dali::DevelWindow::SetAvailableOrientations()
 343    */
 344   void SetAvailableOrientations(const Dali::Vector<WindowOrientation>& orientations);
 345
 346 public: // Dali::Internal::Adaptor::SceneHolder
 347   /**
 348    * @copydoc Dali::Internal::Adaptor::SceneHolder::GetNativeHandle
 349    */
 350   Dali::Any GetNativeHandle() const override;
 351
 352   /**
 353    * @copydoc Dali::Internal::Adaptor::SceneHolder::IsVisible
 354    */
 355   bool IsVisible() const override;
 356
 357   /**
 358    * @copydoc Dali::DevelWindow::GetNativeId()
 359    */
 360   int32_t GetNativeId() const;
 361
 362 private:
 363   /**
 364    * @brief Enumeration for orietation mode.
 365    * The Orientation Mode is related to screen size.
 366    * If screen width is longer than height, the Orientation Mode will have LANDSCAPE.
 367    * Otherwise screen width is shorter than height or same, the Orientation Mode will have PORTRAIT.
 368    */
 369   enum class OrientationMode
 370   {
 371     PORTRAIT = 0,
 372     LANDSCAPE
 373   };
 374
 375   /**
 376    * Private constructor.
 377    * @sa Window::New()
 378    */
 379   Window();
 380
 381   /**
 382    * Destructor
 383    */
 384   ~Window() override;
 385
 386   /**
 387    * Second stage initialization
 388    */
 389   void Initialize(Any surface, const PositionSize& positionSize, const std::string& name, const std::string& className);
 390
 391   /**
 392    * Called when the window becomes iconified or deiconified.
 393    */
 394   void OnIconifyChanged(bool iconified);
 395
 396   /**
 397    * Called when the window focus is changed.
 398    */
 399   void OnFocusChanged(bool focusIn);
 400
 401   /**
 402    * Called when the output is transformed.
 403    */
 404   void OnOutputTransformed();
 405
 406   /**
 407    * Called when the window receives a delete request.
 408    */
 409   void OnDeleteRequest();
 410
 411   /**
 412    * Called when the window receives a Transition effect-start/end event.
 413    */
 414   void OnTransitionEffectEvent(WindowEffectState state, WindowEffectType type);
 415
 416   /**
 417    * @brief Called when window receives a keyboard repeat event.
 418    */
 419   void OnKeyboardRepeatSettingsChanged();
 420
 421   /**
 422    * @brief Called when the window redraw is requested.
 423    */
 424   void OnWindowRedrawRequest();
 425
 426   /**
 427    * @brief Set available orientation to window base.
 428    */
 429   void SetAvailableAnlges(const std::vector<int>& angles);
 430
 431   /**
 432    * @brief Convert from window orientation to angle using OrientationMode.
 433    */
 434   int ConvertToAngle(WindowOrientation orientation);
 435
 436   /**
 437    * @brief Convert from angle to window orientation using OrientationMode.
 438    */
 439   WindowOrientation ConvertToOrientation(int angle) const;
 440
 441   /**
 442    * @brief Check available window orientation for Available orientation.
 443    */
 444   bool IsOrientationAvailable(WindowOrientation orientation) const;
 445
 446 private: // Dali::Internal::Adaptor::SceneHolder
 447   /**
 448    * @copydoc Dali::Internal::Adaptor::SceneHolder::OnAdaptorSet
 449    */
 450   void OnAdaptorSet(Dali::Adaptor& adaptor) override;
 451
 452   /**
 453    * @copydoc Dali::Internal::Adaptor::SceneHolder::OnSurfaceSet
 454    */
 455   void OnSurfaceSet(Dali::RenderSurfaceInterface* surface) override;
 456
 457   /**
 458    * @copydoc Dali::Internal::Adaptor::SceneHolder::OnPause
 459    */
 460   void OnPause() override;
 461
 462   /**
 463    * @copydoc Dali::Internal::Adaptor::SceneHolder::OnResume
 464    */
 465   void OnResume() override;
 466
 467   /**
 468    * @copydoc Dali::Internal::Adaptor::SceneHolder::RecalculateTouchPosition
 469    */
 470   void RecalculateTouchPosition(Integration::Point& point) override;
 471
 472 private: // Dali::Internal::Adaptor::EventHandler::Observer
 473   /**
 474    * @copydoc Dali::Internal::Adaptor::EventHandler::Observer::OnTouchPoint
 475    */
 476   void OnTouchPoint(Dali::Integration::Point& point, int timeStamp) override;
 477
 478   /**
 479    * @copydoc Dali::Internal::Adaptor::EventHandler::Observer::OnWheelEvent
 480    */
 481   void OnWheelEvent(Dali::Integration::WheelEvent& wheelEvent) override;
 482
 483   /**
 484    * @copydoc Dali::Internal::Adaptor::EventHandler::Observer::OnKeyEvent
 485    */
 486   void OnKeyEvent(Dali::Integration::KeyEvent& keyEvent) override;
 487
 488   /**
 489    * @copydoc Dali::Internal::Adaptor::EventHandler::Observer::OnRotation
 490    */
 491   void OnRotation(const RotationEvent& rotation) override;
 492
 493 public: // Signals
 494   /**
 495    * @copydoc Dali::Window::FocusChangeSignal()
 496    */
 497   FocusChangeSignalType& FocusChangeSignal()
 498   {
 499     return mFocusChangeSignal;
 500   }
 501
 502   /**
 503    * @copydoc Dali::Window::ResizedSignal()
 504    */
 505   ResizeSignalType& ResizeSignal()
 506   {
 507     return mResizeSignal;
 508   }
 509
 510   /**
 511    * This signal is emitted when the window is requesting to be deleted
 512    */
 513   SignalType& DeleteRequestSignal()
 514   {
 515     return mDeleteRequestSignal;
 516   }
 517
 518   /**
 519    * @copydoc Dali::DevelWindow::VisibilityChangedSignal()
 520    */
 521   VisibilityChangedSignalType& VisibilityChangedSignal()
 522   {
 523     return mVisibilityChangedSignal;
 524   }
 525
 526   /**
 527    * @copydoc Dali::Window::SignalEventProcessingFinished()
 528    */
 529   Dali::DevelWindow::EventProcessingFinishedSignalType& EventProcessingFinishedSignal()
 530   {
 531     return mScene.EventProcessingFinishedSignal();
 532   }
 533
 534   /**
 535    * @copydoc Dali::DevelWindow::TransitionEffectEventSignal()
 536    */
 537   TransitionEffectEventSignalType& TransitionEffectEventSignal()
 538   {
 539     return mTransitionEffectEventSignal;
 540   }
 541
 542   /**
 543    * @copydoc Dali::DevelWindow::KeyboardRepeatSettingsChangedSignal()
 544    */
 545   KeyboardRepeatSettingsChangedSignalType& KeyboardRepeatSettingsChangedSignal()
 546   {
 547     return mKeyboardRepeatSettingsChangedSignal;
 548   }
 549
 550 private:
 551   WindowRenderSurface* mWindowSurface; ///< The window rendering surface
 552   WindowBase*          mWindowBase;
 553   std::string          mName;
 554   std::string          mClassName;
 555   bool                 mIsTransparent : 1;
 556   bool                 mIsFocusAcceptable : 1;
 557   bool                 mIconified : 1;
 558   bool                 mOpaqueState : 1;
 559   bool                 mResizeEnabled : 1;
 560   WindowType           mType;
 561   Dali::Window         mParentWindow;
 562
 563   OrientationPtr   mOrientation;
 564   std::vector<int> mAvailableAngles;
 565   int              mPreferredAngle;
 566
 567   int mRotationAngle; ///< The angle of the rotation
 568   int mWindowWidth;   ///< The width of the window
 569   int mWindowHeight;  ///< The height of the window
 570
 571   EventHandlerPtr mEventHandler; ///< The window events handler
 572
 573   OrientationMode mOrientationMode;
 574
 575   int mNativeWindowId; ///< The Native Window Id
 576
 577   // Signals
 578   SignalType                              mDeleteRequestSignal;
 579   FocusChangeSignalType                   mFocusChangeSignal;
 580   ResizeSignalType                        mResizeSignal;
 581   VisibilityChangedSignalType             mVisibilityChangedSignal;
 582   TransitionEffectEventSignalType         mTransitionEffectEventSignal;
 583   KeyboardRepeatSettingsChangedSignalType mKeyboardRepeatSettingsChangedSignal;
 584 };
 585
 586 } // namespace Adaptor
 587 } // namespace Internal
 588
 589 // Helpers for public-api forwarding methods
 590
 591 inline Internal::Adaptor::Window& GetImplementation(Dali::Window& window)
 592 {
 593   DALI_ASSERT_ALWAYS(window && "Window handle is empty");
 594   BaseObject& object = window.GetBaseObject();
 595   return static_cast<Internal::Adaptor::Window&>(object);
 596 }
 597
 598 inline const Internal::Adaptor::Window& GetImplementation(const Dali::Window& window)
 599 {
 600   DALI_ASSERT_ALWAYS(window && "Window handle is empty");
 601   const BaseObject& object = window.GetBaseObject();
 602   return static_cast<const Internal::Adaptor::Window&>(object);
 603 }
 604
 605 } // namespace Dali
 606
 607 #endif // DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_IMPL_H