X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=adaptors%2Fcommon%2Fwindow-impl.h;h=ceed80aed9751e829492be26105124ebf3e574bd;hb=8dd13d9e4a79dcf0ee26602d48803bd5503c47d2;hp=22f046e32ef748e3c5dbd7e8ebe23b56bd47f1b4;hpb=95640f925a8f0c5ecd48fabefdbcf7a45ef6bd78;p=platform%2Fcore%2Fuifw%2Fdali-adaptor.git diff --git a/adaptors/common/window-impl.h b/adaptors/common/window-impl.h index 22f046e..ceed80a 100644 --- a/adaptors/common/window-impl.h +++ b/adaptors/common/window-impl.h @@ -2,7 +2,7 @@ #define __DALI_INTERNAL_WINDOW_H__ /* - * Copyright (c) 2014 Samsung Electronics Co., Ltd. + * Copyright (c) 2017 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. @@ -24,12 +24,13 @@ // INTERNAL INCLUDES #include +#include #include -#include #include #include #include #include +#include namespace Dali { @@ -45,7 +46,6 @@ namespace Internal { namespace Adaptor { -class Indicator; class Orientation; class Window; @@ -55,19 +55,22 @@ typedef IntrusivePtr OrientationPtr; /** * Window provides a surface to render onto with orientation & indicator properties. */ -class Window : public Dali::BaseObject, public Indicator::Observer, public LifeCycleObserver +class Window : public Dali::BaseObject, public IndicatorInterface::Observer, public LifeCycleObserver { public: typedef Dali::Window::IndicatorSignalType IndicatorSignalType; + typedef Dali::DevelWindow::FocusSignalType FocusSignalType; + typedef Signal< void () > SignalType; /** * Create a new Window. This should only be called once by the Application class * @param[in] windowPosition 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 */ - static Window* New(const PositionSize& posSize, const std::string& name, bool isTransparent = false); + static Window* New(const PositionSize& posSize, const std::string& name, const std::string& className, bool isTransparent = false); /** * Pass the adaptor back to the overlay. This allows the window to access Core's overlay. @@ -157,10 +160,104 @@ public: Dali::Any GetNativeHandle() const; /** + * @brief Sets whether window accepts focus or not. + * + * @param[in] accept If focus is accepted or not. Default is true. + */ + void SetAcceptFocus( bool accept ); + + /** + * @brief Returns whether window accepts focus or not. + * + * @param[in] window The window to accept focus + * @return True if the window accept focus, false otherwise + */ + bool IsFocusAcceptable(); + + /** + * @brief Shows the window if it is hidden. + */ + void Show(); + + /** + * @brief Hides the window if it is showing. + */ + void Hide(); + + /** + * @brief Returns whether the window is showing or not. + * @return True if the window is showing, false otherwise. + */ + bool IsVisible() const; + + /** * Called from Orientation after the Change signal has been sent */ void RotationDone( int orientation, int width, int height ); + /** + * @brief Gets the count of supported auxiliary hints of the window. + * @return The number of supported auxiliary hints. + * + * @note The window auxiliary hint is the value which is used to decide which actions should be made available to the user by the window manager. + * If you want to set specific hint to your window, then you should check whether it exists in the supported auxiliary hints. + */ + unsigned int GetSupportedAuxiliaryHintCount(); + + /** + * @brief Gets the supported auxiliary hint string of the window. + * @param[in] index The index of the supported auxiliary hint lists + * @return The auxiliary hint string of the index. + * + * @note The window auxiliary hint is the value which is used to decide which actions should be made available to the user by the window manager. + * If you want to set specific hint to your window, then you should check whether it exists in the supported auxiliary hints. + */ + std::string GetSupportedAuxiliaryHint( unsigned int index ); + + /** + * @brief Creates an auxiliary hint of the window. + * @param[in] hint The auxiliary hint string. + * @param[in] value The value string. + * @return The ID of created auxiliary hint, or @c 0 on failure. + */ + unsigned int AddAuxiliaryHint( const std::string& hint, const std::string& value ); + + /** + * @brief Removes an auxiliary hint of the window. + * @param[in] id The ID of the auxiliary hint. + * @return True if no error occurred, false otherwise. + */ + bool RemoveAuxiliaryHint( unsigned int id ); + + /** + * @brief Changes a value of the auxiliary hint. + * @param[in] id The auxiliary hint ID. + * @param[in] value The value string to be set. + * @return True if no error occurred, false otherwise. + */ + bool SetAuxiliaryHintValue( unsigned int id, const std::string& value ); + + /** + * @brief Gets a value of the auxiliary hint. + * @param[in] id The auxiliary hint ID. + * @return The string value of the auxiliary hint ID, or an empty string if none exists. + */ + std::string GetAuxiliaryHintValue( unsigned int id ) const; + + /** + * @brief Gets a ID of the auxiliary hint string. + * @param[in] hint The auxiliary hint string. + * @return The ID of the auxiliary hint string, or @c 0 if none exists. + */ + unsigned int GetAuxiliaryHintId( const std::string& hint ) const; + + /** + * @brief Sets a region to get input events. + * @param[in] inputRegion The rectangle region to get input events. + * @note To set an empty region, pass width and height as 0. An empty input region means the entire window will accept input events. + */ + void SetInputRegion( const Rect< int >& inputRegion ); + private: /** * Private constructor. @@ -176,7 +273,7 @@ private: /** * Second stage initialization */ - void Initialize(const PositionSize& posSize, const std::string& name); + void Initialize(const PositionSize& posSize, const std::string& name, const std::string& className); /** * Shows / hides the indicator bar. @@ -200,20 +297,20 @@ private: */ void SetIndicatorProperties( bool isShown, Dali::Window::WindowOrientation lastOrientation ); -private: // Indicator::Observer interface +private: // IndicatorInterface::Observer interface /** - * @copydoc Dali::Internal::Adaptor::Indicator::Observer::IndicatorTypeChanged() + * @copydoc Dali::Internal::Adaptor::IndicatorInterface::Observer::IndicatorTypeChanged() */ - virtual void IndicatorTypeChanged( Indicator::Type type ); + virtual void IndicatorTypeChanged( IndicatorInterface::Type type ); /** - * @copydoc Dali::Internal::Adaptor::Indicator::Observer::IndicatorClosed() + * @copydoc Dali::Internal::Adaptor::IndicatorInterface::Observer::IndicatorClosed() */ - virtual void IndicatorClosed(Indicator* indicator); + virtual void IndicatorClosed( IndicatorInterface* indicator); /** - * @copydoc Dali::Internal::Adaptor::Indicator::Observer::IndicatorVisibilityChanged() + * @copydoc Dali::Internal::Adaptor::IndicatorInterface::Observer::IndicatorVisibilityChanged() */ virtual void IndicatorVisibilityChanged( bool isVisible ); @@ -245,14 +342,25 @@ private: // Adaptor::Observer interface virtual void OnDestroy(); public: // Signals + /** * The user should connect to this signal to get a timing when indicator was shown / hidden. */ IndicatorSignalType& IndicatorVisibilityChangedSignal() { return mIndicatorVisibilityChangedSignal; } + /** + * The user should connect to this signal to get a timing when window gains focus or loses focus. + */ + FocusSignalType& FocusChangedSignal() { return mFocusChangedSignal; } + + /** + * This signal is emitted when the window is requesting to be deleted + */ + SignalType& DeleteRequestSignal() { return mDeleteRequestSignal; } + private: - typedef std::vector DiscardedIndicators; + typedef std::vector< std::pair< std::string, std::string > > AuxiliaryHints; RenderSurface* mSurface; Dali::Window::IndicatorVisibleMode mIndicatorVisible; ///< public state @@ -262,7 +370,9 @@ private: bool mIsTransparent:1; bool mWMRotationAppSet:1; bool mEcoreEventHander:1; - Indicator* mIndicator; + bool mIsFocusAcceptable:1; + bool mVisible:1; + IndicatorInterface* mIndicator; Dali::Window::WindowOrientation mIndicatorOrientation; Dali::Window::WindowOrientation mNextIndicatorOrientation; Dali::Window::IndicatorBgOpacity mIndicatorOpacityMode; @@ -277,8 +387,13 @@ private: std::vector mAvailableOrientations; Dali::Window::WindowOrientation mPreferredOrientation; + std::vector< std::string > mSupportedAuxiliaryHints; + AuxiliaryHints mAuxiliaryHints; + // Signals IndicatorSignalType mIndicatorVisibilityChangedSignal; + FocusSignalType mFocusChangedSignal; + SignalType mDeleteRequestSignal; }; } // namespace Adaptor