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.
23 #include <dali/public-api/math/rect.h>
24 #include <dali/public-api/math/uint-16-pair.h>
25 #include <dali/public-api/math/vector2.h>
26 #include <dali/public-api/math/vector4.h>
27 #include <dali/public-api/object/base-handle.h>
28 #include <dali/public-api/object/any.h>
29 #include <dali/public-api/signals/dali-signal.h>
32 #include <dali/public-api/dali-adaptor-common.h>
37 * @addtogroup dali_adaptor_framework
41 typedef Dali::Rect<int> PositionSize;
43 namespace Internal DALI_INTERNAL
51 class DragAndDropDetector;
57 * @brief The window class is used internally for drawing.
59 * A Window has an orientation and indicator properties.
60 * You can get a valid Window handle by calling Dali::Application::GetWindow().
63 class DALI_ADAPTOR_API Window : public BaseHandle
67 typedef Uint16Pair WindowSize; ///< Window size type @SINCE_1_2.60
68 typedef Uint16Pair WindowPosition; ///< Window position type @SINCE_1_2.60
70 typedef Signal< void (bool) > IndicatorSignalType; ///< @DEPRECATED_1_4.9 @brief Indicator state signal type @SINCE_1_0.0
71 typedef Signal< void (bool) > FocusSignalType; ///< @DEPRECATED_1_4.35 @brief Window focus signal type @SINCE_1_2.60
72 typedef Signal< void (WindowSize) > ResizedSignalType; ///< @DEPRECATED_1_4.35 @brief Window resized signal type @SINCE_1_2.60
73 typedef Signal< void (Window,bool) > FocusChangeSignalType; ///< Window focus signal type @SINCE_1_4.35
74 typedef Signal< void (Window,WindowSize) > ResizeSignalType; ///< Window resized signal type @SINCE_1_4.35
80 * @brief Enumeration for orientation of the window is the way in which a rectangular page is oriented for normal viewing.
83 enum WindowOrientation
85 PORTRAIT = 0, ///< Portrait orientation. The height of the display area is greater than the width. @SINCE_1_0.0
86 LANDSCAPE = 90, ///< Landscape orientation. A wide view area is needed. @SINCE_1_0.0
87 PORTRAIT_INVERSE = 180, ///< Portrait inverse orientation @SINCE_1_0.0
88 LANDSCAPE_INVERSE = 270 ///< Landscape inverse orientation @SINCE_1_0.0
93 * @brief Enumeration for opacity of the indicator.
96 enum IndicatorBgOpacity
98 OPAQUE = 100, ///< @DEPRECATED_1_4.9 @brief Fully opaque indicator Bg @SINCE_1_0.0
99 TRANSLUCENT = 50, ///< @DEPRECATED_1_4.9 @brief Semi translucent indicator Bg @SINCE_1_0.0
100 TRANSPARENT = 0 ///< @DEPRECATED_1_4.9 @brief Fully transparent indicator Bg @SINCE_1_0.0
105 * @brief Enumeration for visible mode of the indicator.
108 enum IndicatorVisibleMode
110 INVISIBLE = 0, ///< @DEPRECATED_1_4.9 @brief Hide indicator @SINCE_1_0.0
111 VISIBLE = 1, ///< @DEPRECATED_1_4.9 @brief Show indicator @SINCE_1_0.0
112 AUTO = 2 ///< @DEPRECATED_1_4.9 @brief Hide in default, will show when necessary @SINCE_1_0.0
116 * @brief An enum of Window types.
121 NORMAL, ///< A default window type. Indicates a normal, top-level window. Almost every window will be created with this type. @SINCE_1_2.60
122 NOTIFICATION, ///< A notification window, like a warning about battery life or a new E-Mail received. @SINCE_1_2.60
123 UTILITY, ///< A persistent utility window, like a toolbox or palette. @SINCE_1_2.60
124 DIALOG ///< Used for simple dialog windows. @SINCE_1_2.60
128 * @brief An enum of screen mode.
131 struct NotificationLevel
134 * @brief An enum of screen mode.
139 NONE = -1, ///< No notification level. Default level. This value makes the notification window place in the layer of the normal window. @SINCE_1_2.60
140 BASE = 10, ///< Base notification level. @SINCE_1_2.60
141 MEDIUM = 20, ///< Higher notification level than base. @SINCE_1_2.60
142 HIGH = 30, ///< Higher notification level than medium. @SINCE_1_2.60
143 TOP = 40 ///< The highest notification level. @SINCE_1_2.60
148 * @brief An enum of screen mode.
154 * @brief An enum of screen mode.
159 TIMEOUT, ///< The mode which turns the screen off after a timeout. @SINCE_1_2.60
160 NEVER, ///< The mode which keeps the screen turned on. @SINCE_1_2.60
163 static constexpr Type DEFAULT { TIMEOUT }; ///< The default mode. @SINCE_1_2.60
169 * @brief Creates an initialized handle to a new Window.
171 * @param[in] windowPosition The position and size of the Window
172 * @param[in] name The Window title
173 * @param[in] isTransparent Whether Window is transparent
174 * @return A new window
175 * @note This creates an extra window in addition to the default main window
177 static Window New(PositionSize windowPosition, const std::string& name, bool isTransparent = false);
180 * @brief Creates an initialized handle to a new Window.
182 * @param[in] windowPosition The position and size of the Window
183 * @param[in] name The Window title
184 * @param[in] className The Window class name
185 * @param[in] isTransparent Whether Window is transparent
186 * @note This creates an extra window in addition to the default main window
187 * @return A new Window
189 static Window New(PositionSize windowPosition, const std::string& name, const std::string& className, bool isTransparent = false);
192 * @brief Creates an uninitialized handle.
194 * This can be initialized using Dali::Application::GetWindow() or
195 * Dali::Window::New().
203 * This is non-virtual since derived Handle types must not contain data or virtual methods.
209 * @brief This copy constructor is required for (smart) pointer semantics.
212 * @param[in] handle A reference to the copied handle
214 Window(const Window& handle);
217 * @brief This assignment operator is required for (smart) pointer semantics.
220 * @param[in] rhs A reference to the copied handle
221 * @return A reference to this
223 Window& operator=(const Window& rhs);
226 * @brief Adds a child Actor to the Window.
228 * The child will be referenced.
231 * @param[in] actor The child
232 * @pre The actor has been initialized.
233 * @pre The actor does not have a parent.
235 void Add( Actor actor );
238 * @brief Removes a child Actor from the Window.
240 * The child will be unreferenced.
243 * @param[in] actor The child
244 * @pre The actor has been added to the stage.
246 void Remove( Actor actor );
249 * @brief Sets the background color of the Window.
252 * @param[in] color The new background color
254 void SetBackgroundColor( const Vector4& color );
257 * @brief Gets the background color of the Window.
260 * @return The background color
262 Vector4 GetBackgroundColor() const;
265 * @brief Returns the root Layer of the Window.
268 * @return The root layer
270 Layer GetRootLayer() const;
273 * @brief Queries the number of on-scene layers in the Window.
275 * Note that a default layer is always provided (count >= 1).
278 * @return The number of layers
280 uint32_t GetLayerCount() const;
283 * @brief Retrieves the layer at a specified depth in the Window.
286 * @param[in] depth The depth
287 * @return The layer found at the given depth
288 * @pre Depth is less than layer count; see GetLayerCount().
290 Layer GetLayer( uint32_t depth ) const;
294 * @brief This sets whether the indicator bar should be shown or not.
296 * @param[in] visibleMode Visible mode for indicator bar, VISIBLE in default
298 void ShowIndicator( IndicatorVisibleMode visibleMode ) DALI_DEPRECATED_API;
302 * @brief This sets the opacity mode of indicator bar.
304 * @param[in] opacity The opacity mode
306 void SetIndicatorBgOpacity( IndicatorBgOpacity opacity ) DALI_DEPRECATED_API;
310 * @brief This sets the orientation of indicator bar.
312 * It does not implicitly show the indicator if it is currently hidden.
314 * @param[in] orientation The orientation
316 void RotateIndicator(WindowOrientation orientation) DALI_DEPRECATED_API;
319 * @brief Sets the window name and class string.
321 * @param[in] name The name of the window
322 * @param[in] klass The class of the window
324 void SetClass(std::string name, std::string klass);
327 * @brief Raises window to the top of Window stack.
333 * @brief Lowers window to the bottom of Window stack.
339 * @brief Activates window to the top of Window stack even it is iconified.
345 * @brief Adds an orientation to the list of available orientations.
347 * @param[in] orientation The available orientation to add
349 void AddAvailableOrientation( WindowOrientation orientation );
352 * @brief Removes an orientation from the list of available orientations.
354 * @param[in] orientation The available orientation to remove
356 void RemoveAvailableOrientation( WindowOrientation orientation );
359 * @brief Sets a preferred orientation.
361 * @param[in] orientation The preferred orientation
362 * @pre Orientation is in the list of available orientations.
364 void SetPreferredOrientation( WindowOrientation orientation );
367 * @brief Gets the preferred orientation.
369 * @return The preferred orientation if previously set, or none
371 WindowOrientation GetPreferredOrientation();
374 * @DEPRECATED_1_4.19 Was not intended for Application developers
375 * @brief Returns an empty handle.
376 * @note Not intended for application developers.
378 * @return An empty handle
380 DragAndDropDetector GetDragAndDropDetector() const DALI_DEPRECATED_API;
383 * @brief Gets the native handle of the window.
385 * When users call this function, it wraps the actual type used by the underlying window system.
387 * @return The native handle of the Window or an empty handle
389 Any GetNativeHandle() const;
392 * @brief Sets whether window accepts focus or not.
395 * @param[in] accept If focus is accepted or not. Default is true.
397 void SetAcceptFocus( bool accept );
400 * @brief Returns whether window accepts focus or not.
403 * @return True if the window accept focus, false otherwise
405 bool IsFocusAcceptable() const;
408 * @brief Shows the window if it is hidden.
414 * @brief Hides the window if it is showing.
420 * @brief Returns whether the window is visible or not.
422 * @return True if the window is visible, false otherwise.
424 bool IsVisible() const;
427 * @brief Gets the count of supported auxiliary hints of the window.
429 * @return The number of supported auxiliary hints.
431 * @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.
432 * If you want to set specific hint to your window, then you should check whether it exists in the supported auxiliary hints.
434 unsigned int GetSupportedAuxiliaryHintCount() const;
437 * @brief Gets the supported auxiliary hint string of the window.
439 * @param[in] index The index of the supported auxiliary hint lists
440 * @return The auxiliary hint string of the index.
442 * @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.
443 * If you want to set specific hint to your window, then you should check whether it exists in the supported auxiliary hints.
445 std::string GetSupportedAuxiliaryHint( unsigned int index ) const;
448 * @brief Creates an auxiliary hint of the window.
450 * @param[in] hint The auxiliary hint string.
451 * @param[in] value The value string.
452 * @return The ID of created auxiliary hint, or @c 0 on failure.
454 unsigned int AddAuxiliaryHint( const std::string& hint, const std::string& value );
457 * @brief Removes an auxiliary hint of the window.
459 * @param[in] id The ID of the auxiliary hint.
460 * @return True if no error occurred, false otherwise.
462 bool RemoveAuxiliaryHint( unsigned int id );
465 * @brief Changes a value of the auxiliary hint.
467 * @param[in] id The auxiliary hint ID.
468 * @param[in] value The value string to be set.
469 * @return True if no error occurred, false otherwise.
471 bool SetAuxiliaryHintValue( unsigned int id, const std::string& value );
474 * @brief Gets a value of the auxiliary hint.
476 * @param[in] id The auxiliary hint ID.
477 * @return The string value of the auxiliary hint ID, or an empty string if none exists.
479 std::string GetAuxiliaryHintValue( unsigned int id ) const;
482 * @brief Gets a ID of the auxiliary hint string.
484 * @param[in] hint The auxiliary hint string.
485 * @return The ID of the auxiliary hint string, or @c 0 if none exists.
487 unsigned int GetAuxiliaryHintId( const std::string& hint ) const;
490 * @brief Sets a region to accept input events.
492 * @param[in] inputRegion The region to accept input events.
494 void SetInputRegion( const Rect< int >& inputRegion );
497 * @brief Sets a window type.
499 * @param[in] type The window type.
500 * @remarks The default window type is NORMAL.
502 void SetType( Type type );
505 * @brief Gets a window type.
507 * @return A window type.
509 Type GetType() const;
512 * @brief Sets a priority level for the specified notification window.
514 * @param[in] level The notification window level.
515 * @return True if no error occurred, false otherwise.
517 * @PRIVILEGE_WINDOW_PRIORITY
518 * @remarks This can be used for a notification type window only. The default level is NotificationLevel::NONE.
520 bool SetNotificationLevel( NotificationLevel::Type level );
523 * @brief Gets a priority level for the specified notification window.
525 * @return The notification window level.
526 * @remarks This can be used for a notification type window only.
528 NotificationLevel::Type GetNotificationLevel() const;
531 * @brief Sets a transparent window's visual state to opaque.
532 * @details If a visual state of a transparent window is opaque,
533 * then the window manager could handle it as an opaque window when calculating visibility.
535 * @param[in] opaque Whether the window's visual state is opaque.
536 * @remarks This will have no effect on an opaque window.
537 * It doesn't change transparent window to opaque window but lets the window manager know the visual state of the window.
539 void SetOpaqueState( bool opaque );
542 * @brief Returns whether a transparent window's visual state is opaque or not.
544 * @return True if the window's visual state is opaque, false otherwise.
545 * @remarks The return value has no meaning on an opaque window.
547 bool IsOpaqueState() const;
550 * @brief Sets a window's screen off mode.
551 * @details This API is useful when the application needs to keep the display turned on.
552 * If the application sets the screen mode to #::Dali::Window::ScreenOffMode::NEVER to its window and the window is shown,
553 * the window manager requests the display system to keep the display on as long as the window is shown.
554 * If the window is no longer shown, then the window manager requests the display system to go back to normal operation.
556 * @param[in] screenOffMode The screen mode.
557 * @return True if no error occurred, false otherwise.
561 bool SetScreenOffMode(ScreenOffMode::Type screenOffMode);
564 * @brief Gets a screen off mode of the window.
566 * @return The screen off mode.
568 ScreenOffMode::Type GetScreenOffMode() const;
571 * @brief Sets preferred brightness of the window.
572 * @details This API is useful when the application needs to change the brightness of the screen when it is appeared on the screen.
573 * If the brightness has been set and the window is shown, the window manager requests the display system to change the brightness to the provided value.
574 * If the window is no longer shown, then the window manager requests the display system to go back to default brightness.
575 * A value less than 0 results in default brightness and a value greater than 100 results in maximum brightness.
577 * @param[in] brightness The preferred brightness (0 to 100).
578 * @return True if no error occurred, false otherwise.
582 bool SetBrightness( int brightness );
585 * @brief Gets preferred brightness of the window.
587 * @return The preferred brightness.
589 int GetBrightness() const;
592 * @brief Sets a size of the window.
595 * @param[in] size The new window size
597 void SetSize( WindowSize size );
600 * @brief Gets a size of the window.
603 * @return The size of the window
605 WindowSize GetSize() const;
608 * @brief Sets a position of the window.
611 * @param[in] position The new window position
613 void SetPosition( WindowPosition position );
616 * @brief Gets a position of the window.
619 * @return The position of the window
621 WindowPosition GetPosition() const;
624 * @brief Sets whether the window is transparent or not.
627 * @param[in] transparent Whether the window is transparent
629 void SetTransparency( bool transparent );
634 * @brief The user should connect to this signal to get a timing when indicator was shown / hidden.
636 * @return The signal to connect to
638 IndicatorSignalType& IndicatorVisibilityChangedSignal() DALI_DEPRECATED_API;
642 * @brief The user should connect to this signal to get a timing when window gains focus or loses focus.
644 * A callback of the following type may be connected:
646 * void YourCallbackName( bool focusIn );
648 * The parameter is true if window gains focus, otherwise false.
651 * @return The signal to connect to
653 FocusSignalType& FocusChangedSignal() DALI_DEPRECATED_API;
656 * @brief This signal is emitted when the window is resized.
658 * A callback of the following type may be connected:
660 * void YourCallbackName( int width, int height );
662 * The parameters are the resized width and height.
665 * @return The signal to connect to
667 ResizedSignalType& ResizedSignal() DALI_DEPRECATED_API;
670 * @brief The user should connect to this signal to get a timing when window gains focus or loses focus.
672 * A callback of the following type may be connected:
674 * void YourCallbackName( Window window, bool focusIn );
676 * The parameter is true if window gains focus, otherwise false.
677 * and window means this signal was called from what window
680 * @return The signal to connect to
682 FocusChangeSignalType& FocusChangeSignal();
685 * @brief This signal is emitted when the window is resized.
687 * A callback of the following type may be connected:
689 * void YourCallbackName( Window window, int width, int height );
691 * The parameters are the resized width and height.
692 * and window means this signal was called from what window
695 * @return The signal to connect to
697 ResizeSignalType& ResizeSignal();
699 public: // Not intended for application developers
702 * @brief This constructor is used by Dali::Application::GetWindow().
704 * @param[in] window A pointer to the Window
706 explicit DALI_INTERNAL Window( Internal::Adaptor::Window* window );
715 #endif // __DALI_WINDOW_H__