1 #ifndef DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_BASE_H
2 #define DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_BASE_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/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/mouse-in-out-event.h>
31 #include <dali/devel-api/adaptor-framework/window-devel.h>
32 #include <dali/internal/graphics/gles/egl-implementation.h>
33 #include <dali/internal/window-system/common/damage-observer.h>
34 #include <dali/internal/window-system/common/rotation-event.h>
35 #include <dali/public-api/adaptor-framework/key-grab.h>
36 #include <dali/public-api/adaptor-framework/style-change.h>
37 #include <dali/public-api/adaptor-framework/window-enumerations.h>
38 #include <dali/public-api/adaptor-framework/window.h>
47 * WindowBase interface
53 * @brief Struct used to retrieve accessibility information
55 struct AccessibilityInfo
67 typedef Signal<void(bool)> IconifySignalType;
68 typedef Signal<void(bool)> FocusSignalType;
69 typedef Signal<void()> OutputSignalType;
70 typedef Signal<void()> DeleteSignalType;
71 typedef Signal<void(const DamageArea&)> DamageSignalType;
72 typedef Signal<void(const RotationEvent&)> RotationSignalType;
73 typedef Signal<void(WindowEffectState, WindowEffectType)> TransitionEffectEventSignalType;
74 typedef Signal<void()> KeyboardRepeatSettingsChangedSignalType;
75 typedef Signal<void()> WindowRedrawRequestSignalType;
76 typedef Signal<void(Dali::PositionSize&)> UpdatePositionSizeType;
77 typedef Signal<void(const std::string&, const std::string&, const Property::Array&)> AuxiliaryMessageSignalType;
78 typedef Signal<void(const Dali::DevelWindow::MouseInOutEvent&)> MouseInOutEventSignalType;
79 typedef Signal<void(Dali::Int32Pair&)> MoveCompletedSignalType;
80 typedef Signal<void(Dali::Uint16Pair&)> ResizeCompletedSignalType;
83 typedef Signal<void(Integration::Point&, uint32_t)> TouchEventSignalType;
84 typedef Signal<void(Integration::WheelEvent&)> WheelEventSignalType;
85 typedef Signal<void(Integration::KeyEvent&)> KeyEventSignalType;
88 typedef Signal<void(void*)> SelectionSignalType;
91 typedef Signal<void(StyleChange::Type)> StyleSignalType;
94 * @brief Default constructor
101 virtual ~WindowBase();
105 * @brief Get the native window handle
106 * @return The native window handle
108 virtual Any GetNativeWindow() = 0;
111 * @brief Get the native window id
112 * @return The native window id
114 virtual int GetNativeWindowId() = 0;
117 * @brief Get the native window resource id assinged by window manager
118 * @return The native window resource id
120 virtual std::string GetNativeWindowResourceId() = 0;
123 * @brief Create the egl window
125 virtual EGLNativeWindowType CreateEglWindow(int width, int height) = 0;
128 * @brief Destroy the egl window
130 virtual void DestroyEglWindow() = 0;
133 * @brief Set the egl window rotation
135 virtual void SetEglWindowRotation(int angle) = 0;
138 * @brief Set the egl window buffer transform
140 virtual void SetEglWindowBufferTransform(int angle) = 0;
143 * @brief Set the egl window transform
145 virtual void SetEglWindowTransform(int angle) = 0;
148 * @brief Resize the egl window
150 virtual void ResizeEglWindow(Dali::PositionSize positionSize) = 0;
153 * @brief Returns whether the egl window support rotation or not
155 virtual bool IsEglWindowRotationSupported() = 0;
158 * @brief Move the window
160 virtual void Move(Dali::PositionSize positionSize) = 0;
163 * @brief Resize the window
165 virtual void Resize(Dali::PositionSize positionSize) = 0;
168 * @brief Move and resize the window
170 virtual void MoveResize(Dali::PositionSize positionSize) = 0;
173 * @copydoc Dali::Window::SetLayout()
175 virtual void SetLayout(unsigned int numCols, unsigned int numRows, unsigned int column, unsigned int row, unsigned int colSpan, unsigned int rowSpan) = 0;
178 * @copydoc Dali::Window::SetClass()
180 virtual void SetClass(const std::string& name, const std::string& className) = 0;
183 * @copydoc Dali::Window::Raise()
185 virtual void Raise() = 0;
188 * @copydoc Dali::Window::Lower()
190 virtual void Lower() = 0;
193 * @copydoc Dali::Window::Activate()
195 virtual void Activate() = 0;
198 * @copydoc Dali::DevelWindow::Maximize()
200 virtual void Maximize(bool maximize) = 0;
203 * @copydoc Dali::DevelWindow::IsMaximized()
205 virtual bool IsMaximized() const = 0;
208 * @copydoc Dali::DevelWindow::SetMaximumSize()
210 virtual void SetMaximumSize(Dali::Window::WindowSize size) = 0;
213 * @copydoc Dali::DevelWindow::Minimize()
215 virtual void Minimize(bool minimize) = 0;
218 * @copydoc Dali::DevelWindow::IsMinimized()
220 virtual bool IsMinimized() const = 0;
223 * @copydoc Dali::DevelWindow::SetMimimumSize()
225 virtual void SetMimimumSize(Dali::Window::WindowSize size) = 0;
228 * @copydoc Dali::Window::SetAvailableOrientations()
230 virtual void SetAvailableAnlges(const std::vector<int>& angles) = 0;
233 * @copydoc Dali::Window::SetPreferredOrientation()
235 virtual void SetPreferredAngle(int angle) = 0;
238 * @copydoc Dali::Window::SetAcceptFocus()
240 virtual void SetAcceptFocus(bool accept) = 0;
243 * @copydoc Dali::Window::Show()
245 virtual void Show() = 0;
248 * @copydoc Dali::Window::Hide()
250 virtual void Hide() = 0;
253 * @copydoc Dali::Window::GetSupportedAuxiliaryHintCount()
255 virtual unsigned int GetSupportedAuxiliaryHintCount() const = 0;
258 * @copydoc Dali::Window::GetSupportedAuxiliaryHint()
260 virtual std::string GetSupportedAuxiliaryHint(unsigned int index) const = 0;
263 * @copydoc Dali::Window::AddAuxiliaryHint()
265 virtual unsigned int AddAuxiliaryHint(const std::string& hint, const std::string& value) = 0;
268 * @copydoc Dali::Window::RemoveAuxiliaryHint()
270 virtual bool RemoveAuxiliaryHint(unsigned int id) = 0;
273 * @copydoc Dali::Window::SetAuxiliaryHintValue()
275 virtual bool SetAuxiliaryHintValue(unsigned int id, const std::string& value) = 0;
278 * @copydoc Dali::Window::GetAuxiliaryHintValue()
280 virtual std::string GetAuxiliaryHintValue(unsigned int id) const = 0;
283 * @copydoc Dali::Window::GetAuxiliaryHintId()
285 virtual unsigned int GetAuxiliaryHintId(const std::string& hint) const = 0;
288 * @copydoc Dali::Window::SetInputRegion()
290 virtual void SetInputRegion(const Rect<int>& inputRegion) = 0;
293 * @copydoc Dali::Window::SetType()
295 virtual void SetType(Dali::WindowType type) = 0;
298 * @copydoc Dali::Window::GetType()
300 virtual Dali::WindowType GetType() const = 0;
303 * @copydoc Dali::Window::SetNotificationLevel()
305 virtual Dali::WindowOperationResult SetNotificationLevel(Dali::WindowNotificationLevel level) = 0;
308 * @copydoc Dali::Window::GetNotificationLevel()
310 virtual Dali::WindowNotificationLevel GetNotificationLevel() const = 0;
313 * @copydoc Dali::Window::SetOpaqueState()
315 virtual void SetOpaqueState(bool opaque) = 0;
318 * @copydoc Dali::Window::SetScreenOffMode()
320 virtual Dali::WindowOperationResult SetScreenOffMode(WindowScreenOffMode screenOffMode) = 0;
323 * @copydoc Dali::Window::GetScreenOffMode()
325 virtual WindowScreenOffMode GetScreenOffMode() const = 0;
328 * @copydoc Dali::Window::SetBrightness()
330 virtual Dali::WindowOperationResult SetBrightness(int brightness) = 0;
333 * @copydoc Dali::Window::GetBrightness()
335 virtual int GetBrightness() const = 0;
338 * @copydoc Dali::KeyGrab::GrabKey()
340 virtual bool GrabKey(Dali::KEY key, KeyGrab::KeyGrabMode grabMode) = 0;
343 * @copydoc Dali::KeyGrab::UngrabKey()
345 virtual bool UngrabKey(Dali::KEY key) = 0;
348 * @copydoc Dali::KeyGrab::GrabKeyList()
350 virtual bool GrabKeyList(const Dali::Vector<Dali::KEY>& key, const Dali::Vector<KeyGrab::KeyGrabMode>& grabMode, Dali::Vector<bool>& result) = 0;
353 * @copydoc Dali::KeyGrab::UngrabKeyList()
355 virtual bool UngrabKeyList(const Dali::Vector<Dali::KEY>& key, Dali::Vector<bool>& result) = 0;
359 * @param[out] dpiHorizontal set to the horizontal dpi
360 * @param[out] dpiVertical set to the vertical dpi
362 virtual void GetDpi(unsigned int& dpiHorizontal, unsigned int& dpiVertical) = 0;
365 * @brief Return the angle of the window's rotation.
366 * @return The window orientation
368 virtual int GetWindowRotationAngle() const = 0;
371 * @brief Get the angle of screen rotation for the window
372 * @return The screen orientation
374 virtual int GetScreenRotationAngle() = 0;
377 * @brief Set the screen rotation angle of the window
379 virtual void SetWindowRotationAngle(int degree) = 0;
382 * @brief Inform the window rotation is completed
384 virtual void WindowRotationCompleted(int degree, int width, int height) = 0;
387 * @brief starts the window is moved by display server
389 virtual void RequestMoveToServer() = 0;
392 * @brief starts the window is resized by display server
394 * @param[in] direction It is direction of the started edge/side.
396 virtual void RequestResizeToServer(WindowResizeDirection direction) = 0;
399 * @brief Enables the floating mode of window.
401 * The floating mode is to support making partial size window easliy.
402 * It is useful to make popup style window
403 * and this window is always upper than the other normal window.
405 * A special display server(as a Tizen display server) supports this mode.
407 * @param[in] enable Enable floating mode or not.
409 virtual void EnableFloatingMode(bool enable) = 0;
412 * @brief Gets whether floating mode is enabled or not.
414 virtual bool IsFloatingModeEnabled() const = 0;
417 * @copydoc Dali::Window::SetTransparency()
419 virtual void SetTransparency(bool transparent) = 0;
422 * @copydoc Dali::Window::SetParent()
424 virtual void SetParent(WindowBase* parentWinBase, bool belowParent) = 0;
427 * @brief Create a sync fence that can tell the frame is rendered by the graphics driver.
428 * @return The file descriptor that tells when it is rendered.
430 virtual int CreateFrameRenderedSyncFence() = 0;
433 * @brief Create a sync fence that can tell the frame is presented by the display server.
434 * @return The file descriptor that tells when it is presented.
436 virtual int CreateFramePresentedSyncFence() = 0;
439 * @copydoc Dali::Window::SetPositionSizeWithAngle()
441 virtual void SetPositionSizeWithAngle(PositionSize positionSize, int angle) = 0;
444 * @brief Initialize for Ime window.
445 * It should be called when the window is only used for Ime keyboard window.
447 virtual void InitializeIme() = 0;
450 * @brief Send the signal to display server for Ime Window is ready to render.
451 * It is used for compositing by display server.
453 virtual void ImeWindowReadyToRender() = 0;
456 * @brief Includes input region.
457 * @param[in] inputRegion The added region to accept input events.
459 virtual void IncludeInputRegion(const Rect<int>& inputRegion) = 0;
462 * @brief Excludes input region.
463 * @param[in] inputRegion The subtracted region to except input events.
465 virtual void ExcludeInputRegion(const Rect<int>& inputRegion) = 0;
470 * @brief This signal is emitted when the window becomes iconified or deiconified.
472 IconifySignalType& IconifyChangedSignal();
475 * @brief This signal is emitted when the window focus is changed.
477 FocusSignalType& FocusChangedSignal();
480 * @brief This signal is emitted when the output is transformed.
482 OutputSignalType& OutputTransformedSignal();
485 * @brief This signal is emitted when the window receives a delete request.
487 DeleteSignalType& DeleteRequestSignal();
490 * @brief This signal is emitted when the window is damaged.
492 DamageSignalType& WindowDamagedSignal();
495 * @brief This signal is emitted when a rotation event is recevied.
497 RotationSignalType& RotationSignal();
500 * @brief This signal is emitted when a touch event is received.
502 TouchEventSignalType& TouchEventSignal();
505 * @brief This signal is emitted when a mouse wheel is received.
507 WheelEventSignalType& WheelEventSignal();
510 * @brief This signal is emitted when a key event is received.
512 KeyEventSignalType& KeyEventSignal();
515 * @brief This signal is emitted when the source window notifies us the content in clipboard is selected.
517 SelectionSignalType& SelectionDataSendSignal();
520 * @brief This signal is emitted when the source window sends us about the selected content.
522 SelectionSignalType& SelectionDataReceivedSignal();
525 * @brief This signal is emitted when the style is changed.
527 StyleSignalType& StyleChangedSignal();
530 * @brief This signal is emitted when window's transition animation is started or ended.
532 TransitionEffectEventSignalType& TransitionEffectEventSignal();
535 * @brief This signal is emitted when the keyboard repeat is changed.
537 KeyboardRepeatSettingsChangedSignalType& KeyboardRepeatSettingsChangedSignal();
540 * @brief This signal is emitted when the window redraw is requested.
542 WindowRedrawRequestSignalType& WindowRedrawRequestSignal();
545 * @brief This signal is emitted when the window's geometry data is changed by display server or client.
546 * It is based on configure noification event.
548 UpdatePositionSizeType& UpdatePositionSizeSignal();
551 * @brief This signal is emitted when the window is received the auxiliary message from display server.
553 AuxiliaryMessageSignalType& AuxiliaryMessageSignal();
556 * @brief This signal is emitted when a mouse in or out event is recevied.
558 MouseInOutEventSignalType& MouseInOutEventSignal();
561 * @brief This signal is emitted when window has been moved by then display server.
562 * To be moved the window by display server, RequestMoveToServer() should be called.
563 * After the moving job is finished, this function will be called.
565 MoveCompletedSignalType& MoveCompletedSignal();
568 * @brief This signal is emitted when window has been resized by then display server.
569 * To be resized the window by display server, RequestResizeToServer() should be called.
570 * After the resizing job is finished, this function will be called.
572 ResizeCompletedSignalType& ResizeCompletedSignal();
576 WindowBase(const WindowBase&) = delete;
579 WindowBase& operator=(const WindowBase& rhs) = delete;
582 IconifySignalType mIconifyChangedSignal;
583 FocusSignalType mFocusChangedSignal;
584 OutputSignalType mOutputTransformedSignal;
585 DeleteSignalType mDeleteRequestSignal;
586 DamageSignalType mWindowDamagedSignal;
587 RotationSignalType mRotationSignal;
588 TouchEventSignalType mTouchEventSignal;
589 WheelEventSignalType mWheelEventSignal;
590 KeyEventSignalType mKeyEventSignal;
591 SelectionSignalType mSelectionDataSendSignal;
592 SelectionSignalType mSelectionDataReceivedSignal;
593 StyleSignalType mStyleChangedSignal;
594 TransitionEffectEventSignalType mTransitionEffectEventSignal;
595 KeyboardRepeatSettingsChangedSignalType mKeyboardRepeatSettingsChangedSignal;
596 WindowRedrawRequestSignalType mWindowRedrawRequestSignal;
597 UpdatePositionSizeType mUpdatePositionSizeSignal;
598 AuxiliaryMessageSignalType mAuxiliaryMessageSignal;
599 MouseInOutEventSignalType mMouseInOutEventSignal;
600 MoveCompletedSignalType mMoveCompletedSignal;
601 ResizeCompletedSignalType mResizeCompletedSignal;
604 } // namespace Adaptor
606 } // namespace Internal
610 #endif // DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_BASE_H