1 #ifndef DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_BASE_H
2 #define DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_BASE_H
5 * Copyright (c) 2021 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 Create the egl window
116 virtual EGLNativeWindowType CreateEglWindow(int width, int height) = 0;
119 * @brief Destroy the egl window
121 virtual void DestroyEglWindow() = 0;
124 * @brief Set the egl window rotation
126 virtual void SetEglWindowRotation(int angle) = 0;
129 * @brief Set the egl window buffer transform
131 virtual void SetEglWindowBufferTransform(int angle) = 0;
134 * @brief Set the egl window transform
136 virtual void SetEglWindowTransform(int angle) = 0;
139 * @brief Resize the egl window
141 virtual void ResizeEglWindow(Dali::PositionSize positionSize) = 0;
144 * @brief Returns whether the egl window support rotation or not
146 virtual bool IsEglWindowRotationSupported() = 0;
149 * @brief Move the window
151 virtual void Move(Dali::PositionSize positionSize) = 0;
154 * @brief Resize the window
156 virtual void Resize(Dali::PositionSize positionSize) = 0;
159 * @brief Move and resize the window
161 virtual void MoveResize(Dali::PositionSize positionSize) = 0;
164 * @copydoc Dali::Window::SetClass()
166 virtual void SetClass(const std::string& name, const std::string& className) = 0;
169 * @copydoc Dali::Window::Raise()
171 virtual void Raise() = 0;
174 * @copydoc Dali::Window::Lower()
176 virtual void Lower() = 0;
179 * @copydoc Dali::Window::Activate()
181 virtual void Activate() = 0;
184 * @copydoc Dali::Window::SetAvailableOrientations()
186 virtual void SetAvailableAnlges(const std::vector<int>& angles) = 0;
189 * @copydoc Dali::Window::SetPreferredOrientation()
191 virtual void SetPreferredAngle(int angle) = 0;
194 * @copydoc Dali::Window::SetAcceptFocus()
196 virtual void SetAcceptFocus(bool accept) = 0;
199 * @copydoc Dali::Window::Show()
201 virtual void Show() = 0;
204 * @copydoc Dali::Window::Hide()
206 virtual void Hide() = 0;
209 * @copydoc Dali::Window::GetSupportedAuxiliaryHintCount()
211 virtual unsigned int GetSupportedAuxiliaryHintCount() const = 0;
214 * @copydoc Dali::Window::GetSupportedAuxiliaryHint()
216 virtual std::string GetSupportedAuxiliaryHint(unsigned int index) const = 0;
219 * @copydoc Dali::Window::AddAuxiliaryHint()
221 virtual unsigned int AddAuxiliaryHint(const std::string& hint, const std::string& value) = 0;
224 * @copydoc Dali::Window::RemoveAuxiliaryHint()
226 virtual bool RemoveAuxiliaryHint(unsigned int id) = 0;
229 * @copydoc Dali::Window::SetAuxiliaryHintValue()
231 virtual bool SetAuxiliaryHintValue(unsigned int id, const std::string& value) = 0;
234 * @copydoc Dali::Window::GetAuxiliaryHintValue()
236 virtual std::string GetAuxiliaryHintValue(unsigned int id) const = 0;
239 * @copydoc Dali::Window::GetAuxiliaryHintId()
241 virtual unsigned int GetAuxiliaryHintId(const std::string& hint) const = 0;
244 * @copydoc Dali::Window::SetInputRegion()
246 virtual void SetInputRegion(const Rect<int>& inputRegion) = 0;
249 * @copydoc Dali::Window::SetType()
251 virtual void SetType(Dali::WindowType type) = 0;
254 * @copydoc Dali::Window::GetType()
256 virtual Dali::WindowType GetType() const = 0;
259 * @copydoc Dali::Window::SetNotificationLevel()
261 virtual Dali::WindowOperationResult SetNotificationLevel(Dali::WindowNotificationLevel level) = 0;
264 * @copydoc Dali::Window::GetNotificationLevel()
266 virtual Dali::WindowNotificationLevel GetNotificationLevel() const = 0;
269 * @copydoc Dali::Window::SetOpaqueState()
271 virtual void SetOpaqueState(bool opaque) = 0;
274 * @copydoc Dali::Window::SetScreenOffMode()
276 virtual Dali::WindowOperationResult SetScreenOffMode(WindowScreenOffMode screenOffMode) = 0;
279 * @copydoc Dali::Window::GetScreenOffMode()
281 virtual WindowScreenOffMode GetScreenOffMode() const = 0;
284 * @copydoc Dali::Window::SetBrightness()
286 virtual Dali::WindowOperationResult SetBrightness(int brightness) = 0;
289 * @copydoc Dali::Window::GetBrightness()
291 virtual int GetBrightness() const = 0;
294 * @copydoc Dali::KeyGrab::GrabKey()
296 virtual bool GrabKey(Dali::KEY key, KeyGrab::KeyGrabMode grabMode) = 0;
299 * @copydoc Dali::KeyGrab::UngrabKey()
301 virtual bool UngrabKey(Dali::KEY key) = 0;
304 * @copydoc Dali::KeyGrab::GrabKeyList()
306 virtual bool GrabKeyList(const Dali::Vector<Dali::KEY>& key, const Dali::Vector<KeyGrab::KeyGrabMode>& grabMode, Dali::Vector<bool>& result) = 0;
309 * @copydoc Dali::KeyGrab::UngrabKeyList()
311 virtual bool UngrabKeyList(const Dali::Vector<Dali::KEY>& key, Dali::Vector<bool>& result) = 0;
315 * @param[out] dpiHorizontal set to the horizontal dpi
316 * @param[out] dpiVertical set to the vertical dpi
318 virtual void GetDpi(unsigned int& dpiHorizontal, unsigned int& dpiVertical) = 0;
321 * @brief Return the orientation of the surface.
322 * @return The orientation
324 virtual int GetOrientation() const = 0;
327 * @brief Get the screen rotation angle of the window
329 virtual int GetScreenRotationAngle() = 0;
332 * @brief Set the rotation angle of the window
334 virtual void SetWindowRotationAngle(int degree) = 0;
337 * @brief Inform the window rotation is completed
339 virtual void WindowRotationCompleted(int degree, int width, int height) = 0;
342 * @brief starts the window is moved by display server
344 virtual void RequestMoveToServer() = 0;
347 * @brief starts the window is resized by display server
349 * @param[in] direction It is direction of the started edge/side.
351 virtual void RequestResizeToServer(WindowResizeDirection direction) = 0;
354 * @brief Enables the floating mode of window.
356 * The floating mode is to support making partial size window easliy.
357 * It is useful to make popup style window
358 * and this window is always upper than the other normal window.
360 * A special display server(as a Tizen display server) supports this mode.
362 * @param[in] enable Enable floating mode or not.
364 virtual void EnableFloatingMode(bool enable) = 0;
367 * @brief Gets whether floating mode is enabled or not.
369 virtual bool IsFloatingModeEnabled() const = 0;
372 * @copydoc Dali::Window::SetTransparency()
374 virtual void SetTransparency(bool transparent) = 0;
377 * @copydoc Dali::Window::SetParent()
379 virtual void SetParent(WindowBase* parentWinBase, bool belowParent) = 0;
382 * @brief Create a sync fence that can tell the frame is rendered by the graphics driver.
383 * @return The file descriptor that tells when it is rendered.
385 virtual int CreateFrameRenderedSyncFence() = 0;
388 * @brief Create a sync fence that can tell the frame is presented by the display server.
389 * @return The file descriptor that tells when it is presented.
391 virtual int CreateFramePresentedSyncFence() = 0;
394 * @copydoc Dali::Window::SetPositionSizeWithAngle()
396 virtual void SetPositionSizeWithAngle(PositionSize positionSize, int angle) = 0;
399 * @brief Initialize for Ime window.
400 * It should be called when the window is only used for Ime keyboard window.
402 virtual void InitializeIme() = 0;
405 * @brief Send the signal to display server for Ime Window is ready to render.
406 * It is used for compositing by display server.
408 virtual void ImeWindowReadyToRender() = 0;
411 * @brief Includes input region.
412 * @param[in] inputRegion The added region to accept input events.
414 virtual void IncludeInputRegion(const Rect<int>& inputRegion) = 0;
417 * @brief Excludes input region.
418 * @param[in] inputRegion The subtracted region to except input events.
420 virtual void ExcludeInputRegion(const Rect<int>& inputRegion) = 0;
425 * @brief This signal is emitted when the window becomes iconified or deiconified.
427 IconifySignalType& IconifyChangedSignal();
430 * @brief This signal is emitted when the window focus is changed.
432 FocusSignalType& FocusChangedSignal();
435 * @brief This signal is emitted when the output is transformed.
437 OutputSignalType& OutputTransformedSignal();
440 * @brief This signal is emitted when the window receives a delete request.
442 DeleteSignalType& DeleteRequestSignal();
445 * @brief This signal is emitted when the window is damaged.
447 DamageSignalType& WindowDamagedSignal();
450 * @brief This signal is emitted when a rotation event is recevied.
452 RotationSignalType& RotationSignal();
455 * @brief This signal is emitted when a touch event is received.
457 TouchEventSignalType& TouchEventSignal();
460 * @brief This signal is emitted when a mouse wheel is received.
462 WheelEventSignalType& WheelEventSignal();
465 * @brief This signal is emitted when a key event is received.
467 KeyEventSignalType& KeyEventSignal();
470 * @brief This signal is emitted when the source window notifies us the content in clipboard is selected.
472 SelectionSignalType& SelectionDataSendSignal();
475 * @brief This signal is emitted when the source window sends us about the selected content.
477 SelectionSignalType& SelectionDataReceivedSignal();
480 * @brief This signal is emitted when the style is changed.
482 StyleSignalType& StyleChangedSignal();
485 * @brief This signal is emitted when an accessibility event is received.
487 AccessibilitySignalType& AccessibilitySignal();
490 * @brief This signal is emitted when window's transition animation is started or ended.
492 TransitionEffectEventSignalType& TransitionEffectEventSignal();
495 * @brief This signal is emitted when the keyboard repeat is changed.
497 KeyboardRepeatSettingsChangedSignalType& KeyboardRepeatSettingsChangedSignal();
500 * @brief This signal is emitted when the window redraw is requested.
502 WindowRedrawRequestSignalType& WindowRedrawRequestSignal();
505 * @brief This signal is emitted when the window is resized or moved by display server.
507 UpdatePositionSizeType& UpdatePositionSizeSignal();
510 * @brief This signal is emitted when the window is received the auxiliary message from display server.
512 AuxiliaryMessageSignalType& AuxiliaryMessageSignal();
516 WindowBase(const WindowBase&) = delete;
519 WindowBase& operator=(const WindowBase& rhs) = delete;
522 IconifySignalType mIconifyChangedSignal;
523 FocusSignalType mFocusChangedSignal;
524 OutputSignalType mOutputTransformedSignal;
525 DeleteSignalType mDeleteRequestSignal;
526 DamageSignalType mWindowDamagedSignal;
527 RotationSignalType mRotationSignal;
528 TouchEventSignalType mTouchEventSignal;
529 WheelEventSignalType mWheelEventSignal;
530 KeyEventSignalType mKeyEventSignal;
531 SelectionSignalType mSelectionDataSendSignal;
532 SelectionSignalType mSelectionDataReceivedSignal;
533 StyleSignalType mStyleChangedSignal;
534 AccessibilitySignalType mAccessibilitySignal;
535 TransitionEffectEventSignalType mTransitionEffectEventSignal;
536 KeyboardRepeatSettingsChangedSignalType mKeyboardRepeatSettingsChangedSignal;
537 WindowRedrawRequestSignalType mWindowRedrawRequestSignal;
538 UpdatePositionSizeType mUpdatePositionSizeSignal;
539 AuxiliaryMessageSignalType mAuxiliaryMessageSignal;
542 } // namespace Adaptor
544 } // namespace Internal
548 #endif // DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_BASE_H