adaptors/common/window-impl.h

   1 #ifndef __DALI_INTERNAL_WINDOW_H__
   2 #define __DALI_INTERNAL_WINDOW_H__
   3
   4 /*
   5  * Copyright (c) 2017 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
  25 // INTERNAL INCLUDES
  26 #include <base/lifecycle-observer.h>
  27 #include <base/interfaces/indicator-interface.h>
  28 #include <adaptor-impl.h>
  29 #include <window.h>
  30 #include <orientation.h>
  31 #include <render-surface.h>
  32 #include <drag-and-drop-detector.h>
  33 #include <window-devel.h>
  34
  35 namespace Dali
  36 {
  37 class Adaptor;
  38 class RenderSurface;
  39
  40 namespace Integration
  41 {
  42 class SystemOverlay;
  43 }
  44
  45 namespace Internal
  46 {
  47 namespace Adaptor
  48 {
  49 class Orientation;
  50
  51 class Window;
  52 typedef IntrusivePtr<Window> WindowPtr;
  53 typedef IntrusivePtr<Orientation> OrientationPtr;
  54
  55 /**
  56  * Window provides a surface to render onto with orientation & indicator properties.
  57  */
  58 class Window : public Dali::BaseObject, public IndicatorInterface::Observer, public LifeCycleObserver
  59 {
  60 public:
  61   typedef Dali::Window::IndicatorSignalType IndicatorSignalType;
  62   typedef Dali::DevelWindow::FocusSignalType FocusSignalType;
  63   typedef Dali::DevelWindow::ResizedSignalType ResizedSignalType;
  64   typedef Signal< void () > SignalType;
  65
  66   /**
  67    * Create a new Window. This should only be called once by the Application class
  68    * @param[in] positionSize The position and size of the window
  69    * @param[in] name The window title
  70    * @param[in] className The window class name
  71    * @param[in] isTransparent Whether window is transparent
  72    * @return A newly allocated Window
  73    */
  74   static Window* New(const PositionSize& positionSize, const std::string& name, const std::string& className, bool isTransparent = false);
  75
  76   /**
  77    * Pass the adaptor back to the overlay. This allows the window to access Core's overlay.
  78    * @param[in] adaptor An initialized adaptor
  79    */
  80   void SetAdaptor(Dali::Adaptor& adaptor);
  81
  82   /**
  83    * Get the window surface
  84    * @return The render surface
  85    */
  86   RenderSurface* GetSurface();
  87
  88   /**
  89    * @copydoc Dali::Window::ShowIndicator()
  90    */
  91   void ShowIndicator( Dali::Window::IndicatorVisibleMode visibleMode );
  92
  93   /**
  94    * @copydoc Dali::Window::SetIndicatorBgOpacity()
  95    */
  96   void SetIndicatorBgOpacity( Dali::Window::IndicatorBgOpacity opacity );
  97
  98   /**
  99    * @copydoc Dali::Window::RotateIndicator()
 100    */
 101   void RotateIndicator( Dali::Window::WindowOrientation orientation );
 102
 103   /**
 104    * @copydoc Dali::Window::SetClass()
 105    */
 106   void SetClass( std::string name, std::string klass );
 107
 108   /**
 109    * @copydoc Dali::Window::Raise()
 110    */
 111   void Raise();
 112
 113   /**
 114    * @copydoc Dali::Window::Lower()
 115    */
 116   void Lower();
 117
 118   /**
 119    * @copydoc Dali::Window::Activate()
 120    */
 121   void Activate();
 122
 123   /**
 124    * @copydoc Dali::Window::AddAvailableOrientation()
 125    */
 126   void AddAvailableOrientation(Dali::Window::WindowOrientation orientation);
 127
 128   /**
 129    * @copydoc Dali::Window::RemoveAvailableOrientation()
 130    */
 131   void RemoveAvailableOrientation(Dali::Window::WindowOrientation orientation);
 132
 133   /**
 134    * @copydoc Dali::Window::SetAvailableOrientations()
 135    */
 136   void SetAvailableOrientations(const std::vector<Dali::Window::WindowOrientation>& orientations);
 137
 138   /**
 139    * @copydoc Dali::Window::GetAvailableOrientations()
 140    */
 141   const std::vector<Dali::Window::WindowOrientation>& GetAvailableOrientations();
 142
 143   /**
 144    * @copydoc Dali::Window::SetPreferredOrientation()
 145    */
 146   void SetPreferredOrientation(Dali::Window::WindowOrientation orientation);
 147
 148   /**
 149    * @copydoc Dali::Window::GetPreferredOrientation()
 150    */
 151   Dali::Window::WindowOrientation GetPreferredOrientation();
 152
 153   /**
 154    * @copydoc Dali::Window::GetDragAndDropDetector() const
 155    */
 156   Dali::DragAndDropDetector GetDragAndDropDetector() const;
 157
 158   /**
 159    * @copydoc Dali::Window::GetNativeHandle() const
 160    */
 161   Dali::Any GetNativeHandle() const;
 162
 163   /**
 164    * @copydoc Dali::DevelWindow::SetAcceptFocus()
 165    */
 166   void SetAcceptFocus( bool accept );
 167
 168   /**
 169    * @copydoc Dali::DevelWindow::IsFocusAcceptable()
 170    */
 171   bool IsFocusAcceptable();
 172
 173   /**
 174    * @copydoc Dali::DevelWindow::Show()
 175    */
 176   void Show();
 177
 178   /**
 179    * @copydoc Dali::DevelWindow::Hide()
 180    */
 181   void Hide();
 182
 183   /**
 184    * @copydoc Dali::DevelWindow::IsVisible() const
 185    */
 186   bool IsVisible() const;
 187
 188   /**
 189    * @copydoc Dali::DevelWindow::GetSupportedAuxiliaryHintCount()
 190    */
 191    unsigned int GetSupportedAuxiliaryHintCount();
 192
 193    /**
 194     * @copydoc Dali::DevelWindow::GetSupportedAuxiliaryHint()
 195     */
 196   std::string GetSupportedAuxiliaryHint( unsigned int index );
 197
 198   /**
 199    * @copydoc Dali::DevelWindow::AddAuxiliaryHint()
 200    */
 201   unsigned int AddAuxiliaryHint( const std::string& hint, const std::string& value );
 202
 203   /**
 204    * @copydoc Dali::DevelWindow::RemoveAuxiliaryHint()
 205    */
 206   bool RemoveAuxiliaryHint( unsigned int id );
 207
 208   /**
 209    * @copydoc Dali::DevelWindow::SetAuxiliaryHintValue()
 210    */
 211   bool SetAuxiliaryHintValue( unsigned int id, const std::string& value );
 212
 213   /**
 214    * @copydoc Dali::DevelWindow::GetAuxiliaryHintValue()
 215    */
 216   std::string GetAuxiliaryHintValue( unsigned int id ) const;
 217
 218   /**
 219    * @copydoc Dali::DevelWindow::GetAuxiliaryHintId()
 220    */
 221   unsigned int GetAuxiliaryHintId( const std::string& hint ) const;
 222
 223   /**
 224    * @copydoc Dali::DevelWindow::SetInputRegion()
 225    */
 226   void SetInputRegion( const Rect< int >& inputRegion );
 227
 228   /**
 229    * @copydoc Dali::DevelWindow::SetType()
 230    */
 231   void SetType( Dali::DevelWindow::Type type );
 232
 233   /**
 234    * @copydoc Dali::DevelWindow::GetType() const
 235    */
 236   Dali::DevelWindow::Type GetType() const;
 237
 238   /**
 239    * @copydoc Dali::DevelWindow::SetNotificationLevel()
 240    */
 241   bool SetNotificationLevel( Dali::DevelWindow::NotificationLevel::Type level );
 242
 243   /**
 244    * @copydoc Dali::DevelWindow::GetNotificationLevel()
 245    */
 246   Dali::DevelWindow::NotificationLevel::Type GetNotificationLevel();
 247
 248   /**
 249    * @copydoc Dali::DevelWindow::SetOpaqueState()
 250    */
 251   void SetOpaqueState( bool opaque );
 252
 253   /**
 254    * @copydoc Dali::DevelWindow::IsOpaqueState()
 255    */
 256   bool IsOpaqueState();
 257
 258   /**
 259    * @copydoc Dali::DevelWindow::SetScreenMode()
 260    */
 261   bool SetScreenMode( Dali::DevelWindow::ScreenMode::Type screenMode );
 262
 263   /**
 264    * @copydoc Dali::DevelWindow::GetScreenMode()
 265    */
 266   Dali::DevelWindow::ScreenMode::Type GetScreenMode();
 267
 268   /**
 269    * @copydoc Dali::DevelWindow::SetBrightness()
 270    */
 271   bool SetBrightness( int brightness );
 272
 273   /**
 274    * @copydoc Dali::DevelWindow::GetBrightness()
 275    */
 276   int GetBrightness();
 277
 278   /**
 279    * @copydoc Dali::DevelWindow::SetSize()
 280    */
 281   void SetSize( Dali::DevelWindow::WindowSize size );
 282
 283   /**
 284    * @copydoc Dali::DevelWindow::GetSize()
 285    */
 286   Dali::DevelWindow::WindowSize GetSize();
 287
 288   /**
 289    * @copydoc Dali::DevelWindow::SetPosition()
 290    */
 291   void SetPosition( Dali::DevelWindow::WindowPosition position );
 292
 293   /**
 294    * @copydoc Dali::DevelWindow::GetPosition()
 295    */
 296   Dali::DevelWindow::WindowPosition GetPosition();
 297
 298   /**
 299    * Called from Orientation after the Change signal has been sent
 300    */
 301   void RotationDone( int orientation, int width, int height );
 302
 303 private:
 304   /**
 305    * Private constructor.
 306    * @sa Window::New()
 307    */
 308   Window();
 309
 310   /**
 311    * Destructor
 312    */
 313   virtual ~Window();
 314
 315   /**
 316    * Second stage initialization
 317    */
 318   void Initialize(const PositionSize& positionSize, const std::string& name, const std::string& className);
 319
 320   /**
 321    * Shows / hides the indicator bar.
 322    * Handles close/open if rotation changes whilst hidden
 323    */
 324   void DoShowIndicator( Dali::Window::WindowOrientation lastOrientation );
 325
 326   /**
 327    * Close current indicator and open a connection onto the new indicator service.
 328    * Effect may not be synchronous if waiting for an indicator update on existing connection.
 329    */
 330   void DoRotateIndicator( Dali::Window::WindowOrientation orientation );
 331
 332   /**
 333    * Change the indicator actor's rotation to match the current orientation
 334    */
 335   void SetIndicatorActorRotation();
 336
 337   /**
 338    * Set the indicator properties on the window
 339    */
 340   void SetIndicatorProperties( bool isShown, Dali::Window::WindowOrientation lastOrientation );
 341
 342 private: // IndicatorInterface::Observer interface
 343
 344   /**
 345    * @copydoc Dali::Internal::Adaptor::IndicatorInterface::Observer::IndicatorTypeChanged()
 346    */
 347   virtual void IndicatorTypeChanged( IndicatorInterface::Type type );
 348
 349   /**
 350    * @copydoc Dali::Internal::Adaptor::IndicatorInterface::Observer::IndicatorClosed()
 351    */
 352   virtual void IndicatorClosed( IndicatorInterface* indicator);
 353
 354   /**
 355    * @copydoc Dali::Internal::Adaptor::IndicatorInterface::Observer::IndicatorVisibilityChanged()
 356    */
 357   virtual void IndicatorVisibilityChanged( bool isVisible );
 358
 359 private: // Adaptor::Observer interface
 360
 361   /**
 362    * @copydoc Dali::Internal::Adaptor::Adaptor::Observer::OnStart()
 363    */
 364   virtual void OnStart();
 365
 366   /**
 367    * @copydoc Dali::Internal::Adaptor::Adaptor::Observer::OnPause()
 368    */
 369   virtual void OnPause();
 370
 371   /**
 372    * @copydoc Dali::Internal::Adaptor::Adaptor::Observer::OnResume()
 373    */
 374   virtual void OnResume();
 375
 376   /**
 377    * @copydoc Dali::Internal::Adaptor::Adaptor::Observer::OnStop()
 378    */
 379   virtual void OnStop();
 380
 381   /**
 382    * @copydoc Dali::Internal::Adaptor::Adaptor::Observer::OnDestroy()
 383    */
 384   virtual void OnDestroy();
 385
 386 public: // Signals
 387
 388   /**
 389    * The user should connect to this signal to get a timing when indicator was shown / hidden.
 390    */
 391   IndicatorSignalType& IndicatorVisibilityChangedSignal() { return mIndicatorVisibilityChangedSignal; }
 392
 393   /**
 394    * @copydoc Dali::DevelWindow::FocusChangedSignal()
 395    */
 396   FocusSignalType& FocusChangedSignal() { return mFocusChangedSignal; }
 397
 398   /**
 399    * @copydoc Dali::DevelWindow::ResizedSignal()
 400    */
 401   ResizedSignalType& ResizedSignal() { return mResizedSignal; }
 402
 403   /**
 404    * This signal is emitted when the window is requesting to be deleted
 405    */
 406   SignalType& DeleteRequestSignal() { return mDeleteRequestSignal; }
 407
 408 private:
 409
 410   typedef std::vector< std::pair< std::string, std::string > > AuxiliaryHints;
 411
 412   RenderSurface*                   mSurface;
 413   Dali::Window::IndicatorVisibleMode mIndicatorVisible; ///< public state
 414   bool                             mIndicatorIsShown:1; ///< private state
 415   bool                             mShowRotatedIndicatorOnClose:1;
 416   bool                             mStarted:1;
 417   bool                             mIsTransparent:1;
 418   bool                             mWMRotationAppSet:1;
 419   bool                             mEcoreEventHander:1;
 420   bool                             mIsFocusAcceptable:1;
 421   bool                             mVisible:1;
 422   bool                             mOpaqueState:1;
 423   bool                             mResizeEnabled:1;
 424   IndicatorInterface*              mIndicator;
 425   Dali::Window::WindowOrientation  mIndicatorOrientation;
 426   Dali::Window::WindowOrientation  mNextIndicatorOrientation;
 427   Dali::Window::IndicatorBgOpacity mIndicatorOpacityMode;
 428   Integration::SystemOverlay*      mOverlay;
 429   Adaptor*                         mAdaptor;
 430   Dali::DragAndDropDetector        mDragAndDropDetector;
 431   Dali::DevelWindow::Type          mType;
 432
 433   struct EventHandler;
 434   EventHandler*                    mEventHandler;
 435
 436   OrientationPtr                               mOrientation;
 437   std::vector<Dali::Window::WindowOrientation> mAvailableOrientations;
 438   Dali::Window::WindowOrientation              mPreferredOrientation;
 439
 440   std::vector< std::string >        mSupportedAuxiliaryHints;
 441   AuxiliaryHints                    mAuxiliaryHints;
 442
 443   // Signals
 444   IndicatorSignalType mIndicatorVisibilityChangedSignal;
 445   FocusSignalType     mFocusChangedSignal;
 446   ResizedSignalType   mResizedSignal;
 447   SignalType          mDeleteRequestSignal;
 448 };
 449
 450 } // namespace Adaptor
 451 } // namepsace Internal
 452
 453 // Helpers for public-api forwarding methods
 454
 455 inline Internal::Adaptor::Window& GetImplementation(Dali::Window& window)
 456 {
 457   DALI_ASSERT_ALWAYS( window && "Window handle is empty" );
 458   BaseObject& object = window.GetBaseObject();
 459   return static_cast<Internal::Adaptor::Window&>(object);
 460 }
 461
 462 inline const Internal::Adaptor::Window& GetImplementation(const Dali::Window& window)
 463 {
 464   DALI_ASSERT_ALWAYS( window && "Window handle is empty" );
 465   const BaseObject& object = window.GetBaseObject();
 466   return static_cast<const Internal::Adaptor::Window&>(object);
 467 }
 468
 469 } // namespace Dali
 470
 471
 472 #endif // __DALI_INTERNAL_WINDOW_H__