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) 2019 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
  27 #ifdef DALI_ADAPTOR_COMPILATION
  28 #include <dali/integration-api/scene-holder-impl.h>
  29 #else
  30 #include <dali/integration-api/adaptors/scene-holder-impl.h>
  31 #endif
  32
  33 // INTERNAL INCLUDES
  34 #include <dali/public-api/adaptor-framework/window.h>
  35 #include <dali/public-api/adaptor-framework/key-grab.h>
  36 #include <dali/devel-api/adaptor-framework/window-devel.h>
  37
  38 namespace Dali
  39 {
  40 class Adaptor;
  41 class Actor;
  42 class RenderSurfaceInterface;
  43
  44 namespace Internal
  45 {
  46 namespace Adaptor
  47 {
  48 class EventHandler;
  49 class Orientation;
  50 class RotationObserver;
  51 class WindowRenderSurface;
  52 class WindowBase;
  53
  54 class Window;
  55 using WindowPtr = IntrusivePtr< Window >;
  56 using OrientationPtr = IntrusivePtr< Orientation >;
  57 using EventHandlerPtr = IntrusivePtr< EventHandler >;
  58
  59 /**
  60  * Window provides a surface to render onto with orientation & indicator properties.
  61  */
  62 class Window : public Dali::Internal::Adaptor::SceneHolder, public ConnectionTracker
  63 {
  64 public:
  65   typedef Dali::Window::IndicatorSignalType IndicatorSignalType;
  66   typedef Dali::Window::FocusSignalType FocusSignalType;
  67   typedef Dali::Window::ResizedSignalType ResizedSignalType;
  68   typedef Signal< void () > SignalType;
  69
  70   /**
  71    * Create a new Window. This should only be called once by the Application class
  72    * @param[in] positionSize The position and size of the window
  73    * @param[in] name The window title
  74    * @param[in] className The window class name
  75    * @param[in] isTransparent Whether window is transparent
  76    * @return A newly allocated Window
  77    */
  78   static Window* New(const PositionSize& positionSize, const std::string& name, const std::string& className, bool isTransparent = false);
  79
  80   /**
  81    * @copydoc Dali::Window::ShowIndicator()
  82    */
  83   void ShowIndicator( Dali::Window::IndicatorVisibleMode visibleMode );
  84
  85   /**
  86    * @copydoc Dali::Window::SetIndicatorBgOpacity()
  87    */
  88   void SetIndicatorBgOpacity( Dali::Window::IndicatorBgOpacity opacity );
  89
  90   /**
  91    * @copydoc Dali::Window::RotateIndicator()
  92    */
  93   void RotateIndicator( Dali::Window::WindowOrientation orientation );
  94
  95   /**
  96    * @copydoc Dali::Window::SetClass()
  97    */
  98   void SetClass( std::string name, std::string className );
  99
 100   /**
 101    * @brief Gets the window class name.
 102    * @return The class of the window
 103    */
 104   std::string GetClassName() const;
 105
 106   /**
 107    * @copydoc Dali::Window::Raise()
 108    */
 109   void Raise();
 110
 111   /**
 112    * @copydoc Dali::Window::Lower()
 113    */
 114   void Lower();
 115
 116   /**
 117    * @copydoc Dali::Window::Activate()
 118    */
 119   void Activate();
 120
 121   /**
 122    * @copydoc Dali::Window::GetLayerCount()
 123    */
 124   uint32_t GetLayerCount() const;
 125
 126   /**
 127    * @copydoc Dali::Window::GetLayer()
 128    */
 129   Dali::Layer GetLayer( uint32_t depth ) 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::SetAvailableOrientations()
 143    */
 144   void SetAvailableOrientations(const std::vector<Dali::Window::WindowOrientation>& orientations);
 145
 146   /**
 147    * @copydoc Dali::Window::GetAvailableOrientations()
 148    */
 149   const std::vector<Dali::Window::WindowOrientation>& GetAvailableOrientations();
 150
 151   /**
 152    * @copydoc Dali::Window::SetPreferredOrientation()
 153    */
 154   void SetPreferredOrientation(Dali::Window::WindowOrientation orientation);
 155
 156   /**
 157    * @copydoc Dali::Window::GetPreferredOrientation()
 158    */
 159   Dali::Window::WindowOrientation GetPreferredOrientation();
 160
 161   /**
 162    * @copydoc Dali::Window::SetAcceptFocus()
 163    */
 164   void SetAcceptFocus( bool accept );
 165
 166   /**
 167    * @copydoc Dali::Window::IsFocusAcceptable()
 168    */
 169   bool IsFocusAcceptable() const;
 170
 171   /**
 172    * @copydoc Dali::Window::Show()
 173    */
 174   void Show();
 175
 176   /**
 177    * @copydoc Dali::Window::Hide()
 178    */
 179   void Hide();
 180
 181   /**
 182    * @copydoc Dali::Window::GetSupportedAuxiliaryHintCount()
 183    */
 184   unsigned int GetSupportedAuxiliaryHintCount() const;
 185
 186   /**
 187    * @copydoc Dali::Window::GetSupportedAuxiliaryHint()
 188    */
 189   std::string GetSupportedAuxiliaryHint( unsigned int index ) const;
 190
 191   /**
 192    * @copydoc Dali::Window::AddAuxiliaryHint()
 193    */
 194   unsigned int AddAuxiliaryHint( const std::string& hint, const std::string& value );
 195
 196   /**
 197    * @copydoc Dali::Window::RemoveAuxiliaryHint()
 198    */
 199   bool RemoveAuxiliaryHint( unsigned int id );
 200
 201   /**
 202    * @copydoc Dali::Window::SetAuxiliaryHintValue()
 203    */
 204   bool SetAuxiliaryHintValue( unsigned int id, const std::string& value );
 205
 206   /**
 207    * @copydoc Dali::Window::GetAuxiliaryHintValue()
 208    */
 209   std::string GetAuxiliaryHintValue( unsigned int id ) const;
 210
 211   /**
 212    * @copydoc Dali::Window::GetAuxiliaryHintId()
 213    */
 214   unsigned int GetAuxiliaryHintId( const std::string& hint ) const;
 215
 216   /**
 217    * @copydoc Dali::Window::SetInputRegion()
 218    */
 219   void SetInputRegion( const Rect< int >& inputRegion );
 220
 221   /**
 222    * @copydoc Dali::Window::SetType()
 223    */
 224   void SetType( Dali::Window::Type type );
 225
 226   /**
 227    * @copydoc Dali::Window::GetType() const
 228    */
 229   Dali::Window::Type GetType() const;
 230
 231   /**
 232    * @copydoc Dali::Window::SetNotificationLevel()
 233    */
 234   bool SetNotificationLevel( Dali::Window::NotificationLevel::Type level );
 235
 236   /**
 237    * @copydoc Dali::Window::GetNotificationLevel()
 238    */
 239   Dali::Window::NotificationLevel::Type GetNotificationLevel() const;
 240
 241   /**
 242    * @copydoc Dali::Window::SetOpaqueState()
 243    */
 244   void SetOpaqueState( bool opaque );
 245
 246   /**
 247    * @copydoc Dali::Window::IsOpaqueState()
 248    */
 249   bool IsOpaqueState() const;
 250
 251   /**
 252    * @copydoc Dali::Window::SetScreenOffMode()
 253    */
 254   bool SetScreenOffMode(Dali::Window::ScreenOffMode::Type screenOffMode);
 255
 256   /**
 257    * @copydoc Dali::Window::GetScreenOffMode()
 258    */
 259   Dali::Window::ScreenOffMode::Type GetScreenOffMode() const;
 260
 261   /**
 262    * @copydoc Dali::Window::SetBrightness()
 263    */
 264   bool SetBrightness( int brightness );
 265
 266   /**
 267    * @copydoc Dali::Window::GetBrightness()
 268    */
 269   int GetBrightness() const;
 270
 271   /**
 272    * @copydoc Dali::Window::SetSize()
 273    */
 274   void SetSize( Dali::Window::WindowSize size );
 275
 276   /**
 277    * @copydoc Dali::Window::GetSize()
 278    */
 279   Dali::Window::WindowSize GetSize() const;
 280
 281   /**
 282    * @copydoc Dali::Window::SetPosition()
 283    */
 284   void SetPosition( Dali::Window::WindowPosition position );
 285
 286   /**
 287    * @copydoc Dali::Window::GetPosition()
 288    */
 289   Dali::Window::WindowPosition GetPosition() const;
 290
 291   /**
 292    * @copydoc Dali::DevelWindow::SetPositionSize()
 293    */
 294   void SetPositionSize( PositionSize positionSize );
 295
 296   /**
 297    * @copydoc Dali::Window::GetRootLayer()
 298    */
 299   Dali::Layer GetRootLayer() const;
 300
 301   /**
 302    * @copydoc Dali::Window::SetTransparency()
 303    */
 304   void SetTransparency( bool transparent );
 305
 306   /**
 307    * @copydoc Dali::KeyGrab::GrabKey()
 308    */
 309   bool GrabKey( Dali::KEY key, KeyGrab::KeyGrabMode grabMode );
 310
 311   /**
 312    * @copydoc Dali::KeyGrab::UngrabKey()
 313    */
 314   bool UngrabKey( Dali::KEY key );
 315
 316   /**
 317    * @copydoc Dali::KeyGrab::GrabKeyList()
 318    */
 319   bool GrabKeyList( const Dali::Vector< Dali::KEY >& key, const Dali::Vector< KeyGrab::KeyGrabMode >& grabMode, Dali::Vector< bool >& result );
 320
 321   /**
 322    * @copydoc Dali::KeyGrab::UngrabKeyList()
 323    */
 324   bool UngrabKeyList( const Dali::Vector< Dali::KEY >& key, Dali::Vector< bool >& result );
 325
 326   /**
 327    * Called from Orientation after the Change signal has been sent
 328    */
 329   void RotationDone( int orientation, int width, int height );
 330
 331   /**
 332    * Set the rotation observer (note, some adaptors may not have a rotation observer)
 333    * @param[in] observer The rotation observer
 334    * @return If the rotation observer is set
 335    */
 336   bool SetRotationObserver( RotationObserver* observer );
 337
 338   /**
 339    * @copydoc Dali::DevelWindow::Get()
 340    */
 341   static Dali::Window Get( Dali::Actor actor );
 342
 343 public: // Dali::Internal::Adaptor::SceneHolder
 344
 345   /**
 346    * @copydoc Dali::Internal::Adaptor::SceneHolder::GetNativeHandle
 347    */
 348   Dali::Any GetNativeHandle() const override;
 349
 350   /**
 351    * @copydoc Dali::Internal::Adaptor::SceneHolder::IsVisible
 352    */
 353   bool IsVisible() const override;
 354
 355 private:
 356
 357   /**
 358    * Private constructor.
 359    * @sa Window::New()
 360    */
 361   Window();
 362
 363   /**
 364    * Destructor
 365    */
 366   virtual ~Window();
 367
 368   /**
 369    * Second stage initialization
 370    */
 371   void Initialize(const PositionSize& positionSize, const std::string& name, const std::string& className);
 372
 373   /**
 374    * Called when the window becomes iconified or deiconified.
 375    */
 376   void OnIconifyChanged( bool iconified );
 377
 378   /**
 379    * Called when the window focus is changed.
 380    */
 381   void OnFocusChanged( bool focusIn );
 382
 383   /**
 384    * Called when the output is transformed.
 385    */
 386   void OnOutputTransformed();
 387
 388   /**
 389    * Called when the window receives a delete request.
 390    */
 391   void OnDeleteRequest();
 392
 393 private: // Dali::Internal::Adaptor::SceneHolder
 394
 395   /**
 396    * @copydoc Dali::Internal::Adaptor::SceneHolder::FeedTouchPoint
 397    */
 398   void FeedTouchPoint( TouchPoint& point, int timeStamp ) override;
 399
 400   /**
 401    * @copydoc Dali::Internal::Adaptor::SceneHolder::FeedWheelEvent
 402    */
 403   void FeedWheelEvent( WheelEvent& wheelEvent ) override;
 404
 405   /**
 406    * @copydoc Dali::Internal::Adaptor::SceneHolder::FeedKeyEvent
 407    */
 408   void FeedKeyEvent( KeyEvent& keyEvent ) override;
 409
 410   /**
 411    * @copydoc Dali::Internal::Adaptor::SceneHolder::OnAdaptorSet
 412    */
 413   void OnAdaptorSet( Dali::Adaptor& adaptor ) override;
 414
 415   /**
 416    * @copydoc Dali::Internal::Adaptor::SceneHolder::OnSurfaceSet
 417    */
 418   void OnSurfaceSet( Dali::RenderSurfaceInterface* surface ) override;
 419
 420   /**
 421    * @copydoc Dali::Internal::Adaptor::SceneHolder::OnPause
 422    */
 423   void OnPause() override;
 424
 425   /**
 426    * @copydoc Dali::Internal::Adaptor::SceneHolder::OnResume
 427    */
 428   void OnResume() override;
 429
 430 public: // Signals
 431
 432   /**
 433    * The user should connect to this signal to get a timing when indicator was shown / hidden.
 434    */
 435   IndicatorSignalType& IndicatorVisibilityChangedSignal() { return mIndicatorVisibilityChangedSignal; }
 436
 437   /**
 438    * @copydoc Dali::Window::FocusChangedSignal()
 439    */
 440   FocusSignalType& FocusChangedSignal() { return mFocusChangedSignal; }
 441
 442   /**
 443    * @copydoc Dali::Window::ResizedSignal()
 444    */
 445   ResizedSignalType& ResizedSignal() { return mResizedSignal; }
 446
 447   /**
 448    * This signal is emitted when the window is requesting to be deleted
 449    */
 450   SignalType& DeleteRequestSignal() { return mDeleteRequestSignal; }
 451
 452   /**
 453    * @copydoc Dali::Window::SignalEventProcessingFinished()
 454    */
 455   Dali::DevelWindow::EventProcessingFinishedSignalType& EventProcessingFinishedSignal() { return mScene.EventProcessingFinishedSignal(); };
 456
 457   /**
 458    * @copydoc Dali::Window::KeyEventSignal()
 459    */
 460   Dali::DevelWindow::KeyEventSignalType& KeyEventSignal() { return mScene.KeyEventSignal(); };
 461
 462   /**
 463     * @copydoc Dali::Window::TouchSignal()
 464     */
 465   Dali::DevelWindow::TouchSignalType& TouchSignal() { return mScene.TouchSignal(); };
 466
 467   /**
 468    * @copydoc Dali::Window::WheelEventSignal()
 469    */
 470   Dali::DevelWindow::WheelEventSignalType& WheelEventSignal() { return mScene.WheelEventSignal(); };
 471
 472 private:
 473
 474   WindowRenderSurface*                  mWindowSurface;      ///< The window rendering surface
 475   WindowBase*                           mWindowBase;
 476   std::string                           mName;
 477   std::string                           mClassName;
 478   bool                                  mIsTransparent:1;
 479   bool                                  mIsFocusAcceptable:1;
 480   bool                                  mIconified:1;
 481   bool                                  mOpaqueState:1;
 482   bool                                  mResizeEnabled:1;
 483   Dali::Window::Type                    mType;
 484
 485   OrientationPtr                               mOrientation;
 486   std::vector<Dali::Window::WindowOrientation> mAvailableOrientations;
 487   Dali::Window::WindowOrientation              mPreferredOrientation;
 488
 489   EventHandlerPtr                       mEventHandler;      ///< The window events handler
 490
 491   // Signals
 492   IndicatorSignalType                   mIndicatorVisibilityChangedSignal;
 493   FocusSignalType                       mFocusChangedSignal;
 494   ResizedSignalType                     mResizedSignal;
 495   SignalType                            mDeleteRequestSignal;
 496
 497
 498 };
 499
 500 } // namespace Adaptor
 501 } // namepsace Internal
 502
 503 // Helpers for public-api forwarding methods
 504
 505 inline Internal::Adaptor::Window& GetImplementation(Dali::Window& window)
 506 {
 507   DALI_ASSERT_ALWAYS( window && "Window handle is empty" );
 508   BaseObject& object = window.GetBaseObject();
 509   return static_cast<Internal::Adaptor::Window&>(object);
 510 }
 511
 512 inline const Internal::Adaptor::Window& GetImplementation(const Dali::Window& window)
 513 {
 514   DALI_ASSERT_ALWAYS( window && "Window handle is empty" );
 515   const BaseObject& object = window.GetBaseObject();
 516   return static_cast<const Internal::Adaptor::Window&>(object);
 517 }
 518
 519 } // namespace Dali
 520
 521 #endif // DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_IMPL_H