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) 2020 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/object/ref-object.h>
  23 #include <dali/public-api/object/base-object.h>
  24 #include <dali/public-api/actors/layer.h>
  25 #include <dali/public-api/render-tasks/render-task-list.h>
  26 #include <dali/public-api/object/property-array.h>
  27
  28 // INTERNAL INCLUDES
  29 #include <dali/public-api/adaptor-framework/window.h>
  30 #include <dali/public-api/adaptor-framework/key-grab.h>
  31 #include <dali/devel-api/adaptor-framework/window-devel.h>
  32 #include <dali/integration-api/adaptor-framework/scene-holder-impl.h>
  33 #include <dali/internal/adaptor/common/adaptor-impl.h>
  34 #include <dali/internal/window-system/common/event-handler.h>
  35
  36 namespace Dali
  37 {
  38 class Adaptor;
  39 class Actor;
  40 class RenderSurfaceInterface;
  41
  42 namespace Internal
  43 {
  44 namespace Adaptor
  45 {
  46 class Orientation;
  47 class WindowRenderSurface;
  48 class WindowBase;
  49
  50 class Window;
  51 using WindowPtr = IntrusivePtr< Window >;
  52 using OrientationPtr = IntrusivePtr< Orientation >;
  53 using EventHandlerPtr = IntrusivePtr< EventHandler >;
  54
  55 /**
  56  * Window provides a surface to render onto with orientation & indicator properties.
  57  */
  58 class Window : public Dali::Internal::Adaptor::SceneHolder, public EventHandler::Observer, public ConnectionTracker
  59 {
  60 public:
  61   typedef Dali::Window::ResizedSignalType ResizedSignalType;
  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(Dali::Window::WindowOrientation orientation);
 135
 136   /**
 137    * @copydoc Dali::Window::RemoveAvailableOrientation()
 138    */
 139   void RemoveAvailableOrientation(Dali::Window::WindowOrientation orientation);
 140
 141   /**
 142    * @copydoc Dali::Window::SetPreferredOrientation()
 143    */
 144   void SetPreferredOrientation(Dali::Window::WindowOrientation orientation);
 145
 146   /**
 147    * @copydoc Dali::Window::GetPreferredOrientation()
 148    */
 149   Dali::Window::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( Dali::Window::Type type );
 215
 216   /**
 217    * @copydoc Dali::Window::GetType() const
 218    */
 219   Dali::Window::Type GetType() const;
 220
 221   /**
 222    * @copydoc Dali::Window::SetNotificationLevel()
 223    */
 224   bool SetNotificationLevel( Dali::Window::NotificationLevel::Type level );
 225
 226   /**
 227    * @copydoc Dali::Window::GetNotificationLevel()
 228    */
 229   Dali::Window::NotificationLevel::Type 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(Dali::Window::ScreenOffMode::Type screenOffMode);
 245
 246   /**
 247    * @copydoc Dali::Window::GetScreenOffMode()
 248    */
 249   Dali::Window::ScreenOffMode::Type 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   Dali::Window::WindowOrientation GetCurrentOrientation() const;
 340
 341   /**
 342    * @copydoc Dali::DevelWindow::SetAvailableOrientations()
 343    */
 344   void SetAvailableOrientations( const Dali::Vector<Dali::Window::WindowOrientation>& orientations );
 345
 346   /**
 347    * @copydoc Dali::DevelWindow::SetDamagedAreas()
 348    */
 349   void SetDamagedAreas(std::vector<Dali::Rect<int>>& areas);
 350
 351 public: // Dali::Internal::Adaptor::SceneHolder
 352
 353   /**
 354    * @copydoc Dali::Internal::Adaptor::SceneHolder::GetNativeHandle
 355    */
 356   Dali::Any GetNativeHandle() const override;
 357
 358   /**
 359    * @copydoc Dali::Internal::Adaptor::SceneHolder::IsVisible
 360    */
 361   bool IsVisible() const override;
 362
 363   /**
 364    * @copydoc Dali::DevelWindow::GetNativeId()
 365    */
 366   int32_t GetNativeId() const;
 367
 368 private:
 369
 370   /**
 371    * @brief Enumeration for orietation mode.
 372    * The Orientation Mode is related to screen size.
 373    * If screen width is longer than height, the Orientation Mode will have LANDSCAPE.
 374    * Otherwise screen width is shorter than height or same, the Orientation Mode will have PORTRAIT.
 375    */
 376   enum class OrientationMode
 377   {
 378     PORTRAIT = 0,
 379     LANDSCAPE
 380   };
 381
 382   /**
 383    * Private constructor.
 384    * @sa Window::New()
 385    */
 386   Window();
 387
 388   /**
 389    * Destructor
 390    */
 391   virtual ~Window();
 392
 393   /**
 394    * Second stage initialization
 395    */
 396   void Initialize(Any surface, const PositionSize& positionSize, const std::string& name, const std::string& className);
 397
 398   /**
 399    * Called when the window becomes iconified or deiconified.
 400    */
 401   void OnIconifyChanged( bool iconified );
 402
 403   /**
 404    * Called when the window focus is changed.
 405    */
 406   void OnFocusChanged( bool focusIn );
 407
 408   /**
 409    * Called when the output is transformed.
 410    */
 411   void OnOutputTransformed();
 412
 413   /**
 414    * Called when the window receives a delete request.
 415    */
 416   void OnDeleteRequest();
 417
 418   /**
 419    * Called when the window receives a Transition effect-start/end event.
 420    */
 421   void OnTransitionEffectEvent( DevelWindow::EffectState state, DevelWindow::EffectType type );
 422
 423   /**
 424    * @brief Called when window receives a keyboard repeat event.
 425    */
 426   void OnKeyboardRepeatSettingsChanged();
 427
 428   /**
 429    * @brief Set available orientation to window base.
 430    */
 431   void SetAvailableAnlges( const std::vector< int >& angles );
 432
 433   /**
 434    * @brief Convert from window orientation to angle using OrientationMode.
 435    */
 436   int ConvertToAngle( Dali::Window::WindowOrientation orientation );
 437
 438   /**
 439    * @brief Convert from angle to window orientation using OrientationMode.
 440    */
 441   Dali::Window::WindowOrientation ConvertToOrientation( int angle ) const;
 442
 443   /**
 444    * @brief Check available window orientation for Available orientation.
 445    */
 446   bool IsOrientationAvailable( Dali::Window::WindowOrientation orientation ) const;
 447
 448 private: // Dali::Internal::Adaptor::SceneHolder
 449
 450   /**
 451    * @copydoc Dali::Internal::Adaptor::SceneHolder::OnAdaptorSet
 452    */
 453   void OnAdaptorSet( Dali::Adaptor& adaptor ) override;
 454
 455   /**
 456    * @copydoc Dali::Internal::Adaptor::SceneHolder::OnSurfaceSet
 457    */
 458   void OnSurfaceSet( Dali::RenderSurfaceInterface* surface ) override;
 459
 460   /**
 461    * @copydoc Dali::Internal::Adaptor::SceneHolder::OnPause
 462    */
 463   void OnPause() override;
 464
 465   /**
 466    * @copydoc Dali::Internal::Adaptor::SceneHolder::OnResume
 467    */
 468   void OnResume() override;
 469
 470   /**
 471    * @copydoc Dali::Internal::Adaptor::SceneHolder::RecalculateTouchPosition
 472    */
 473   void RecalculateTouchPosition( Integration::Point& point ) override;
 474
 475 private: // Dali::Internal::Adaptor::EventHandler::Observer
 476
 477   /**
 478    * @copydoc Dali::Internal::Adaptor::EventHandler::Observer::OnTouchPoint
 479    */
 480   void OnTouchPoint( Dali::Integration::Point& point, int timeStamp ) override;
 481
 482   /**
 483    * @copydoc Dali::Internal::Adaptor::EventHandler::Observer::OnWheelEvent
 484    */
 485   void OnWheelEvent( Dali::Integration::WheelEvent& wheelEvent ) override;
 486
 487   /**
 488    * @copydoc Dali::Internal::Adaptor::EventHandler::Observer::OnKeyEvent
 489    */
 490   void OnKeyEvent( Dali::Integration::KeyEvent& keyEvent ) override;
 491
 492   /**
 493    * @copydoc Dali::Internal::Adaptor::EventHandler::Observer::OnRotation
 494    */
 495   void OnRotation( const RotationEvent& rotation ) override;
 496
 497 public: // Signals
 498
 499   /**
 500    * @copydoc Dali::Window::FocusChangeSignal()
 501    */
 502   FocusChangeSignalType& FocusChangeSignal() { return mFocusChangeSignal; }
 503   /**
 504    * @copydoc Dali::Window::ResizedSignal()
 505    */
 506   ResizedSignalType& ResizedSignal() { return mResizedSignal; }
 507
 508   /**
 509    * @copydoc Dali::Window::ResizedSignal()
 510    */
 511   ResizeSignalType& ResizeSignal() { return mResizeSignal; }
 512
 513   /**
 514    * This signal is emitted when the window is requesting to be deleted
 515    */
 516   SignalType& DeleteRequestSignal() { return mDeleteRequestSignal; }
 517
 518   /**
 519    * @copydoc Dali::DevelWindow::VisibilityChangedSignal()
 520    */
 521   VisibilityChangedSignalType& VisibilityChangedSignal() { return mVisibilityChangedSignal; }
 522
 523   /**
 524    * @copydoc Dali::Window::SignalEventProcessingFinished()
 525    */
 526   Dali::DevelWindow::EventProcessingFinishedSignalType& EventProcessingFinishedSignal() { return mScene.EventProcessingFinishedSignal(); }
 527
 528   /**
 529    * @copydoc Dali::DevelWindow::TransitionEffectEventSignal()
 530    */
 531   TransitionEffectEventSignalType& TransitionEffectEventSignal() { return mTransitionEffectEventSignal; }
 532
 533   /**
 534    * @copydoc Dali::DevelWindow::KeyboardRepeatSettingsChangedSignal()
 535    */
 536   KeyboardRepeatSettingsChangedSignalType& KeyboardRepeatSettingsChangedSignal() { return mKeyboardRepeatSettingsChangedSignal; }
 537
 538 private:
 539
 540   WindowRenderSurface*                  mWindowSurface;      ///< The window rendering surface
 541   WindowBase*                           mWindowBase;
 542   std::string                           mName;
 543   std::string                           mClassName;
 544   bool                                  mIsTransparent:1;
 545   bool                                  mIsFocusAcceptable:1;
 546   bool                                  mIconified:1;
 547   bool                                  mOpaqueState:1;
 548   bool                                  mResizeEnabled:1;
 549   Dali::Window::Type                    mType;
 550   Dali::Window                          mParentWindow;
 551
 552   OrientationPtr                        mOrientation;
 553   std::vector< int >                    mAvailableAngles;
 554   int                                   mPreferredAngle;
 555
 556   int                                   mRotationAngle;     ///< The angle of the rotation
 557   int                                   mWindowWidth;       ///< The width of the window
 558   int                                   mWindowHeight;      ///< The height of the window
 559
 560   EventHandlerPtr                       mEventHandler;      ///< The window events handler
 561
 562   OrientationMode                       mOrientationMode;
 563
 564   int                                   mNativeWindowId;          ///< The Native Window Id
 565
 566   // Signals
 567   ResizedSignalType                       mResizedSignal;
 568   SignalType                              mDeleteRequestSignal;
 569   FocusChangeSignalType                   mFocusChangeSignal;
 570   ResizeSignalType                        mResizeSignal;
 571   VisibilityChangedSignalType             mVisibilityChangedSignal;
 572   TransitionEffectEventSignalType         mTransitionEffectEventSignal;
 573   KeyboardRepeatSettingsChangedSignalType mKeyboardRepeatSettingsChangedSignal;
 574 };
 575
 576 } // namespace Adaptor
 577 } // namepsace Internal
 578
 579 // Helpers for public-api forwarding methods
 580
 581 inline Internal::Adaptor::Window& GetImplementation(Dali::Window& window)
 582 {
 583   DALI_ASSERT_ALWAYS( window && "Window handle is empty" );
 584   BaseObject& object = window.GetBaseObject();
 585   return static_cast<Internal::Adaptor::Window&>(object);
 586 }
 587
 588 inline const Internal::Adaptor::Window& GetImplementation(const Dali::Window& window)
 589 {
 590   DALI_ASSERT_ALWAYS( window && "Window handle is empty" );
 591   const BaseObject& object = window.GetBaseObject();
 592   return static_cast<const Internal::Adaptor::Window&>(object);
 593 }
 594
 595 } // namespace Dali
 596
 597 #endif // DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_IMPL_H