1 #ifndef DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_IMPL_H
2 #define DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_IMPL_H
5 * Copyright (c) 2023 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/actors/layer.h>
23 #include <dali/public-api/adaptor-framework/window-enumerations.h>
24 #include <dali/public-api/events/touch-event.h>
25 #include <dali/public-api/object/base-object.h>
26 #include <dali/public-api/object/property-array.h>
27 #include <dali/public-api/object/ref-object.h>
28 #include <dali/public-api/render-tasks/render-task-list.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 #include <dali/public-api/adaptor-framework/key-grab.h>
36 #include <dali/public-api/adaptor-framework/window.h>
42 class RenderSurfaceInterface;
49 class WindowRenderSurface;
53 using WindowPtr = IntrusivePtr<Window>;
54 using OrientationPtr = IntrusivePtr<Orientation>;
55 using EventHandlerPtr = IntrusivePtr<EventHandler>;
58 * Window provides a surface to render onto with orientation & indicator properties.
60 class Window : public Dali::Internal::Adaptor::SceneHolder, public EventHandler::Observer, public ConnectionTracker
63 typedef Dali::Window::FocusChangeSignalType FocusChangeSignalType;
64 typedef Dali::Window::ResizeSignalType ResizeSignalType;
65 typedef Dali::DevelWindow::VisibilityChangedSignalType VisibilityChangedSignalType;
66 typedef Dali::DevelWindow::TransitionEffectEventSignalType TransitionEffectEventSignalType;
67 typedef Dali::DevelWindow::KeyboardRepeatSettingsChangedSignalType KeyboardRepeatSettingsChangedSignalType;
68 typedef Dali::DevelWindow::AuxiliaryMessageSignalType AuxiliaryMessageSignalType;
69 typedef Dali::DevelWindow::AccessibilityHighlightSignalType AccessibilityHighlightSignalType;
70 typedef Dali::DevelWindow::MovedSignalType MovedSignalType;
71 typedef Dali::DevelWindow::OrientationChangedSignalType OrientationChangedSignalType;
72 typedef Signal<void()> SignalType;
75 * @brief Create a new Window. This should only be called once by the Application class
76 * @param[in] positionSize The position and size of the window
77 * @param[in] name The window title
78 * @param[in] className The window class name
79 * @param[in] type Window type.
80 * @param[in] isTransparent Whether window is transparent
81 * @return A newly allocated Window
83 static Window* New(const PositionSize& positionSize, const std::string& name, const std::string& className, Dali::WindowType type, bool isTransparent = false);
86 * @brief Create a new Window. This should only be called once by the Application class
87 * @param[in] surface The surface used to render on.
88 * @param[in] positionSize The position and size of the window
89 * @param[in] name The window title
90 * @param[in] className The window class name
91 * @param[in] type Window type.
92 * @param[in] isTransparent Whether window is transparent
93 * @return A newly allocated Window
95 static Window* New(Any surface, const PositionSize& positionSize, const std::string& name, const std::string& className, Dali::WindowType type, bool isTransparent = false);
98 * @copydoc Dali::Window::SetClass()
100 void SetClass(std::string name, std::string className);
103 * @brief Gets the window class name.
104 * @return The class of the window
106 std::string GetClassName() const;
109 * @copydoc Dali::Window::Raise()
114 * @copydoc Dali::Window::Lower()
119 * @copydoc Dali::Window::Activate()
124 * @copydoc Dali::DevelWindow::Maximize()
126 void Maximize(bool maximize);
129 * @copydoc Dali::DevelWindow::IsMaximized()
131 bool IsMaximized() const;
134 * @copydoc Dali::DevelWindow::SetMaximumSize()
136 void SetMaximumSize(Dali::Window::WindowSize size);
139 * @copydoc Dali::DevelWindow::Minimize()
141 void Minimize(bool minimize);
144 * @copydoc Dali::DevelWindow::IsMinimized()
146 bool IsMinimized() const;
149 * @copydoc Dali::DevelWindow::SetMimimumSize()
151 void SetMimimumSize(Dali::Window::WindowSize size);
154 * @copydoc Dali::Window::GetLayerCount()
156 uint32_t GetLayerCount() const;
159 * @copydoc Dali::Window::GetLayer()
161 Dali::Layer GetLayer(uint32_t depth) const;
164 * @copydoc Dali::DevelWindow::GetRenderTaskList()
166 Dali::RenderTaskList GetRenderTaskList() const;
169 * @brief Get window resource ID assigned by window manager
170 * @return The resource ID of the window
172 std::string GetNativeResourceId() const;
175 * @copydoc Dali::Window::AddAvailableOrientation()
177 void AddAvailableOrientation(WindowOrientation orientation);
180 * @copydoc Dali::Window::RemoveAvailableOrientation()
182 void RemoveAvailableOrientation(WindowOrientation orientation);
185 * @copydoc Dali::Window::SetPreferredOrientation()
187 void SetPreferredOrientation(WindowOrientation orientation);
190 * @copydoc Dali::Window::GetPreferredOrientation()
192 WindowOrientation GetPreferredOrientation();
195 * @copydoc Dali::Window::SetAcceptFocus()
197 void SetAcceptFocus(bool accept);
200 * @copydoc Dali::Window::IsFocusAcceptable()
202 bool IsFocusAcceptable() const;
205 * @copydoc Dali::Window::Show()
210 * @copydoc Dali::Window::Hide()
215 * @copydoc Dali::Window::GetSupportedAuxiliaryHintCount()
217 unsigned int GetSupportedAuxiliaryHintCount() const;
220 * @copydoc Dali::Window::GetSupportedAuxiliaryHint()
222 std::string GetSupportedAuxiliaryHint(unsigned int index) const;
225 * @copydoc Dali::Window::AddAuxiliaryHint()
227 unsigned int AddAuxiliaryHint(const std::string& hint, const std::string& value);
230 * @copydoc Dali::Window::RemoveAuxiliaryHint()
232 bool RemoveAuxiliaryHint(unsigned int id);
235 * @copydoc Dali::Window::SetAuxiliaryHintValue()
237 bool SetAuxiliaryHintValue(unsigned int id, const std::string& value);
240 * @copydoc Dali::Window::GetAuxiliaryHintValue()
242 std::string GetAuxiliaryHintValue(unsigned int id) const;
245 * @copydoc Dali::Window::GetAuxiliaryHintId()
247 unsigned int GetAuxiliaryHintId(const std::string& hint) const;
250 * @copydoc Dali::Window::SetInputRegion()
252 void SetInputRegion(const Rect<int>& inputRegion);
255 * @copydoc Dali::Window::SetType()
257 void SetType(WindowType type);
260 * @copydoc Dali::Window::GetType() const
262 WindowType GetType() const;
265 * @copydoc Dali::Window::SetNotificationLevel()
267 WindowOperationResult SetNotificationLevel(WindowNotificationLevel level);
270 * @copydoc Dali::Window::GetNotificationLevel()
272 WindowNotificationLevel GetNotificationLevel() const;
275 * @copydoc Dali::Window::SetOpaqueState()
277 void SetOpaqueState(bool opaque);
280 * @copydoc Dali::Window::IsOpaqueState()
282 bool IsOpaqueState() const;
285 * @copydoc Dali::Window::SetScreenOffMode()
287 WindowOperationResult SetScreenOffMode(WindowScreenOffMode screenOffMode);
290 * @copydoc Dali::Window::GetScreenOffMode()
292 WindowScreenOffMode GetScreenOffMode() const;
295 * @copydoc Dali::Window::SetBrightness()
297 WindowOperationResult SetBrightness(int brightness);
300 * @copydoc Dali::Window::GetBrightness()
302 int GetBrightness() const;
305 * @copydoc Dali::Window::SetSize()
307 void SetSize(Dali::Window::WindowSize size);
310 * @copydoc Dali::Window::GetSize()
312 Dali::Window::WindowSize GetSize() const;
315 * @copydoc Dali::Window::SetPosition()
317 void SetPosition(Dali::Window::WindowPosition position);
320 * @copydoc Dali::Window::GetPosition()
322 Dali::Window::WindowPosition GetPosition() const;
325 * @copydoc Dali::DevelWindow::SetPositionSize()
327 void SetPositionSize(PositionSize positionSize);
330 * @copydoc Dali::DevelWindow::GetPositionSize()
332 PositionSize GetPositionSize() const;
335 * @copydoc Dali::Window::SetLayout()
337 void SetLayout(unsigned int numCols, unsigned int numRows, unsigned int column, unsigned int row, unsigned int colSpan, unsigned int rowSpan);
340 * @copydoc Dali::Window::GetRootLayer()
342 Dali::Layer GetRootLayer() const;
345 * @copydoc Dali::Window::SetTransparency()
347 void SetTransparency(bool transparent);
350 * @copydoc Dali::KeyGrab::GrabKey()
352 bool GrabKey(Dali::KEY key, KeyGrab::KeyGrabMode grabMode);
355 * @copydoc Dali::KeyGrab::UngrabKey()
357 bool UngrabKey(Dali::KEY key);
360 * @copydoc Dali::KeyGrab::GrabKeyList()
362 bool GrabKeyList(const Dali::Vector<Dali::KEY>& key, const Dali::Vector<KeyGrab::KeyGrabMode>& grabMode, Dali::Vector<bool>& result);
365 * @copydoc Dali::KeyGrab::UngrabKeyList()
367 bool UngrabKeyList(const Dali::Vector<Dali::KEY>& key, Dali::Vector<bool>& result);
370 * @copydoc Dali::DevelWindow::Get()
372 static Dali::Window Get(Dali::Actor actor);
375 * @copydoc Dali::DevelWindow::SetParent(Window window, Window parent)
377 void SetParent(Dali::Window& parent);
380 * @copydoc Dali::DevelWindow::SetParent(Window window, Window parent, bool belowParent)
382 void SetParent(Dali::Window& parent, bool belowParent);
385 * @copydoc Dali::DevelWindow::Unparent()
390 * @copydoc Dali::DevelWindow::GetParent()
392 Dali::Window GetParent();
395 * @copydoc Dali::DevelWindow::GetCurrentOrientation()
397 WindowOrientation GetCurrentOrientation() const;
400 * @copydoc Dali::DevelWindow::GetPhysicalOrientation()
402 int GetPhysicalOrientation() const;
405 * @copydoc Dali::DevelWindow::SetAvailableOrientations()
407 void SetAvailableOrientations(const Dali::Vector<WindowOrientation>& orientations);
410 * @copydoc Dali::DevelWindow::SetPositionSizeWithOrientation()
412 void SetPositionSizeWithOrientation(PositionSize positionSize, WindowOrientation orientation);
415 * @brief Emit the accessibility highlight signal.
416 * The highlight indicates that it is an object to interact with the user regardless of focus.
417 * After setting the highlight on the object, you can do things that the object can do, such as
418 * giving or losing focus.
420 * @param[in] highlight If window needs to grab or clear highlight.
422 void EmitAccessibilityHighlightSignal(bool highlight);
425 * @brief Sets the render notification trigger to call when render thread is completed a frame
427 * @param[in] renderNotification to use
429 void SetRenderNotification(TriggerEventInterface *renderNotification);
431 public: // Dali::Internal::Adaptor::SceneHolder
433 * @copydoc Dali::Internal::Adaptor::SceneHolder::GetNativeHandle
435 Dali::Any GetNativeHandle() const override;
438 * @copydoc Dali::Internal::Adaptor::SceneHolder::IsVisible
440 bool IsVisible() const override;
443 * @copydoc Dali::DevelWindow::GetNativeId()
445 int32_t GetNativeId() const;
448 * @copydoc Dali::DevelWindow::RequestMoveToServer()
450 void RequestMoveToServer();
453 * @copydoc Dali::DevelWindow::RequestResizeToServer()
455 void RequestResizeToServer(WindowResizeDirection direction);
458 * @copydoc Dali::DevelWindow::EnableFloatingMode()
460 void EnableFloatingMode(bool enable);
463 * @copydoc Dali::DevelWindow::IncludeInputRegion()
465 void IncludeInputRegion(const Rect<int>& inputRegion);
468 * @copydoc Dali::DevelWindow::ExcludeInputRegion()
470 void ExcludeInputRegion(const Rect<int>& inputRegion);
473 * @copydoc Dali::DevelWindow::SetNeedsRotationCompletedAcknowledgement()
475 void SetNeedsRotationCompletedAcknowledgement(bool needAcknowledgement);
478 * @copydoc Dali::DevelWindow::SendRotationCompletedAcknowledgement()
480 void SendRotationCompletedAcknowledgement();
483 * @copydoc Dali::DevelWindow::IsWindowRotating()
485 bool IsWindowRotating() const;
488 * @copydoc Dali::DevelWindow::GetLastKeyEvent()
490 const Dali::KeyEvent& GetLastKeyEvent() const;
493 * @copydoc Dali::DevelWindow::GetLastTouchEvent()
495 const Dali::TouchEvent& GetLastTouchEvent() const;
499 * @brief Enumeration for orietation mode.
500 * The Orientation Mode is related to screen size.
501 * If screen width is longer than height, the Orientation Mode will have LANDSCAPE.
502 * Otherwise screen width is shorter than height or same, the Orientation Mode will have PORTRAIT.
504 enum class OrientationMode
511 * Private constructor.
522 * Second stage initialization
524 void Initialize(Any surface, const PositionSize& positionSize, const std::string& name, const std::string& className, WindowType type);
527 * Called when the window becomes iconified or deiconified.
529 void OnIconifyChanged(bool iconified);
532 * Called when the window becomes maximized or unmaximized.
534 void OnMaximizeChanged(bool maximized);
537 * Called when the window focus is changed.
539 void OnFocusChanged(bool focusIn);
542 * Called when the output is transformed.
544 void OnOutputTransformed();
547 * Called when the window receives a delete request.
549 void OnDeleteRequest();
552 * Called when the window receives a Transition effect-start/end event.
554 void OnTransitionEffectEvent(WindowEffectState state, WindowEffectType type);
557 * @brief Called when window receives a keyboard repeat event.
559 void OnKeyboardRepeatSettingsChanged();
562 * @brief Called when the window redraw is requested.
564 void OnWindowRedrawRequest();
567 * @brief Called when the window is resized or moved by display server.
569 * @param[in] positionSize the updated window's position and size.
571 void OnUpdatePositionSize(Dali::PositionSize& positionSize);
574 * @brief Called when display server sent the auxiliary message.
576 * @param[in] key the auxiliary message's key.
577 * @param[in] value the auxiliary message's value.
578 * @param[in] options the auxiliary message's options. This is the list of string.
580 void OnAuxiliaryMessage(const std::string& key, const std::string& value, const Property::Array& options);
583 * @brief Called when Accessibility is enabled.
585 * This method is to register the window to accessibility bridge.
587 void OnAccessibilityEnabled();
590 * @brief Called when Accessibility is disabled.
592 * This method is to remove the window from accessibility bridge.
594 void OnAccessibilityDisabled();
597 * Called when the window rotation is finished.
599 * This signal is emmit when window rotation is finisehd and WindowRotationCompleted() is called.
601 void OnRotationFinished();
604 * @brief Set available orientation to window base.
606 void SetAvailableAnlges(const std::vector<int>& angles);
609 * @brief Convert from window orientation to angle using OrientationMode.
611 int ConvertToAngle(WindowOrientation orientation);
614 * @brief Convert from angle to window orientation using OrientationMode.
616 WindowOrientation ConvertToOrientation(int angle) const;
619 * @brief Check available window orientation for Available orientation.
621 bool IsOrientationAvailable(WindowOrientation orientation) const;
624 * @brief Return the rect value to recalulate with the default system coordinates.
626 * Some native window APIs work the geometry value based on the default system coordinates.
627 * IncludeInputRegion() and ExcludeInputRegion() are one of them.
628 * When the window is rotated, current window's geometry already were set with the rotated angle.
629 * If IncludeInputRegion() or ExcludeInputRegion() are called with rotated angle by application,
630 * the rect's area should be re-calcuated on the default system coordinates.
632 * @param[in] rect the window's current position and size with current window rotation angle.
633 * @return the re-calculated rect on the default system coordinates.
635 Rect<int> RecalculateRect(const Rect<int>& rect);
637 private: // Dali::Internal::Adaptor::SceneHolder
639 * @copydoc Dali::Internal::Adaptor::SceneHolder::OnAdaptorSet
641 void OnAdaptorSet(Dali::Adaptor& adaptor) override;
644 * @copydoc Dali::Internal::Adaptor::SceneHolder::OnSurfaceSet
646 void OnSurfaceSet(Dali::RenderSurfaceInterface* surface) override;
649 * @copydoc Dali::Internal::Adaptor::SceneHolder::OnPause
651 void OnPause() override;
654 * @copydoc Dali::Internal::Adaptor::SceneHolder::OnResume
656 void OnResume() override;
659 * @copydoc Dali::Internal::Adaptor::SceneHolder::RecalculatePosition
661 Vector2 RecalculatePosition(const Vector2& position) override;
663 private: // Dali::Internal::Adaptor::EventHandler::Observer
665 * @copydoc Dali::Internal::Adaptor::EventHandler::Observer::OnTouchPoint
667 void OnTouchPoint(Dali::Integration::Point& point, int timeStamp) override;
670 * @copydoc Dali::Internal::Adaptor::EventHandler::Observer::OnWheelEvent
672 void OnWheelEvent(Dali::Integration::WheelEvent& wheelEvent) override;
675 * @copydoc Dali::Internal::Adaptor::EventHandler::Observer::OnKeyEvent
677 void OnKeyEvent(Dali::Integration::KeyEvent& keyEvent) override;
680 * @copydoc Dali::Internal::Adaptor::EventHandler::Observer::OnRotation
682 void OnRotation(const RotationEvent& rotation) override;
686 * @copydoc Dali::Window::FocusChangeSignal()
688 FocusChangeSignalType& FocusChangeSignal()
690 return mFocusChangeSignal;
694 * @copydoc Dali::Window::ResizedSignal()
696 ResizeSignalType& ResizeSignal()
698 return mResizeSignal;
702 * This signal is emitted when the window is requesting to be deleted
704 SignalType& DeleteRequestSignal()
706 return mDeleteRequestSignal;
710 * @copydoc Dali::DevelWindow::VisibilityChangedSignal()
712 VisibilityChangedSignalType& VisibilityChangedSignal()
714 return mVisibilityChangedSignal;
718 * @copydoc Dali::Window::SignalEventProcessingFinished()
720 Dali::DevelWindow::EventProcessingFinishedSignalType& EventProcessingFinishedSignal()
722 return mScene.EventProcessingFinishedSignal();
726 * @copydoc Dali::DevelWindow::TransitionEffectEventSignal()
728 TransitionEffectEventSignalType& TransitionEffectEventSignal()
730 return mTransitionEffectEventSignal;
734 * @copydoc Dali::DevelWindow::KeyboardRepeatSettingsChangedSignal()
736 KeyboardRepeatSettingsChangedSignalType& KeyboardRepeatSettingsChangedSignal()
738 return mKeyboardRepeatSettingsChangedSignal;
742 * @copydoc Dali::DevelWindow::AuxiliaryMessageSignal()
744 AuxiliaryMessageSignalType& AuxiliaryMessageSignal()
746 return mAuxiliaryMessageSignal;
750 * @copydoc Dali::DevelWindow::AccessibilityHighlightSignal()
752 AccessibilityHighlightSignalType& AccessibilityHighlightSignal()
754 return mAccessibilityHighlightSignal;
758 * @copydoc Dali::DevelWindow::MovedSignal()
760 MovedSignalType& MovedSignal()
766 * @copydoc Dali::DevelWindow::OrientationChangedSignal()
768 OrientationChangedSignalType& OrientationChangedSignal()
770 return mOrientationChangedSignal;
774 WindowRenderSurface* mWindowSurface; ///< The window rendering surface
775 WindowBase* mWindowBase;
777 std::string mClassName;
778 Dali::Window mParentWindow;
780 OrientationPtr mOrientation;
781 std::vector<int> mAvailableAngles;
784 int mRotationAngle; ///< The angle of the rotation
785 int mWindowWidth; ///< The width of the window
786 int mWindowHeight; ///< The height of the window
787 int mNativeWindowId; ///< The Native Window Id
789 EventHandlerPtr mEventHandler; ///< The window events handler
790 OrientationMode mOrientationMode; ///< The physical screen mode is portrait or landscape
793 SignalType mDeleteRequestSignal;
794 FocusChangeSignalType mFocusChangeSignal;
795 ResizeSignalType mResizeSignal;
796 VisibilityChangedSignalType mVisibilityChangedSignal;
797 TransitionEffectEventSignalType mTransitionEffectEventSignal;
798 KeyboardRepeatSettingsChangedSignalType mKeyboardRepeatSettingsChangedSignal;
799 AuxiliaryMessageSignalType mAuxiliaryMessageSignal;
800 AccessibilityHighlightSignalType mAccessibilityHighlightSignal;
801 MovedSignalType mMovedSignal;
802 OrientationChangedSignalType mOrientationChangedSignal;
804 Dali::KeyEvent mLastKeyEvent;
805 Dali::TouchEvent mLastTouchEvent;
807 bool mIsTransparent : 1;
808 bool mIsFocusAcceptable : 1;
811 bool mOpaqueState : 1;
812 bool mWindowRotationAcknowledgement : 1;
814 bool mIsWindowRotating : 1; ///< The window rotating flag.
817 } // namespace Adaptor
818 } // namespace Internal
820 // Helpers for public-api forwarding methods
822 inline Internal::Adaptor::Window& GetImplementation(Dali::Window& window)
824 DALI_ASSERT_ALWAYS(window && "Window handle is empty");
825 BaseObject& object = window.GetBaseObject();
826 return static_cast<Internal::Adaptor::Window&>(object);
829 inline const Internal::Adaptor::Window& GetImplementation(const Dali::Window& window)
831 DALI_ASSERT_ALWAYS(window && "Window handle is empty");
832 const BaseObject& object = window.GetBaseObject();
833 return static_cast<const Internal::Adaptor::Window&>(object);
838 #endif // DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_IMPL_H