#define DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_IMPL_H
/*
- * Copyright (c) 2019 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2021 Samsung Electronics Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
*/
// EXTERNAL INCLUDES
-#include <dali/public-api/object/ref-object.h>
-#include <dali/public-api/object/base-object.h>
#include <dali/public-api/actors/layer.h>
+#include <dali/public-api/adaptor-framework/window-enumerations.h>
+#include <dali/public-api/object/base-object.h>
+#include <dali/public-api/object/property-array.h>
+#include <dali/public-api/object/ref-object.h>
#include <dali/public-api/render-tasks/render-task-list.h>
-#ifdef DALI_ADAPTOR_COMPILATION
-#include <dali/integration-api/scene-holder-impl.h>
-#else
-#include <dali/integration-api/adaptors/scene-holder-impl.h>
-#endif
-
// INTERNAL INCLUDES
-#include <dali/internal/adaptor/common/adaptor-impl.h>
-#include <dali/public-api/adaptor-framework/window.h>
-#include <dali/public-api/adaptor-framework/key-grab.h>
#include <dali/devel-api/adaptor-framework/window-devel.h>
+#include <dali/integration-api/adaptor-framework/scene-holder-impl.h>
+#include <dali/internal/adaptor/common/adaptor-impl.h>
#include <dali/internal/window-system/common/event-handler.h>
+#include <dali/public-api/adaptor-framework/key-grab.h>
+#include <dali/public-api/adaptor-framework/window.h>
namespace Dali
{
class WindowBase;
class Window;
-using WindowPtr = IntrusivePtr< Window >;
-using OrientationPtr = IntrusivePtr< Orientation >;
-using EventHandlerPtr = IntrusivePtr< EventHandler >;
+using WindowPtr = IntrusivePtr<Window>;
+using OrientationPtr = IntrusivePtr<Orientation>;
+using EventHandlerPtr = IntrusivePtr<EventHandler>;
/**
* Window provides a surface to render onto with orientation & indicator properties.
class Window : public Dali::Internal::Adaptor::SceneHolder, public EventHandler::Observer, public ConnectionTracker
{
public:
- typedef Dali::Window::IndicatorSignalType IndicatorSignalType;
- typedef Dali::Window::FocusSignalType FocusSignalType;
- typedef Dali::Window::ResizedSignalType ResizedSignalType;
- typedef Signal< void () > SignalType;
+ typedef Dali::Window::FocusChangeSignalType FocusChangeSignalType;
+ typedef Dali::Window::ResizeSignalType ResizeSignalType;
+ typedef Dali::DevelWindow::VisibilityChangedSignalType VisibilityChangedSignalType;
+ typedef Dali::DevelWindow::TransitionEffectEventSignalType TransitionEffectEventSignalType;
+ typedef Dali::DevelWindow::KeyboardRepeatSettingsChangedSignalType KeyboardRepeatSettingsChangedSignalType;
+ typedef Signal<void()> SignalType;
/**
- * Create a new Window. This should only be called once by the Application class
+ * @brief Create a new Window. This should only be called once by the Application class
* @param[in] positionSize The position and size of the window
* @param[in] name The window title
* @param[in] className The window class name
static Window* New(const PositionSize& positionSize, const std::string& name, const std::string& className, bool isTransparent = false);
/**
- * @copydoc Dali::Window::ShowIndicator()
- */
- void ShowIndicator( Dali::Window::IndicatorVisibleMode visibleMode );
-
- /**
- * @copydoc Dali::Window::SetIndicatorBgOpacity()
- */
- void SetIndicatorBgOpacity( Dali::Window::IndicatorBgOpacity opacity );
-
- /**
- * @copydoc Dali::Window::RotateIndicator()
+ * @brief Create a new Window. This should only be called once by the Application class
+ * @param[in] surface The surface used to render on.
+ * @param[in] positionSize The position and size of the window
+ * @param[in] name The window title
+ * @param[in] className The window class name
+ * @param[in] isTransparent Whether window is transparent
+ * @return A newly allocated Window
*/
- void RotateIndicator( Dali::Window::WindowOrientation orientation );
+ static Window* New(Any surface, const PositionSize& positionSize, const std::string& name, const std::string& className, bool isTransparent = false);
/**
* @copydoc Dali::Window::SetClass()
*/
- void SetClass( std::string name, std::string className );
+ void SetClass(std::string name, std::string className);
/**
* @brief Gets the window class name.
/**
* @copydoc Dali::Window::GetLayer()
*/
- Dali::Layer GetLayer( uint32_t depth ) const;
+ Dali::Layer GetLayer(uint32_t depth) const;
/**
* @copydoc Dali::DevelWindow::GetRenderTaskList()
/**
* @copydoc Dali::Window::AddAvailableOrientation()
*/
- void AddAvailableOrientation(Dali::Window::WindowOrientation orientation);
+ void AddAvailableOrientation(WindowOrientation orientation);
/**
* @copydoc Dali::Window::RemoveAvailableOrientation()
*/
- void RemoveAvailableOrientation(Dali::Window::WindowOrientation orientation);
-
- /**
- * @copydoc Dali::Window::SetAvailableOrientations()
- */
- void SetAvailableOrientations(const std::vector<Dali::Window::WindowOrientation>& orientations);
-
- /**
- * @copydoc Dali::Window::GetAvailableOrientations()
- */
- const std::vector<Dali::Window::WindowOrientation>& GetAvailableOrientations();
+ void RemoveAvailableOrientation(WindowOrientation orientation);
/**
* @copydoc Dali::Window::SetPreferredOrientation()
*/
- void SetPreferredOrientation(Dali::Window::WindowOrientation orientation);
+ void SetPreferredOrientation(WindowOrientation orientation);
/**
* @copydoc Dali::Window::GetPreferredOrientation()
*/
- Dali::Window::WindowOrientation GetPreferredOrientation();
+ WindowOrientation GetPreferredOrientation();
/**
* @copydoc Dali::Window::SetAcceptFocus()
*/
- void SetAcceptFocus( bool accept );
+ void SetAcceptFocus(bool accept);
/**
* @copydoc Dali::Window::IsFocusAcceptable()
/**
* @copydoc Dali::Window::GetSupportedAuxiliaryHint()
*/
- std::string GetSupportedAuxiliaryHint( unsigned int index ) const;
+ std::string GetSupportedAuxiliaryHint(unsigned int index) const;
/**
* @copydoc Dali::Window::AddAuxiliaryHint()
*/
- unsigned int AddAuxiliaryHint( const std::string& hint, const std::string& value );
+ unsigned int AddAuxiliaryHint(const std::string& hint, const std::string& value);
/**
* @copydoc Dali::Window::RemoveAuxiliaryHint()
*/
- bool RemoveAuxiliaryHint( unsigned int id );
+ bool RemoveAuxiliaryHint(unsigned int id);
/**
* @copydoc Dali::Window::SetAuxiliaryHintValue()
*/
- bool SetAuxiliaryHintValue( unsigned int id, const std::string& value );
+ bool SetAuxiliaryHintValue(unsigned int id, const std::string& value);
/**
* @copydoc Dali::Window::GetAuxiliaryHintValue()
*/
- std::string GetAuxiliaryHintValue( unsigned int id ) const;
+ std::string GetAuxiliaryHintValue(unsigned int id) const;
/**
* @copydoc Dali::Window::GetAuxiliaryHintId()
*/
- unsigned int GetAuxiliaryHintId( const std::string& hint ) const;
+ unsigned int GetAuxiliaryHintId(const std::string& hint) const;
/**
* @copydoc Dali::Window::SetInputRegion()
*/
- void SetInputRegion( const Rect< int >& inputRegion );
+ void SetInputRegion(const Rect<int>& inputRegion);
/**
* @copydoc Dali::Window::SetType()
*/
- void SetType( Dali::Window::Type type );
+ void SetType(WindowType type);
/**
* @copydoc Dali::Window::GetType() const
*/
- Dali::Window::Type GetType() const;
+ WindowType GetType() const;
/**
* @copydoc Dali::Window::SetNotificationLevel()
*/
- bool SetNotificationLevel( Dali::Window::NotificationLevel::Type level );
+ bool SetNotificationLevel(WindowNotificationLevel level);
/**
* @copydoc Dali::Window::GetNotificationLevel()
*/
- Dali::Window::NotificationLevel::Type GetNotificationLevel() const;
+ WindowNotificationLevel GetNotificationLevel() const;
/**
* @copydoc Dali::Window::SetOpaqueState()
*/
- void SetOpaqueState( bool opaque );
+ void SetOpaqueState(bool opaque);
/**
* @copydoc Dali::Window::IsOpaqueState()
/**
* @copydoc Dali::Window::SetScreenOffMode()
*/
- bool SetScreenOffMode(Dali::Window::ScreenOffMode::Type screenOffMode);
+ bool SetScreenOffMode(WindowScreenOffMode screenOffMode);
/**
* @copydoc Dali::Window::GetScreenOffMode()
*/
- Dali::Window::ScreenOffMode::Type GetScreenOffMode() const;
+ WindowScreenOffMode GetScreenOffMode() const;
/**
* @copydoc Dali::Window::SetBrightness()
*/
- bool SetBrightness( int brightness );
+ bool SetBrightness(int brightness);
/**
* @copydoc Dali::Window::GetBrightness()
/**
* @copydoc Dali::Window::SetSize()
*/
- void SetSize( Dali::Window::WindowSize size );
+ void SetSize(Dali::Window::WindowSize size);
/**
* @copydoc Dali::Window::GetSize()
/**
* @copydoc Dali::Window::SetPosition()
*/
- void SetPosition( Dali::Window::WindowPosition position );
+ void SetPosition(Dali::Window::WindowPosition position);
/**
* @copydoc Dali::Window::GetPosition()
/**
* @copydoc Dali::DevelWindow::SetPositionSize()
*/
- void SetPositionSize( PositionSize positionSize );
+ void SetPositionSize(PositionSize positionSize);
/**
* @copydoc Dali::Window::GetRootLayer()
/**
* @copydoc Dali::Window::SetTransparency()
*/
- void SetTransparency( bool transparent );
+ void SetTransparency(bool transparent);
/**
* @copydoc Dali::KeyGrab::GrabKey()
*/
- bool GrabKey( Dali::KEY key, KeyGrab::KeyGrabMode grabMode );
+ bool GrabKey(Dali::KEY key, KeyGrab::KeyGrabMode grabMode);
/**
* @copydoc Dali::KeyGrab::UngrabKey()
*/
- bool UngrabKey( Dali::KEY key );
+ bool UngrabKey(Dali::KEY key);
/**
* @copydoc Dali::KeyGrab::GrabKeyList()
*/
- bool GrabKeyList( const Dali::Vector< Dali::KEY >& key, const Dali::Vector< KeyGrab::KeyGrabMode >& grabMode, Dali::Vector< bool >& result );
+ bool GrabKeyList(const Dali::Vector<Dali::KEY>& key, const Dali::Vector<KeyGrab::KeyGrabMode>& grabMode, Dali::Vector<bool>& result);
/**
* @copydoc Dali::KeyGrab::UngrabKeyList()
*/
- bool UngrabKeyList( const Dali::Vector< Dali::KEY >& key, Dali::Vector< bool >& result );
+ bool UngrabKeyList(const Dali::Vector<Dali::KEY>& key, Dali::Vector<bool>& result);
/**
* @copydoc Dali::DevelWindow::Get()
*/
- static Dali::Window Get( Dali::Actor actor );
+ static Dali::Window Get(Dali::Actor actor);
/**
* @copydoc Dali::DevelWindow::SetParent()
*/
- void SetParent( Dali::Window& parent );
+ void SetParent(Dali::Window& parent);
/**
* @copydoc Dali::DevelWindow::Unparent()
*/
Dali::Window GetParent();
-public: // Dali::Internal::Adaptor::SceneHolder
+ /**
+ * @copydoc Dali::DevelWindow::GetCurrentOrientation()
+ */
+ WindowOrientation GetCurrentOrientation() const;
+
+ /**
+ * @copydoc Dali::DevelWindow::GetPhysicalOrientation()
+ */
+ int GetPhysicalOrientation() const;
+
+ /**
+ * @copydoc Dali::DevelWindow::SetAvailableOrientations()
+ */
+ void SetAvailableOrientations(const Dali::Vector<WindowOrientation>& orientations);
+public: // Dali::Internal::Adaptor::SceneHolder
/**
* @copydoc Dali::Internal::Adaptor::SceneHolder::GetNativeHandle
*/
*/
bool IsVisible() const override;
+ /**
+ * @copydoc Dali::DevelWindow::GetNativeId()
+ */
+ int32_t GetNativeId() const;
+
private:
+ /**
+ * @brief Enumeration for orietation mode.
+ * The Orientation Mode is related to screen size.
+ * If screen width is longer than height, the Orientation Mode will have LANDSCAPE.
+ * Otherwise screen width is shorter than height or same, the Orientation Mode will have PORTRAIT.
+ */
+ enum class OrientationMode
+ {
+ PORTRAIT = 0,
+ LANDSCAPE
+ };
/**
* Private constructor.
/**
* Destructor
*/
- virtual ~Window();
+ ~Window() override;
/**
* Second stage initialization
*/
- void Initialize(const PositionSize& positionSize, const std::string& name, const std::string& className);
+ void Initialize(Any surface, const PositionSize& positionSize, const std::string& name, const std::string& className);
/**
* Called when the window becomes iconified or deiconified.
*/
- void OnIconifyChanged( bool iconified );
+ void OnIconifyChanged(bool iconified);
/**
* Called when the window focus is changed.
*/
- void OnFocusChanged( bool focusIn );
+ void OnFocusChanged(bool focusIn);
/**
* Called when the output is transformed.
*/
void OnDeleteRequest();
-private: // Dali::Internal::Adaptor::SceneHolder
+ /**
+ * Called when the window receives a Transition effect-start/end event.
+ */
+ void OnTransitionEffectEvent(WindowEffectState state, WindowEffectType type);
+
+ /**
+ * @brief Called when window receives a keyboard repeat event.
+ */
+ void OnKeyboardRepeatSettingsChanged();
+
+ /**
+ * @brief Called when the window redraw is requested.
+ */
+ void OnWindowRedrawRequest();
+
+ /**
+ * @brief Set available orientation to window base.
+ */
+ void SetAvailableAnlges(const std::vector<int>& angles);
+
+ /**
+ * @brief Convert from window orientation to angle using OrientationMode.
+ */
+ int ConvertToAngle(WindowOrientation orientation);
+
+ /**
+ * @brief Convert from angle to window orientation using OrientationMode.
+ */
+ WindowOrientation ConvertToOrientation(int angle) const;
/**
+ * @brief Check available window orientation for Available orientation.
+ */
+ bool IsOrientationAvailable(WindowOrientation orientation) const;
+
+private: // Dali::Internal::Adaptor::SceneHolder
+ /**
* @copydoc Dali::Internal::Adaptor::SceneHolder::OnAdaptorSet
*/
- void OnAdaptorSet( Dali::Adaptor& adaptor ) override;
+ void OnAdaptorSet(Dali::Adaptor& adaptor) override;
/**
* @copydoc Dali::Internal::Adaptor::SceneHolder::OnSurfaceSet
*/
- void OnSurfaceSet( Dali::RenderSurfaceInterface* surface ) override;
+ void OnSurfaceSet(Dali::RenderSurfaceInterface* surface) override;
/**
* @copydoc Dali::Internal::Adaptor::SceneHolder::OnPause
/**
* @copydoc Dali::Internal::Adaptor::SceneHolder::RecalculateTouchPosition
*/
- void RecalculateTouchPosition( Integration::Point& point ) override;
+ void RecalculateTouchPosition(Integration::Point& point) override;
private: // Dali::Internal::Adaptor::EventHandler::Observer
-
/**
* @copydoc Dali::Internal::Adaptor::EventHandler::Observer::OnTouchPoint
*/
- void OnTouchPoint( Dali::Integration::Point& point, int timeStamp ) override;
+ void OnTouchPoint(Dali::Integration::Point& point, int timeStamp) override;
/**
* @copydoc Dali::Internal::Adaptor::EventHandler::Observer::OnWheelEvent
*/
- void OnWheelEvent( Dali::Integration::WheelEvent& wheelEvent ) override;
+ void OnWheelEvent(Dali::Integration::WheelEvent& wheelEvent) override;
/**
* @copydoc Dali::Internal::Adaptor::EventHandler::Observer::OnKeyEvent
*/
- void OnKeyEvent( Dali::Integration::KeyEvent& keyEvent ) override;
+ void OnKeyEvent(Dali::Integration::KeyEvent& keyEvent) override;
/**
* @copydoc Dali::Internal::Adaptor::EventHandler::Observer::OnRotation
*/
- void OnRotation( const RotationEvent& rotation ) override;
+ void OnRotation(const RotationEvent& rotation) override;
public: // Signals
-
/**
- * The user should connect to this signal to get a timing when indicator was shown / hidden.
+ * @copydoc Dali::Window::FocusChangeSignal()
*/
- IndicatorSignalType& IndicatorVisibilityChangedSignal() { return mIndicatorVisibilityChangedSignal; }
+ FocusChangeSignalType& FocusChangeSignal()
+ {
+ return mFocusChangeSignal;
+ }
/**
- * @copydoc Dali::Window::FocusChangedSignal()
+ * @copydoc Dali::Window::ResizedSignal()
*/
- FocusSignalType& FocusChangedSignal() { return mFocusChangedSignal; }
+ ResizeSignalType& ResizeSignal()
+ {
+ return mResizeSignal;
+ }
/**
- * @copydoc Dali::Window::ResizedSignal()
+ * This signal is emitted when the window is requesting to be deleted
*/
- ResizedSignalType& ResizedSignal() { return mResizedSignal; }
+ SignalType& DeleteRequestSignal()
+ {
+ return mDeleteRequestSignal;
+ }
/**
- * This signal is emitted when the window is requesting to be deleted
+ * @copydoc Dali::DevelWindow::VisibilityChangedSignal()
*/
- SignalType& DeleteRequestSignal() { return mDeleteRequestSignal; }
+ VisibilityChangedSignalType& VisibilityChangedSignal()
+ {
+ return mVisibilityChangedSignal;
+ }
/**
* @copydoc Dali::Window::SignalEventProcessingFinished()
*/
- Dali::DevelWindow::EventProcessingFinishedSignalType& EventProcessingFinishedSignal() { return mScene.EventProcessingFinishedSignal(); }
+ Dali::DevelWindow::EventProcessingFinishedSignalType& EventProcessingFinishedSignal()
+ {
+ return mScene.EventProcessingFinishedSignal();
+ }
-private:
+ /**
+ * @copydoc Dali::DevelWindow::TransitionEffectEventSignal()
+ */
+ TransitionEffectEventSignalType& TransitionEffectEventSignal()
+ {
+ return mTransitionEffectEventSignal;
+ }
+
+ /**
+ * @copydoc Dali::DevelWindow::KeyboardRepeatSettingsChangedSignal()
+ */
+ KeyboardRepeatSettingsChangedSignalType& KeyboardRepeatSettingsChangedSignal()
+ {
+ return mKeyboardRepeatSettingsChangedSignal;
+ }
- WindowRenderSurface* mWindowSurface; ///< The window rendering surface
- WindowBase* mWindowBase;
- std::string mName;
- std::string mClassName;
- bool mIsTransparent:1;
- bool mIsFocusAcceptable:1;
- bool mIconified:1;
- bool mOpaqueState:1;
- bool mResizeEnabled:1;
- Dali::Window::Type mType;
- Dali::Window mParentWindow;
+private:
+ WindowRenderSurface* mWindowSurface; ///< The window rendering surface
+ WindowBase* mWindowBase;
+ std::string mName;
+ std::string mClassName;
+ bool mIsTransparent : 1;
+ bool mIsFocusAcceptable : 1;
+ bool mIconified : 1;
+ bool mOpaqueState : 1;
+ bool mResizeEnabled : 1;
+ WindowType mType;
+ Dali::Window mParentWindow;
- OrientationPtr mOrientation;
- std::vector<Dali::Window::WindowOrientation> mAvailableOrientations;
- Dali::Window::WindowOrientation mPreferredOrientation;
+ OrientationPtr mOrientation;
+ std::vector<int> mAvailableAngles;
+ int mPreferredAngle;
- int mRotationAngle; ///< The angle of the rotation
- int mWindowWidth; ///< The width of the window
- int mWindowHeight; ///< The height of the window
+ int mRotationAngle; ///< The angle of the rotation
+ int mWindowWidth; ///< The width of the window
+ int mWindowHeight; ///< The height of the window
- EventHandlerPtr mEventHandler; ///< The window events handler
+ EventHandlerPtr mEventHandler; ///< The window events handler
- // Signals
- IndicatorSignalType mIndicatorVisibilityChangedSignal;
- FocusSignalType mFocusChangedSignal;
- ResizedSignalType mResizedSignal;
- SignalType mDeleteRequestSignal;
+ OrientationMode mOrientationMode;
+ int mNativeWindowId; ///< The Native Window Id
+ // Signals
+ SignalType mDeleteRequestSignal;
+ FocusChangeSignalType mFocusChangeSignal;
+ ResizeSignalType mResizeSignal;
+ VisibilityChangedSignalType mVisibilityChangedSignal;
+ TransitionEffectEventSignalType mTransitionEffectEventSignal;
+ KeyboardRepeatSettingsChangedSignalType mKeyboardRepeatSettingsChangedSignal;
};
} // namespace Adaptor
-} // namepsace Internal
+} // namespace Internal
// Helpers for public-api forwarding methods
inline Internal::Adaptor::Window& GetImplementation(Dali::Window& window)
{
- DALI_ASSERT_ALWAYS( window && "Window handle is empty" );
+ DALI_ASSERT_ALWAYS(window && "Window handle is empty");
BaseObject& object = window.GetBaseObject();
return static_cast<Internal::Adaptor::Window&>(object);
}
inline const Internal::Adaptor::Window& GetImplementation(const Dali::Window& window)
{
- DALI_ASSERT_ALWAYS( window && "Window handle is empty" );
+ DALI_ASSERT_ALWAYS(window && "Window handle is empty");
const BaseObject& object = window.GetBaseObject();
return static_cast<const Internal::Adaptor::Window&>(object);
}