1 #ifndef __DALI_INTERNAL_WINDOW_H__
2 #define __DALI_INTERNAL_WINDOW_H__
5 * Copyright (c) 2017 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/public-api/object/ref-object.h>
23 #include <dali/public-api/object/base-object.h>
26 #include <base/lifecycle-observer.h>
27 #include <base/interfaces/indicator-interface.h>
28 #include <adaptor-impl.h>
30 #include <orientation.h>
31 #include <render-surface.h>
32 #include <drag-and-drop-detector.h>
33 #include <window-devel.h>
52 typedef IntrusivePtr<Window> WindowPtr;
53 typedef IntrusivePtr<Orientation> OrientationPtr;
56 * Window provides a surface to render onto with orientation & indicator properties.
58 class Window : public Dali::BaseObject, public IndicatorInterface::Observer, public LifeCycleObserver
61 typedef Dali::Window::IndicatorSignalType IndicatorSignalType;
62 typedef Dali::DevelWindow::FocusSignalType FocusSignalType;
63 typedef Signal< void () > SignalType;
66 * Create a new Window. This should only be called once by the Application class
67 * @param[in] windowPosition The position and size of the window
68 * @param[in] name The window title
69 * @param[in] className The window class name
70 * @param[in] isTransparent Whether window is transparent
71 * @return A newly allocated Window
73 static Window* New(const PositionSize& posSize, const std::string& name, const std::string& className, bool isTransparent = false);
76 * Pass the adaptor back to the overlay. This allows the window to access Core's overlay.
77 * @param[in] adaptor An initialized adaptor
79 void SetAdaptor(Dali::Adaptor& adaptor);
82 * Get the window surface
83 * @return The render surface
85 RenderSurface* GetSurface();
88 * @copydoc Dali::Window::ShowIndicator()
90 void ShowIndicator( Dali::Window::IndicatorVisibleMode visibleMode );
93 * @copydoc Dali::Window::SetIndicatorBgOpacity()
95 void SetIndicatorBgOpacity( Dali::Window::IndicatorBgOpacity opacity );
98 * @copydoc Dali::Window::RotateIndicator()
100 void RotateIndicator( Dali::Window::WindowOrientation orientation );
103 * @copydoc Dali::Window::SetClass()
105 void SetClass( std::string name, std::string klass );
108 * @copydoc Dali::Window::Raise()
113 * @copydoc Dali::Window::Lower()
118 * @copydoc Dali::Window::Activate()
123 * @copydoc Dali::Window::AddAvailableOrientation()
125 void AddAvailableOrientation(Dali::Window::WindowOrientation orientation);
128 * @copydoc Dali::Window::RemoveAvailableOrientation()
130 void RemoveAvailableOrientation(Dali::Window::WindowOrientation orientation);
133 * @copydoc Dali::Window::SetAvailableOrientations()
135 void SetAvailableOrientations(const std::vector<Dali::Window::WindowOrientation>& orientations);
138 * @copydoc Dali::Window::GetAvailableOrientations()
140 const std::vector<Dali::Window::WindowOrientation>& GetAvailableOrientations();
143 * @copydoc Dali::Window::SetPreferredOrientation()
145 void SetPreferredOrientation(Dali::Window::WindowOrientation orientation);
148 * @copydoc Dali::Window::GetPreferredOrientation()
150 Dali::Window::WindowOrientation GetPreferredOrientation();
153 * @copydoc Dali::Window::GetDragAndDropDetector() const
155 Dali::DragAndDropDetector GetDragAndDropDetector() const;
158 * @copydoc Dali::Window::GetNativeHandle() const
160 Dali::Any GetNativeHandle() const;
163 * @brief Sets whether window accepts focus or not.
165 * @param[in] accept If focus is accepted or not. Default is true.
167 void SetAcceptFocus( bool accept );
170 * @brief Returns whether window accepts focus or not.
172 * @param[in] window The window to accept focus
173 * @return True if the window accept focus, false otherwise
175 bool IsFocusAcceptable();
178 * @brief Shows the window if it is hidden.
183 * @brief Hides the window if it is showing.
188 * @brief Returns whether the window is showing or not.
189 * @return True if the window is showing, false otherwise.
191 bool IsVisible() const;
194 * Called from Orientation after the Change signal has been sent
196 void RotationDone( int orientation, int width, int height );
200 * Private constructor.
211 * Second stage initialization
213 void Initialize(const PositionSize& posSize, const std::string& name, const std::string& className);
216 * Shows / hides the indicator bar.
217 * Handles close/open if rotation changes whilst hidden
219 void DoShowIndicator( Dali::Window::WindowOrientation lastOrientation );
222 * Close current indicator and open a connection onto the new indicator service.
223 * Effect may not be synchronous if waiting for an indicator update on existing connection.
225 void DoRotateIndicator( Dali::Window::WindowOrientation orientation );
228 * Change the indicator actor's rotation to match the current orientation
230 void SetIndicatorActorRotation();
233 * Set the indicator properties on the window
235 void SetIndicatorProperties( bool isShown, Dali::Window::WindowOrientation lastOrientation );
237 private: // IndicatorInterface::Observer interface
240 * @copydoc Dali::Internal::Adaptor::IndicatorInterface::Observer::IndicatorTypeChanged()
242 virtual void IndicatorTypeChanged( IndicatorInterface::Type type );
245 * @copydoc Dali::Internal::Adaptor::IndicatorInterface::Observer::IndicatorClosed()
247 virtual void IndicatorClosed( IndicatorInterface* indicator);
250 * @copydoc Dali::Internal::Adaptor::IndicatorInterface::Observer::IndicatorVisibilityChanged()
252 virtual void IndicatorVisibilityChanged( bool isVisible );
254 private: // Adaptor::Observer interface
257 * @copydoc Dali::Internal::Adaptor::Adaptor::Observer::OnStart()
259 virtual void OnStart();
262 * @copydoc Dali::Internal::Adaptor::Adaptor::Observer::OnPause()
264 virtual void OnPause();
267 * @copydoc Dali::Internal::Adaptor::Adaptor::Observer::OnResume()
269 virtual void OnResume();
272 * @copydoc Dali::Internal::Adaptor::Adaptor::Observer::OnStop()
274 virtual void OnStop();
277 * @copydoc Dali::Internal::Adaptor::Adaptor::Observer::OnDestroy()
279 virtual void OnDestroy();
284 * The user should connect to this signal to get a timing when indicator was shown / hidden.
286 IndicatorSignalType& IndicatorVisibilityChangedSignal() { return mIndicatorVisibilityChangedSignal; }
289 * The user should connect to this signal to get a timing when window gains focus or loses focus.
291 FocusSignalType& FocusChangedSignal() { return mFocusChangedSignal; }
294 * This signal is emitted when the window is requesting to be deleted
296 SignalType& DeleteRequestSignal() { return mDeleteRequestSignal; }
300 typedef std::vector< IndicatorInterface * > DiscardedIndicators;
302 RenderSurface* mSurface;
303 Dali::Window::IndicatorVisibleMode mIndicatorVisible; ///< public state
304 bool mIndicatorIsShown:1; ///< private state
305 bool mShowRotatedIndicatorOnClose:1;
307 bool mIsTransparent:1;
308 bool mWMRotationAppSet:1;
309 bool mEcoreEventHander:1;
310 bool mIsFocusAcceptable:1;
312 IndicatorInterface* mIndicator;
313 Dali::Window::WindowOrientation mIndicatorOrientation;
314 Dali::Window::WindowOrientation mNextIndicatorOrientation;
315 Dali::Window::IndicatorBgOpacity mIndicatorOpacityMode;
316 Integration::SystemOverlay* mOverlay;
318 Dali::DragAndDropDetector mDragAndDropDetector;
321 EventHandler* mEventHandler;
323 OrientationPtr mOrientation;
324 std::vector<Dali::Window::WindowOrientation> mAvailableOrientations;
325 Dali::Window::WindowOrientation mPreferredOrientation;
328 IndicatorSignalType mIndicatorVisibilityChangedSignal;
329 FocusSignalType mFocusChangedSignal;
330 SignalType mDeleteRequestSignal;
334 void* GetNativeWindowHandler();
337 } // namespace Adaptor
338 } // namepsace Internal
340 // Helpers for public-api forwarding methods
342 inline Internal::Adaptor::Window& GetImplementation(Dali::Window& window)
344 DALI_ASSERT_ALWAYS( window && "Window handle is empty" );
345 BaseObject& object = window.GetBaseObject();
346 return static_cast<Internal::Adaptor::Window&>(object);
349 inline const Internal::Adaptor::Window& GetImplementation(const Dali::Window& window)
351 DALI_ASSERT_ALWAYS( window && "Window handle is empty" );
352 const BaseObject& object = window.GetBaseObject();
353 return static_cast<const Internal::Adaptor::Window&>(object);
359 #endif // __DALI_INTERNAL_WINDOW_H__