1 #ifndef DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_BASE_H
2 #define DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_BASE_H
5 * Copyright (c) 2019 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/public-api/events/wheel-event.h>
30 #include <dali/public-api/adaptor-framework/window.h>
31 #include <dali/public-api/adaptor-framework/key-grab.h>
32 #include <dali/public-api/adaptor-framework/style-change.h>
33 #include <dali/devel-api/adaptor-framework/window-devel.h>
34 #include <dali/internal/window-system/common/damage-observer.h>
35 #include <dali/internal/window-system/common/rotation-event.h>
36 #include <dali/internal/graphics/gles/egl-implementation.h>
46 * 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 ( DevelWindow::EffectState, DevelWindow::EffectType ) > TransitionEffectEventSignalType;
76 typedef Signal< void ( Integration::Point&, uint32_t ) > TouchEventSignalType;
77 typedef Signal< void ( WheelEvent& ) > WheelEventSignalType;
78 typedef Signal< void( Integration::KeyEvent& ) > KeyEventSignalType;
81 typedef Signal< void ( void* ) > SelectionSignalType;
84 typedef Signal< void ( StyleChange::Type ) > StyleSignalType;
85 typedef Signal< void ( const AccessibilityInfo& ) > AccessibilitySignalType;
88 * @brief Default constructor
95 virtual ~WindowBase();
100 * @brief Get the native window handle
101 * @return The native window handle
103 virtual Any GetNativeWindow() = 0;
106 * @brief Get the native window id
107 * @return The native window id
109 virtual int GetNativeWindowId() = 0;
112 * @brief Create the egl window
114 virtual EGLNativeWindowType CreateEglWindow( int width, int height ) = 0;
117 * @brief Destroy the egl window
119 virtual void DestroyEglWindow() = 0;
122 * @brief Set the egl window rotation
124 virtual void SetEglWindowRotation( int angle ) = 0;
127 * @brief Set the egl window buffer transform
129 virtual void SetEglWindowBufferTransform( int angle ) = 0;
132 * @brief Set the egl window transform
134 virtual void SetEglWindowTransform( int angle ) = 0;
137 * @brief Resize the egl window
139 virtual void ResizeEglWindow( Dali::PositionSize positionSize ) = 0;
142 * @brief Returns whether the egl window support rotation or not
144 virtual bool IsEglWindowRotationSupported() = 0;
147 * @brief Move the window
149 virtual void Move( Dali::PositionSize positionSize ) = 0;
152 * @brief Resize the window
154 virtual void Resize( Dali::PositionSize positionSize ) = 0;
157 * @brief Move and resize the window
159 virtual void MoveResize( Dali::PositionSize positionSize ) = 0;
162 * @copydoc Dali::Window::SetClass()
164 virtual void SetClass( const std::string& name, const std::string& className ) = 0;
167 * @copydoc Dali::Window::Raise()
169 virtual void Raise() = 0;
172 * @copydoc Dali::Window::Lower()
174 virtual void Lower() = 0;
177 * @copydoc Dali::Window::Activate()
179 virtual void Activate() = 0;
182 * @copydoc Dali::Window::SetAvailableOrientations()
184 virtual void SetAvailableAnlges( const std::vector< int >& angles ) = 0;
187 * @copydoc Dali::Window::SetPreferredOrientation()
189 virtual void SetPreferredAngle( int angle ) = 0;
192 * @copydoc Dali::Window::SetAcceptFocus()
194 virtual void SetAcceptFocus( bool accept ) = 0;
197 * @copydoc Dali::Window::Show()
199 virtual void Show() = 0;
202 * @copydoc Dali::Window::Hide()
204 virtual void Hide() = 0;
207 * @copydoc Dali::Window::GetSupportedAuxiliaryHintCount()
209 virtual unsigned int GetSupportedAuxiliaryHintCount() const = 0;
212 * @copydoc Dali::Window::GetSupportedAuxiliaryHint()
214 virtual std::string GetSupportedAuxiliaryHint( unsigned int index ) const = 0;
217 * @copydoc Dali::Window::AddAuxiliaryHint()
219 virtual unsigned int AddAuxiliaryHint( const std::string& hint, const std::string& value ) = 0;
222 * @copydoc Dali::Window::RemoveAuxiliaryHint()
224 virtual bool RemoveAuxiliaryHint( unsigned int id ) = 0;
227 * @copydoc Dali::Window::SetAuxiliaryHintValue()
229 virtual bool SetAuxiliaryHintValue( unsigned int id, const std::string& value ) = 0;
232 * @copydoc Dali::Window::GetAuxiliaryHintValue()
234 virtual std::string GetAuxiliaryHintValue( unsigned int id ) const = 0;
237 * @copydoc Dali::Window::GetAuxiliaryHintId()
239 virtual unsigned int GetAuxiliaryHintId( const std::string& hint ) const = 0;
242 * @copydoc Dali::Window::SetInputRegion()
244 virtual void SetInputRegion( const Rect< int >& inputRegion ) = 0;
247 * @copydoc Dali::Window::SetType()
249 virtual void SetType( Dali::Window::Type type ) = 0;
252 * @copydoc Dali::Window::SetNotificationLevel()
254 virtual bool SetNotificationLevel( Dali::Window::NotificationLevel::Type level ) = 0;
257 * @copydoc Dali::Window::GetNotificationLevel()
259 virtual Dali::Window::NotificationLevel::Type GetNotificationLevel() const = 0;
262 * @copydoc Dali::Window::SetOpaqueState()
264 virtual void SetOpaqueState( bool opaque ) = 0;
267 * @copydoc Dali::Window::SetScreenOffMode()
269 virtual bool SetScreenOffMode(Dali::Window::ScreenOffMode::Type screenOffMode) = 0;
272 * @copydoc Dali::Window::GetScreenOffMode()
274 virtual Dali::Window::ScreenOffMode::Type GetScreenOffMode() const = 0;
277 * @copydoc Dali::Window::SetBrightness()
279 virtual bool SetBrightness( int brightness ) = 0;
282 * @copydoc Dali::Window::GetBrightness()
284 virtual int GetBrightness() const = 0;
287 * @copydoc Dali::KeyGrab::GrabKey()
289 virtual bool GrabKey( Dali::KEY key, KeyGrab::KeyGrabMode grabMode ) = 0;
292 * @copydoc Dali::KeyGrab::UngrabKey()
294 virtual bool UngrabKey( Dali::KEY key ) = 0;
297 * @copydoc Dali::KeyGrab::GrabKeyList()
299 virtual bool GrabKeyList( const Dali::Vector< Dali::KEY >& key, const Dali::Vector< KeyGrab::KeyGrabMode >& grabMode, Dali::Vector< bool >& result ) = 0;
302 * @copydoc Dali::KeyGrab::UngrabKeyList()
304 virtual bool UngrabKeyList( const Dali::Vector< Dali::KEY >& key, Dali::Vector< bool >& result ) = 0;
308 * @param[out] dpiHorizontal set to the horizontal dpi
309 * @param[out] dpiVertical set to the vertical dpi
311 virtual void GetDpi( unsigned int& dpiHorizontal, unsigned int& dpiVertical ) = 0;
314 * @brief Get the screen rotation angle of the window
316 virtual int GetScreenRotationAngle() = 0;
319 * @brief Set the rotation angle of the window
321 virtual void SetWindowRotationAngle( int degree ) = 0;
324 * @brief Inform the window rotation is completed
326 virtual void WindowRotationCompleted( int degree, int width, int height ) = 0;
329 * @copydoc Dali::Window::SetTransparency()
331 virtual void SetTransparency( bool transparent ) = 0;
334 * @copydoc Dali::Window::SetParent()
336 virtual void SetParent( WindowBase* parentWinBase ) = 0;
339 * @brief Create a sync fence that can tell the frame is rendered by the graphics driver.
340 * @return The file descriptor that tells when it is rendered.
342 virtual int CreateFrameRenderedSyncFence() = 0;
345 * @brief Create a sync fence that can tell the frame is presented by the display server.
346 * @return The file descriptor that tells when it is presented.
348 virtual int CreateFramePresentedSyncFence() = 0;
353 * @brief This signal is emitted when the window becomes iconified or deiconified.
355 IconifySignalType& IconifyChangedSignal();
358 * @brief This signal is emitted when the window focus is changed.
360 FocusSignalType& FocusChangedSignal();
363 * @brief This signal is emitted when the output is transformed.
365 OutputSignalType& OutputTransformedSignal();
368 * @brief This signal is emitted when the window receives a delete request.
370 DeleteSignalType& DeleteRequestSignal();
373 * @brief This signal is emitted when the window is damaged.
375 DamageSignalType& WindowDamagedSignal();
378 * @brief This signal is emitted when a rotation event is recevied.
380 RotationSignalType& RotationSignal();
383 * @brief This signal is emitted when a touch event is received.
385 TouchEventSignalType& TouchEventSignal();
388 * @brief This signal is emitted when a mouse wheel is received.
390 WheelEventSignalType& WheelEventSignal();
393 * @brief This signal is emitted when a key event is received.
395 KeyEventSignalType& KeyEventSignal();
398 * @brief This signal is emitted when the source window notifies us the content in clipboard is selected.
400 SelectionSignalType& SelectionDataSendSignal();
403 * @brief This signal is emitted when the source window sends us about the selected content.
405 SelectionSignalType& SelectionDataReceivedSignal();
408 * @brief This signal is emitted when the style is changed.
410 StyleSignalType& StyleChangedSignal();
413 * @brief This signal is emitted when an accessibility event is received.
415 AccessibilitySignalType& AccessibilitySignal();
418 * @brief This signal is emitted when window's transition animation is started or ended.
420 TransitionEffectEventSignalType& TransitionEffectEventSignal();
425 WindowBase(const WindowBase&) = delete;
428 WindowBase& operator=(const WindowBase& rhs) = delete;
432 IconifySignalType mIconifyChangedSignal;
433 FocusSignalType mFocusChangedSignal;
434 OutputSignalType mOutputTransformedSignal;
435 DeleteSignalType mDeleteRequestSignal;
436 DamageSignalType mWindowDamagedSignal;
437 RotationSignalType mRotationSignal;
438 TouchEventSignalType mTouchEventSignal;
439 WheelEventSignalType mWheelEventSignal;
440 KeyEventSignalType mKeyEventSignal;
441 SelectionSignalType mSelectionDataSendSignal;
442 SelectionSignalType mSelectionDataReceivedSignal;
443 StyleSignalType mStyleChangedSignal;
444 AccessibilitySignalType mAccessibilitySignal;
445 TransitionEffectEventSignalType mTransitionEffectEventSignal;
448 } // namespace Adaptor
450 } // namespace internal
454 #endif // DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_BASE_H