1 #ifndef DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_IMPL_H
2 #define DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_IMPL_H
5 * Copyright (c) 2020 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
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>
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>
40 class RenderSurfaceInterface;
47 class WindowRenderSurface;
51 using WindowPtr = IntrusivePtr< Window >;
52 using OrientationPtr = IntrusivePtr< Orientation >;
53 using EventHandlerPtr = IntrusivePtr< EventHandler >;
56 * Window provides a surface to render onto with orientation & indicator properties.
58 class Window : public Dali::Internal::Adaptor::SceneHolder, public EventHandler::Observer, public ConnectionTracker
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;
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
77 static Window* New(const PositionSize& positionSize, const std::string& name, const std::string& className, bool isTransparent = false);
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
88 static Window* New(Any surface, const PositionSize& positionSize, const std::string& name, const std::string& className, bool isTransparent = false);
91 * @copydoc Dali::Window::SetClass()
93 void SetClass( std::string name, std::string className );
96 * @brief Gets the window class name.
97 * @return The class of the window
99 std::string GetClassName() const;
102 * @copydoc Dali::Window::Raise()
107 * @copydoc Dali::Window::Lower()
112 * @copydoc Dali::Window::Activate()
117 * @copydoc Dali::Window::GetLayerCount()
119 uint32_t GetLayerCount() const;
122 * @copydoc Dali::Window::GetLayer()
124 Dali::Layer GetLayer( uint32_t depth ) const;
127 * @copydoc Dali::DevelWindow::GetRenderTaskList()
129 Dali::RenderTaskList GetRenderTaskList() const;
132 * @copydoc Dali::Window::AddAvailableOrientation()
134 void AddAvailableOrientation(Dali::Window::WindowOrientation orientation);
137 * @copydoc Dali::Window::RemoveAvailableOrientation()
139 void RemoveAvailableOrientation(Dali::Window::WindowOrientation orientation);
142 * @copydoc Dali::Window::SetPreferredOrientation()
144 void SetPreferredOrientation(Dali::Window::WindowOrientation orientation);
147 * @copydoc Dali::Window::GetPreferredOrientation()
149 Dali::Window::WindowOrientation GetPreferredOrientation();
152 * @copydoc Dali::Window::SetAcceptFocus()
154 void SetAcceptFocus( bool accept );
157 * @copydoc Dali::Window::IsFocusAcceptable()
159 bool IsFocusAcceptable() const;
162 * @copydoc Dali::Window::Show()
167 * @copydoc Dali::Window::Hide()
172 * @copydoc Dali::Window::GetSupportedAuxiliaryHintCount()
174 unsigned int GetSupportedAuxiliaryHintCount() const;
177 * @copydoc Dali::Window::GetSupportedAuxiliaryHint()
179 std::string GetSupportedAuxiliaryHint( unsigned int index ) const;
182 * @copydoc Dali::Window::AddAuxiliaryHint()
184 unsigned int AddAuxiliaryHint( const std::string& hint, const std::string& value );
187 * @copydoc Dali::Window::RemoveAuxiliaryHint()
189 bool RemoveAuxiliaryHint( unsigned int id );
192 * @copydoc Dali::Window::SetAuxiliaryHintValue()
194 bool SetAuxiliaryHintValue( unsigned int id, const std::string& value );
197 * @copydoc Dali::Window::GetAuxiliaryHintValue()
199 std::string GetAuxiliaryHintValue( unsigned int id ) const;
202 * @copydoc Dali::Window::GetAuxiliaryHintId()
204 unsigned int GetAuxiliaryHintId( const std::string& hint ) const;
207 * @copydoc Dali::Window::SetInputRegion()
209 void SetInputRegion( const Rect< int >& inputRegion );
212 * @copydoc Dali::Window::SetType()
214 void SetType( Dali::Window::Type type );
217 * @copydoc Dali::Window::GetType() const
219 Dali::Window::Type GetType() const;
222 * @copydoc Dali::Window::SetNotificationLevel()
224 bool SetNotificationLevel( Dali::Window::NotificationLevel::Type level );
227 * @copydoc Dali::Window::GetNotificationLevel()
229 Dali::Window::NotificationLevel::Type GetNotificationLevel() const;
232 * @copydoc Dali::Window::SetOpaqueState()
234 void SetOpaqueState( bool opaque );
237 * @copydoc Dali::Window::IsOpaqueState()
239 bool IsOpaqueState() const;
242 * @copydoc Dali::Window::SetScreenOffMode()
244 bool SetScreenOffMode(Dali::Window::ScreenOffMode::Type screenOffMode);
247 * @copydoc Dali::Window::GetScreenOffMode()
249 Dali::Window::ScreenOffMode::Type GetScreenOffMode() const;
252 * @copydoc Dali::Window::SetBrightness()
254 bool SetBrightness( int brightness );
257 * @copydoc Dali::Window::GetBrightness()
259 int GetBrightness() const;
262 * @copydoc Dali::Window::SetSize()
264 void SetSize( Dali::Window::WindowSize size );
267 * @copydoc Dali::Window::GetSize()
269 Dali::Window::WindowSize GetSize() const;
272 * @copydoc Dali::Window::SetPosition()
274 void SetPosition( Dali::Window::WindowPosition position );
277 * @copydoc Dali::Window::GetPosition()
279 Dali::Window::WindowPosition GetPosition() const;
282 * @copydoc Dali::DevelWindow::SetPositionSize()
284 void SetPositionSize( PositionSize positionSize );
287 * @copydoc Dali::Window::GetRootLayer()
289 Dali::Layer GetRootLayer() const;
292 * @copydoc Dali::Window::SetTransparency()
294 void SetTransparency( bool transparent );
297 * @copydoc Dali::KeyGrab::GrabKey()
299 bool GrabKey( Dali::KEY key, KeyGrab::KeyGrabMode grabMode );
302 * @copydoc Dali::KeyGrab::UngrabKey()
304 bool UngrabKey( Dali::KEY key );
307 * @copydoc Dali::KeyGrab::GrabKeyList()
309 bool GrabKeyList( const Dali::Vector< Dali::KEY >& key, const Dali::Vector< KeyGrab::KeyGrabMode >& grabMode, Dali::Vector< bool >& result );
312 * @copydoc Dali::KeyGrab::UngrabKeyList()
314 bool UngrabKeyList( const Dali::Vector< Dali::KEY >& key, Dali::Vector< bool >& result );
317 * @copydoc Dali::DevelWindow::Get()
319 static Dali::Window Get( Dali::Actor actor );
322 * @copydoc Dali::DevelWindow::SetParent()
324 void SetParent( Dali::Window& parent );
327 * @copydoc Dali::DevelWindow::Unparent()
332 * @copydoc Dali::DevelWindow::GetParent()
334 Dali::Window GetParent();
337 * @copydoc Dali::DevelWindow::GetCurrentOrientation()
339 Dali::Window::WindowOrientation GetCurrentOrientation() const;
342 * @copydoc Dali::DevelWindow::SetAvailableOrientations()
344 void SetAvailableOrientations( const Dali::Vector<Dali::Window::WindowOrientation>& orientations );
347 * @copydoc Dali::DevelWindow::SetDamagedAreas()
349 void SetDamagedAreas(std::vector<Dali::Rect<int>>& areas);
351 public: // Dali::Internal::Adaptor::SceneHolder
354 * @copydoc Dali::Internal::Adaptor::SceneHolder::GetNativeHandle
356 Dali::Any GetNativeHandle() const override;
359 * @copydoc Dali::Internal::Adaptor::SceneHolder::IsVisible
361 bool IsVisible() const override;
364 * @copydoc Dali::DevelWindow::GetNativeId()
366 int32_t GetNativeId() const;
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.
376 enum class OrientationMode
383 * Private constructor.
394 * Second stage initialization
396 void Initialize(Any surface, const PositionSize& positionSize, const std::string& name, const std::string& className);
399 * Called when the window becomes iconified or deiconified.
401 void OnIconifyChanged( bool iconified );
404 * Called when the window focus is changed.
406 void OnFocusChanged( bool focusIn );
409 * Called when the output is transformed.
411 void OnOutputTransformed();
414 * Called when the window receives a delete request.
416 void OnDeleteRequest();
419 * Called when the window receives a Transition effect-start/end event.
421 void OnTransitionEffectEvent( DevelWindow::EffectState state, DevelWindow::EffectType type );
424 * @brief Called when window receives a keyboard repeat event.
426 void OnKeyboardRepeatSettingsChanged();
429 * @brief Set available orientation to window base.
431 void SetAvailableAnlges( const std::vector< int >& angles );
434 * @brief Convert from window orientation to angle using OrientationMode.
436 int ConvertToAngle( Dali::Window::WindowOrientation orientation );
439 * @brief Convert from angle to window orientation using OrientationMode.
441 Dali::Window::WindowOrientation ConvertToOrientation( int angle ) const;
444 * @brief Check available window orientation for Available orientation.
446 bool IsOrientationAvailable( Dali::Window::WindowOrientation orientation ) const;
448 private: // Dali::Internal::Adaptor::SceneHolder
451 * @copydoc Dali::Internal::Adaptor::SceneHolder::OnAdaptorSet
453 void OnAdaptorSet( Dali::Adaptor& adaptor ) override;
456 * @copydoc Dali::Internal::Adaptor::SceneHolder::OnSurfaceSet
458 void OnSurfaceSet( Dali::RenderSurfaceInterface* surface ) override;
461 * @copydoc Dali::Internal::Adaptor::SceneHolder::OnPause
463 void OnPause() override;
466 * @copydoc Dali::Internal::Adaptor::SceneHolder::OnResume
468 void OnResume() override;
471 * @copydoc Dali::Internal::Adaptor::SceneHolder::RecalculateTouchPosition
473 void RecalculateTouchPosition( Integration::Point& point ) override;
475 private: // Dali::Internal::Adaptor::EventHandler::Observer
478 * @copydoc Dali::Internal::Adaptor::EventHandler::Observer::OnTouchPoint
480 void OnTouchPoint( Dali::Integration::Point& point, int timeStamp ) override;
483 * @copydoc Dali::Internal::Adaptor::EventHandler::Observer::OnWheelEvent
485 void OnWheelEvent( Dali::Integration::WheelEvent& wheelEvent ) override;
488 * @copydoc Dali::Internal::Adaptor::EventHandler::Observer::OnKeyEvent
490 void OnKeyEvent( Dali::Integration::KeyEvent& keyEvent ) override;
493 * @copydoc Dali::Internal::Adaptor::EventHandler::Observer::OnRotation
495 void OnRotation( const RotationEvent& rotation ) override;
500 * @copydoc Dali::Window::FocusChangeSignal()
502 FocusChangeSignalType& FocusChangeSignal() { return mFocusChangeSignal; }
504 * @copydoc Dali::Window::ResizedSignal()
506 ResizedSignalType& ResizedSignal() { return mResizedSignal; }
509 * @copydoc Dali::Window::ResizedSignal()
511 ResizeSignalType& ResizeSignal() { return mResizeSignal; }
514 * This signal is emitted when the window is requesting to be deleted
516 SignalType& DeleteRequestSignal() { return mDeleteRequestSignal; }
519 * @copydoc Dali::DevelWindow::VisibilityChangedSignal()
521 VisibilityChangedSignalType& VisibilityChangedSignal() { return mVisibilityChangedSignal; }
524 * @copydoc Dali::Window::SignalEventProcessingFinished()
526 Dali::DevelWindow::EventProcessingFinishedSignalType& EventProcessingFinishedSignal() { return mScene.EventProcessingFinishedSignal(); }
529 * @copydoc Dali::DevelWindow::TransitionEffectEventSignal()
531 TransitionEffectEventSignalType& TransitionEffectEventSignal() { return mTransitionEffectEventSignal; }
534 * @copydoc Dali::DevelWindow::KeyboardRepeatSettingsChangedSignal()
536 KeyboardRepeatSettingsChangedSignalType& KeyboardRepeatSettingsChangedSignal() { return mKeyboardRepeatSettingsChangedSignal; }
540 WindowRenderSurface* mWindowSurface; ///< The window rendering surface
541 WindowBase* mWindowBase;
543 std::string mClassName;
544 bool mIsTransparent:1;
545 bool mIsFocusAcceptable:1;
548 bool mResizeEnabled:1;
549 Dali::Window::Type mType;
550 Dali::Window mParentWindow;
552 OrientationPtr mOrientation;
553 std::vector< int > mAvailableAngles;
556 int mRotationAngle; ///< The angle of the rotation
557 int mWindowWidth; ///< The width of the window
558 int mWindowHeight; ///< The height of the window
560 EventHandlerPtr mEventHandler; ///< The window events handler
562 OrientationMode mOrientationMode;
564 int mNativeWindowId; ///< The Native Window Id
567 ResizedSignalType mResizedSignal;
568 SignalType mDeleteRequestSignal;
569 FocusChangeSignalType mFocusChangeSignal;
570 ResizeSignalType mResizeSignal;
571 VisibilityChangedSignalType mVisibilityChangedSignal;
572 TransitionEffectEventSignalType mTransitionEffectEventSignal;
573 KeyboardRepeatSettingsChangedSignalType mKeyboardRepeatSettingsChangedSignal;
576 } // namespace Adaptor
577 } // namepsace Internal
579 // Helpers for public-api forwarding methods
581 inline Internal::Adaptor::Window& GetImplementation(Dali::Window& window)
583 DALI_ASSERT_ALWAYS( window && "Window handle is empty" );
584 BaseObject& object = window.GetBaseObject();
585 return static_cast<Internal::Adaptor::Window&>(object);
588 inline const Internal::Adaptor::Window& GetImplementation(const Dali::Window& window)
590 DALI_ASSERT_ALWAYS( window && "Window handle is empty" );
591 const BaseObject& object = window.GetBaseObject();
592 return static_cast<const Internal::Adaptor::Window&>(object);
597 #endif // DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_IMPL_H