1 #ifndef DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_BASE_H
2 #define DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_BASE_H
5 * Copyright (c) 2022 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/integration-api/events/key-event-integ.h>
23 #include <dali/integration-api/events/point.h>
24 #include <dali/integration-api/events/wheel-event-integ.h>
30 #include <dali/devel-api/adaptor-framework/window-devel.h>
31 #include <dali/internal/graphics/gles/egl-implementation.h>
32 #include <dali/internal/window-system/common/damage-observer.h>
33 #include <dali/internal/window-system/common/rotation-event.h>
34 #include <dali/public-api/adaptor-framework/key-grab.h>
35 #include <dali/public-api/adaptor-framework/style-change.h>
36 #include <dali/public-api/adaptor-framework/window-enumerations.h>
37 #include <dali/public-api/adaptor-framework/window.h>
46 * WindowBase interface
52 * @brief Struct used to retrieve accessibility information
54 struct AccessibilityInfo
66 typedef Signal<void(bool)> IconifySignalType;
67 typedef Signal<void(bool)> FocusSignalType;
68 typedef Signal<void()> OutputSignalType;
69 typedef Signal<void()> DeleteSignalType;
70 typedef Signal<void(const DamageArea&)> DamageSignalType;
71 typedef Signal<void(const RotationEvent&)> RotationSignalType;
72 typedef Signal<void(WindowEffectState, WindowEffectType)> TransitionEffectEventSignalType;
73 typedef Signal<void()> KeyboardRepeatSettingsChangedSignalType;
74 typedef Signal<void()> WindowRedrawRequestSignalType;
75 typedef Signal<void(Dali::PositionSize&)> UpdatePositionSizeType;
76 typedef Signal<void(const std::string&, const std::string&, const Property::Array&)> AuxiliaryMessageSignalType;
79 typedef Signal<void(Integration::Point&, uint32_t)> TouchEventSignalType;
80 typedef Signal<void(Integration::WheelEvent&)> WheelEventSignalType;
81 typedef Signal<void(Integration::KeyEvent&)> KeyEventSignalType;
84 typedef Signal<void(void*)> SelectionSignalType;
87 typedef Signal<void(StyleChange::Type)> StyleSignalType;
88 typedef Signal<void(const AccessibilityInfo&)> AccessibilitySignalType;
91 * @brief Default constructor
98 virtual ~WindowBase();
102 * @brief Get the native window handle
103 * @return The native window handle
105 virtual Any GetNativeWindow() = 0;
108 * @brief Get the native window id
109 * @return The native window id
111 virtual int GetNativeWindowId() = 0;
114 * @brief Get the native window resource id assinged by window manager
115 * @return The native window resource id
117 virtual std::string GetNativeWindowResourceId() = 0;
120 * @brief Create the egl window
122 virtual EGLNativeWindowType CreateEglWindow(int width, int height) = 0;
125 * @brief Destroy the egl window
127 virtual void DestroyEglWindow() = 0;
130 * @brief Set the egl window rotation
132 virtual void SetEglWindowRotation(int angle) = 0;
135 * @brief Set the egl window buffer transform
137 virtual void SetEglWindowBufferTransform(int angle) = 0;
140 * @brief Set the egl window transform
142 virtual void SetEglWindowTransform(int angle) = 0;
145 * @brief Resize the egl window
147 virtual void ResizeEglWindow(Dali::PositionSize positionSize) = 0;
150 * @brief Returns whether the egl window support rotation or not
152 virtual bool IsEglWindowRotationSupported() = 0;
155 * @brief Move the window
157 virtual void Move(Dali::PositionSize positionSize) = 0;
160 * @brief Resize the window
162 virtual void Resize(Dali::PositionSize positionSize) = 0;
165 * @brief Move and resize the window
167 virtual void MoveResize(Dali::PositionSize positionSize) = 0;
170 * @copydoc Dali::Window::SetClass()
172 virtual void SetClass(const std::string& name, const std::string& className) = 0;
175 * @copydoc Dali::Window::Raise()
177 virtual void Raise() = 0;
180 * @copydoc Dali::Window::Lower()
182 virtual void Lower() = 0;
185 * @copydoc Dali::Window::Activate()
187 virtual void Activate() = 0;
190 * @copydoc Dali::DevelWindow::Maximize()
192 virtual void Maximize(bool maximize) = 0;
195 * @copydoc Dali::DevelWindow::IsMaximized()
197 virtual bool IsMaximized() const = 0;
200 * @copydoc Dali::DevelWindow::Minimize()
202 virtual void Minimize(bool minimize) = 0;
205 * @copydoc Dali::DevelWindow::IsMinimized()
207 virtual bool IsMinimized() const = 0;
210 * @copydoc Dali::Window::SetAvailableOrientations()
212 virtual void SetAvailableAnlges(const std::vector<int>& angles) = 0;
215 * @copydoc Dali::Window::SetPreferredOrientation()
217 virtual void SetPreferredAngle(int angle) = 0;
220 * @copydoc Dali::Window::SetAcceptFocus()
222 virtual void SetAcceptFocus(bool accept) = 0;
225 * @copydoc Dali::Window::Show()
227 virtual void Show() = 0;
230 * @copydoc Dali::Window::Hide()
232 virtual void Hide() = 0;
235 * @copydoc Dali::Window::GetSupportedAuxiliaryHintCount()
237 virtual unsigned int GetSupportedAuxiliaryHintCount() const = 0;
240 * @copydoc Dali::Window::GetSupportedAuxiliaryHint()
242 virtual std::string GetSupportedAuxiliaryHint(unsigned int index) const = 0;
245 * @copydoc Dali::Window::AddAuxiliaryHint()
247 virtual unsigned int AddAuxiliaryHint(const std::string& hint, const std::string& value) = 0;
250 * @copydoc Dali::Window::RemoveAuxiliaryHint()
252 virtual bool RemoveAuxiliaryHint(unsigned int id) = 0;
255 * @copydoc Dali::Window::SetAuxiliaryHintValue()
257 virtual bool SetAuxiliaryHintValue(unsigned int id, const std::string& value) = 0;
260 * @copydoc Dali::Window::GetAuxiliaryHintValue()
262 virtual std::string GetAuxiliaryHintValue(unsigned int id) const = 0;
265 * @copydoc Dali::Window::GetAuxiliaryHintId()
267 virtual unsigned int GetAuxiliaryHintId(const std::string& hint) const = 0;
270 * @copydoc Dali::Window::SetInputRegion()
272 virtual void SetInputRegion(const Rect<int>& inputRegion) = 0;
275 * @copydoc Dali::Window::SetType()
277 virtual void SetType(Dali::WindowType type) = 0;
280 * @copydoc Dali::Window::GetType()
282 virtual Dali::WindowType GetType() const = 0;
285 * @copydoc Dali::Window::SetNotificationLevel()
287 virtual Dali::WindowOperationResult SetNotificationLevel(Dali::WindowNotificationLevel level) = 0;
290 * @copydoc Dali::Window::GetNotificationLevel()
292 virtual Dali::WindowNotificationLevel GetNotificationLevel() const = 0;
295 * @copydoc Dali::Window::SetOpaqueState()
297 virtual void SetOpaqueState(bool opaque) = 0;
300 * @copydoc Dali::Window::SetScreenOffMode()
302 virtual Dali::WindowOperationResult SetScreenOffMode(WindowScreenOffMode screenOffMode) = 0;
305 * @copydoc Dali::Window::GetScreenOffMode()
307 virtual WindowScreenOffMode GetScreenOffMode() const = 0;
310 * @copydoc Dali::Window::SetBrightness()
312 virtual Dali::WindowOperationResult SetBrightness(int brightness) = 0;
315 * @copydoc Dali::Window::GetBrightness()
317 virtual int GetBrightness() const = 0;
320 * @copydoc Dali::KeyGrab::GrabKey()
322 virtual bool GrabKey(Dali::KEY key, KeyGrab::KeyGrabMode grabMode) = 0;
325 * @copydoc Dali::KeyGrab::UngrabKey()
327 virtual bool UngrabKey(Dali::KEY key) = 0;
330 * @copydoc Dali::KeyGrab::GrabKeyList()
332 virtual bool GrabKeyList(const Dali::Vector<Dali::KEY>& key, const Dali::Vector<KeyGrab::KeyGrabMode>& grabMode, Dali::Vector<bool>& result) = 0;
335 * @copydoc Dali::KeyGrab::UngrabKeyList()
337 virtual bool UngrabKeyList(const Dali::Vector<Dali::KEY>& key, Dali::Vector<bool>& result) = 0;
341 * @param[out] dpiHorizontal set to the horizontal dpi
342 * @param[out] dpiVertical set to the vertical dpi
344 virtual void GetDpi(unsigned int& dpiHorizontal, unsigned int& dpiVertical) = 0;
347 * @brief Return the orientation of the surface.
348 * @return The orientation
350 virtual int GetOrientation() const = 0;
353 * @brief Get the screen rotation angle of the window
355 virtual int GetScreenRotationAngle() = 0;
358 * @brief Set the rotation angle of the window
360 virtual void SetWindowRotationAngle(int degree) = 0;
363 * @brief Inform the window rotation is completed
365 virtual void WindowRotationCompleted(int degree, int width, int height) = 0;
368 * @brief starts the window is moved by display server
370 virtual void RequestMoveToServer() = 0;
373 * @brief starts the window is resized by display server
375 * @param[in] direction It is direction of the started edge/side.
377 virtual void RequestResizeToServer(WindowResizeDirection direction) = 0;
380 * @brief Enables the floating mode of window.
382 * The floating mode is to support making partial size window easliy.
383 * It is useful to make popup style window
384 * and this window is always upper than the other normal window.
386 * A special display server(as a Tizen display server) supports this mode.
388 * @param[in] enable Enable floating mode or not.
390 virtual void EnableFloatingMode(bool enable) = 0;
393 * @brief Gets whether floating mode is enabled or not.
395 virtual bool IsFloatingModeEnabled() const = 0;
398 * @copydoc Dali::Window::SetTransparency()
400 virtual void SetTransparency(bool transparent) = 0;
403 * @copydoc Dali::Window::SetParent()
405 virtual void SetParent(WindowBase* parentWinBase, bool belowParent) = 0;
408 * @brief Create a sync fence that can tell the frame is rendered by the graphics driver.
409 * @return The file descriptor that tells when it is rendered.
411 virtual int CreateFrameRenderedSyncFence() = 0;
414 * @brief Create a sync fence that can tell the frame is presented by the display server.
415 * @return The file descriptor that tells when it is presented.
417 virtual int CreateFramePresentedSyncFence() = 0;
420 * @copydoc Dali::Window::SetPositionSizeWithAngle()
422 virtual void SetPositionSizeWithAngle(PositionSize positionSize, int angle) = 0;
425 * @brief Initialize for Ime window.
426 * It should be called when the window is only used for Ime keyboard window.
428 virtual void InitializeIme() = 0;
431 * @brief Send the signal to display server for Ime Window is ready to render.
432 * It is used for compositing by display server.
434 virtual void ImeWindowReadyToRender() = 0;
437 * @brief Includes input region.
438 * @param[in] inputRegion The added region to accept input events.
440 virtual void IncludeInputRegion(const Rect<int>& inputRegion) = 0;
443 * @brief Excludes input region.
444 * @param[in] inputRegion The subtracted region to except input events.
446 virtual void ExcludeInputRegion(const Rect<int>& inputRegion) = 0;
451 * @brief This signal is emitted when the window becomes iconified or deiconified.
453 IconifySignalType& IconifyChangedSignal();
456 * @brief This signal is emitted when the window focus is changed.
458 FocusSignalType& FocusChangedSignal();
461 * @brief This signal is emitted when the output is transformed.
463 OutputSignalType& OutputTransformedSignal();
466 * @brief This signal is emitted when the window receives a delete request.
468 DeleteSignalType& DeleteRequestSignal();
471 * @brief This signal is emitted when the window is damaged.
473 DamageSignalType& WindowDamagedSignal();
476 * @brief This signal is emitted when a rotation event is recevied.
478 RotationSignalType& RotationSignal();
481 * @brief This signal is emitted when a touch event is received.
483 TouchEventSignalType& TouchEventSignal();
486 * @brief This signal is emitted when a mouse wheel is received.
488 WheelEventSignalType& WheelEventSignal();
491 * @brief This signal is emitted when a key event is received.
493 KeyEventSignalType& KeyEventSignal();
496 * @brief This signal is emitted when the source window notifies us the content in clipboard is selected.
498 SelectionSignalType& SelectionDataSendSignal();
501 * @brief This signal is emitted when the source window sends us about the selected content.
503 SelectionSignalType& SelectionDataReceivedSignal();
506 * @brief This signal is emitted when the style is changed.
508 StyleSignalType& StyleChangedSignal();
511 * @brief This signal is emitted when an accessibility event is received.
513 AccessibilitySignalType& AccessibilitySignal();
516 * @brief This signal is emitted when window's transition animation is started or ended.
518 TransitionEffectEventSignalType& TransitionEffectEventSignal();
521 * @brief This signal is emitted when the keyboard repeat is changed.
523 KeyboardRepeatSettingsChangedSignalType& KeyboardRepeatSettingsChangedSignal();
526 * @brief This signal is emitted when the window redraw is requested.
528 WindowRedrawRequestSignalType& WindowRedrawRequestSignal();
531 * @brief This signal is emitted when the window is resized or moved by display server.
533 UpdatePositionSizeType& UpdatePositionSizeSignal();
536 * @brief This signal is emitted when the window is received the auxiliary message from display server.
538 AuxiliaryMessageSignalType& AuxiliaryMessageSignal();
542 WindowBase(const WindowBase&) = delete;
545 WindowBase& operator=(const WindowBase& rhs) = delete;
548 IconifySignalType mIconifyChangedSignal;
549 FocusSignalType mFocusChangedSignal;
550 OutputSignalType mOutputTransformedSignal;
551 DeleteSignalType mDeleteRequestSignal;
552 DamageSignalType mWindowDamagedSignal;
553 RotationSignalType mRotationSignal;
554 TouchEventSignalType mTouchEventSignal;
555 WheelEventSignalType mWheelEventSignal;
556 KeyEventSignalType mKeyEventSignal;
557 SelectionSignalType mSelectionDataSendSignal;
558 SelectionSignalType mSelectionDataReceivedSignal;
559 StyleSignalType mStyleChangedSignal;
560 AccessibilitySignalType mAccessibilitySignal;
561 TransitionEffectEventSignalType mTransitionEffectEventSignal;
562 KeyboardRepeatSettingsChangedSignalType mKeyboardRepeatSettingsChangedSignal;
563 WindowRedrawRequestSignalType mWindowRedrawRequestSignal;
564 UpdatePositionSizeType mUpdatePositionSizeSignal;
565 AuxiliaryMessageSignalType mAuxiliaryMessageSignal;
568 } // namespace Adaptor
570 } // namespace Internal
574 #endif // DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_BASE_H