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>
40 * @addtogroup dali_adaptor_framework
44 typedef Dali::Rect<int> PositionSize;
46 namespace Internal DALI_INTERNAL
54 class DragAndDropDetector;
60 * @brief The window class is used internally for drawing.
62 * A Window has an orientation and indicator properties.
63 * You can get a valid Window handle by calling Dali::Application::GetWindow().
66 class DALI_ADAPTOR_API Window : public BaseHandle
70 typedef Uint16Pair WindowSize; ///< Window size type @SINCE_1_2.60
71 typedef Uint16Pair WindowPosition; ///< Window position type @SINCE_1_2.60
73 typedef Signal< void (bool) > IndicatorSignalType; ///< @DEPRECATED_1_4.9 @brief Indicator state signal type @SINCE_1_0.0
74 typedef Signal< void (bool) > FocusSignalType; ///< @DEPRECATED_1_4.35 @brief Window focus signal type @SINCE_1_2.60
75 typedef Signal< void (WindowSize) > ResizedSignalType; ///< @DEPRECATED_1_4.35 @brief Window resized signal type @SINCE_1_2.60
76 typedef Signal< void (Window,bool) > FocusChangeSignalType; ///< Window focus signal type @SINCE_1_4.35
77 typedef Signal< void (Window,WindowSize) > ResizeSignalType; ///< Window resized signal type @SINCE_1_4.35
83 * @brief Enumeration for orientation of the window is the way in which a rectangular page is oriented for normal viewing.
85 * This Enumeration is used the available orientation APIs and the preferred orientation.
89 enum WindowOrientation
91 PORTRAIT = 0, ///< Portrait orientation. The height of the display area is greater than the width. @SINCE_1_0.0
92 LANDSCAPE = 90, ///< Landscape orientation. A wide view area is needed. @SINCE_1_0.0
93 PORTRAIT_INVERSE = 180, ///< Portrait inverse orientation @SINCE_1_0.0
94 LANDSCAPE_INVERSE = 270, ///< Landscape inverse orientation @SINCE_1_0.0
95 NO_ORIENTATION_PREFERENCE = -1 ///< No orientation. It is used to initialize or unset the preferred orientation. @SINCE_1_4.51
100 * @brief Enumeration for opacity of the indicator.
103 enum IndicatorBgOpacity
105 OPAQUE = 100, ///< @DEPRECATED_1_4.9 @brief Fully opaque indicator Bg @SINCE_1_0.0
106 TRANSLUCENT = 50, ///< @DEPRECATED_1_4.9 @brief Semi translucent indicator Bg @SINCE_1_0.0
107 TRANSPARENT = 0 ///< @DEPRECATED_1_4.9 @brief Fully transparent indicator Bg @SINCE_1_0.0
112 * @brief Enumeration for visible mode of the indicator.
115 enum IndicatorVisibleMode
117 INVISIBLE = 0, ///< @DEPRECATED_1_4.9 @brief Hide indicator @SINCE_1_0.0
118 VISIBLE = 1, ///< @DEPRECATED_1_4.9 @brief Show indicator @SINCE_1_0.0
119 AUTO = 2 ///< @DEPRECATED_1_4.9 @brief Hide in default, will show when necessary @SINCE_1_0.0
123 * @brief An enum of Window types.
128 NORMAL, ///< A default window type. Indicates a normal, top-level window. Almost every window will be created with this type. @SINCE_1_2.60
129 NOTIFICATION, ///< A notification window, like a warning about battery life or a new E-Mail received. @SINCE_1_2.60
130 UTILITY, ///< A persistent utility window, like a toolbox or palette. @SINCE_1_2.60
131 DIALOG ///< Used for simple dialog windows. @SINCE_1_2.60
135 * @brief An enum of screen mode.
138 struct NotificationLevel
141 * @brief An enum of screen mode.
146 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
147 BASE = 10, ///< Base notification level. @SINCE_1_2.60
148 MEDIUM = 20, ///< Higher notification level than base. @SINCE_1_2.60
149 HIGH = 30, ///< Higher notification level than medium. @SINCE_1_2.60
150 TOP = 40 ///< The highest notification level. @SINCE_1_2.60
155 * @brief An enum of screen mode.
161 * @brief An enum of screen mode.
166 TIMEOUT, ///< The mode which turns the screen off after a timeout. @SINCE_1_2.60
167 NEVER, ///< The mode which keeps the screen turned on. @SINCE_1_2.60
170 static constexpr Type DEFAULT { TIMEOUT }; ///< The default mode. @SINCE_1_2.60
176 * @brief Creates an initialized handle to a new Window.
178 * @param[in] windowPosition The position and size of the Window
179 * @param[in] name The Window title
180 * @param[in] isTransparent Whether Window is transparent
181 * @return A new window
182 * @note This creates an extra window in addition to the default main window
184 static Window New(PositionSize windowPosition, const std::string& name, bool isTransparent = false);
187 * @brief Creates an initialized handle to a new Window.
189 * @param[in] windowPosition The position and size of the Window
190 * @param[in] name The Window title
191 * @param[in] className The Window class name
192 * @param[in] isTransparent Whether Window is transparent
193 * @note This creates an extra window in addition to the default main window
194 * @return A new Window
196 static Window New(PositionSize windowPosition, const std::string& name, const std::string& className, bool isTransparent = false);
199 * @brief Creates an uninitialized handle.
201 * This can be initialized using Dali::Application::GetWindow() or
202 * Dali::Window::New().
210 * This is non-virtual since derived Handle types must not contain data or virtual methods.
216 * @brief This copy constructor is required for (smart) pointer semantics.
219 * @param[in] handle A reference to the copied handle
221 Window(const Window& handle);
224 * @brief This assignment operator is required for (smart) pointer semantics.
227 * @param[in] rhs A reference to the copied handle
228 * @return A reference to this
230 Window& operator=(const Window& rhs);
233 * @brief Adds a child Actor to the Window.
235 * The child will be referenced.
238 * @param[in] actor The child
239 * @pre The actor has been initialized.
240 * @pre The actor does not have a parent.
242 void Add( Actor actor );
245 * @brief Removes a child Actor from the Window.
247 * The child will be unreferenced.
250 * @param[in] actor The child
251 * @pre The actor has been added to the stage.
253 void Remove( Actor actor );
256 * @brief Sets the background color of the Window.
259 * @param[in] color The new background color
261 void SetBackgroundColor( const Vector4& color );
264 * @brief Gets the background color of the Window.
267 * @return The background color
269 Vector4 GetBackgroundColor() const;
272 * @brief Returns the root Layer of the Window.
275 * @return The root layer
277 Layer GetRootLayer() const;
280 * @brief Queries the number of on-scene layers in the Window.
282 * Note that a default layer is always provided (count >= 1).
285 * @return The number of layers
287 uint32_t GetLayerCount() const;
290 * @brief Retrieves the layer at a specified depth in the Window.
293 * @param[in] depth The depth
294 * @return The layer found at the given depth
295 * @pre Depth is less than layer count; see GetLayerCount().
297 Layer GetLayer( uint32_t depth ) const;
301 * @brief This sets whether the indicator bar should be shown or not.
303 * @param[in] visibleMode Visible mode for indicator bar, VISIBLE in default
305 void ShowIndicator( IndicatorVisibleMode visibleMode ) DALI_DEPRECATED_API;
309 * @brief This sets the opacity mode of indicator bar.
311 * @param[in] opacity The opacity mode
313 void SetIndicatorBgOpacity( IndicatorBgOpacity opacity ) DALI_DEPRECATED_API;
317 * @brief This sets the orientation of indicator bar.
319 * It does not implicitly show the indicator if it is currently hidden.
321 * @param[in] orientation The orientation
323 void RotateIndicator(WindowOrientation orientation) DALI_DEPRECATED_API;
326 * @brief Sets the window name and class string.
328 * @param[in] name The name of the window
329 * @param[in] klass The class of the window
331 void SetClass(std::string name, std::string klass);
334 * @brief Raises window to the top of Window stack.
340 * @brief Lowers window to the bottom of Window stack.
346 * @brief Activates window to the top of Window stack even it is iconified.
352 * @brief Adds an orientation to the list of available orientations.
354 * @param[in] orientation The available orientation to add
356 void AddAvailableOrientation( WindowOrientation orientation );
359 * @brief Removes an orientation from the list of available orientations.
361 * @param[in] orientation The available orientation to remove
363 void RemoveAvailableOrientation( WindowOrientation orientation );
366 * @brief Sets a preferred orientation.
368 * @param[in] orientation The preferred orientation
369 * @pre Orientation is in the list of available orientations.
371 * @note To unset the preferred orientation, orientation should be set NO_ORIENTATION_PREFERENCE.
373 void SetPreferredOrientation( WindowOrientation orientation );
376 * @brief Gets the preferred orientation.
378 * @return The preferred orientation if previously set, or none
380 WindowOrientation GetPreferredOrientation();
383 * @DEPRECATED_1_4.19 Was not intended for Application developers
384 * @brief Returns an empty handle.
385 * @note Not intended for application developers.
387 * @return An empty handle
389 DragAndDropDetector GetDragAndDropDetector() const DALI_DEPRECATED_API;
392 * @brief Gets the native handle of the window.
394 * When users call this function, it wraps the actual type used by the underlying window system.
396 * @return The native handle of the Window or an empty handle
398 Any GetNativeHandle() const;
401 * @brief Sets whether window accepts focus or not.
404 * @param[in] accept If focus is accepted or not. Default is true.
406 void SetAcceptFocus( bool accept );
409 * @brief Returns whether window accepts focus or not.
412 * @return True if the window accept focus, false otherwise
414 bool IsFocusAcceptable() const;
417 * @brief Shows the window if it is hidden.
423 * @brief Hides the window if it is showing.
429 * @brief Returns whether the window is visible or not.
431 * @return True if the window is visible, false otherwise.
433 bool IsVisible() const;
436 * @brief Gets the count of supported auxiliary hints of the window.
438 * @return The number of supported auxiliary hints.
440 * @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.
441 * If you want to set specific hint to your window, then you should check whether it exists in the supported auxiliary hints.
443 unsigned int GetSupportedAuxiliaryHintCount() const;
446 * @brief Gets the supported auxiliary hint string of the window.
448 * @param[in] index The index of the supported auxiliary hint lists
449 * @return The auxiliary hint string of the index.
451 * @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.
452 * If you want to set specific hint to your window, then you should check whether it exists in the supported auxiliary hints.
454 std::string GetSupportedAuxiliaryHint( unsigned int index ) const;
457 * @brief Creates an auxiliary hint of the window.
459 * @param[in] hint The auxiliary hint string.
460 * @param[in] value The value string.
461 * @return The ID of created auxiliary hint, or @c 0 on failure.
463 unsigned int AddAuxiliaryHint( const std::string& hint, const std::string& value );
466 * @brief Removes an auxiliary hint of the window.
468 * @param[in] id The ID of the auxiliary hint.
469 * @return True if no error occurred, false otherwise.
471 bool RemoveAuxiliaryHint( unsigned int id );
474 * @brief Changes a value of the auxiliary hint.
476 * @param[in] id The auxiliary hint ID.
477 * @param[in] value The value string to be set.
478 * @return True if no error occurred, false otherwise.
480 bool SetAuxiliaryHintValue( unsigned int id, const std::string& value );
483 * @brief Gets a value of the auxiliary hint.
485 * @param[in] id The auxiliary hint ID.
486 * @return The string value of the auxiliary hint ID, or an empty string if none exists.
488 std::string GetAuxiliaryHintValue( unsigned int id ) const;
491 * @brief Gets a ID of the auxiliary hint string.
493 * @param[in] hint The auxiliary hint string.
494 * @return The ID of the auxiliary hint string, or @c 0 if none exists.
496 unsigned int GetAuxiliaryHintId( const std::string& hint ) const;
499 * @brief Sets a region to accept input events.
501 * @param[in] inputRegion The region to accept input events.
503 void SetInputRegion( const Rect< int >& inputRegion );
506 * @brief Sets a window type.
508 * @param[in] type The window type.
509 * @remarks The default window type is NORMAL.
511 void SetType( Type type );
514 * @brief Gets a window type.
516 * @return A window type.
518 Type GetType() const;
521 * @brief Sets a priority level for the specified notification window.
523 * @param[in] level The notification window level.
524 * @return True if no error occurred, false otherwise.
526 * @PRIVILEGE_WINDOW_PRIORITY
527 * @remarks This can be used for a notification type window only. The default level is NotificationLevel::NONE.
529 bool SetNotificationLevel( NotificationLevel::Type level );
532 * @brief Gets a priority level for the specified notification window.
534 * @return The notification window level.
535 * @remarks This can be used for a notification type window only.
537 NotificationLevel::Type GetNotificationLevel() const;
540 * @brief Sets a transparent window's visual state to opaque.
541 * @details If a visual state of a transparent window is opaque,
542 * then the window manager could handle it as an opaque window when calculating visibility.
544 * @param[in] opaque Whether the window's visual state is opaque.
545 * @remarks This will have no effect on an opaque window.
546 * It doesn't change transparent window to opaque window but lets the window manager know the visual state of the window.
548 void SetOpaqueState( bool opaque );
551 * @brief Returns whether a transparent window's visual state is opaque or not.
553 * @return True if the window's visual state is opaque, false otherwise.
554 * @remarks The return value has no meaning on an opaque window.
556 bool IsOpaqueState() const;
559 * @brief Sets a window's screen off mode.
560 * @details This API is useful when the application needs to keep the display turned on.
561 * If the application sets the screen mode to #::Dali::Window::ScreenOffMode::NEVER to its window and the window is shown,
562 * the window manager requests the display system to keep the display on as long as the window is shown.
563 * If the window is no longer shown, then the window manager requests the display system to go back to normal operation.
565 * @param[in] screenOffMode The screen mode.
566 * @return True if no error occurred, false otherwise.
570 bool SetScreenOffMode(ScreenOffMode::Type screenOffMode);
573 * @brief Gets a screen off mode of the window.
575 * @return The screen off mode.
577 ScreenOffMode::Type GetScreenOffMode() const;
580 * @brief Sets preferred brightness of the window.
581 * @details This API is useful when the application needs to change the brightness of the screen when it is appeared on the screen.
582 * 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.
583 * If the window is no longer shown, then the window manager requests the display system to go back to default brightness.
584 * A value less than 0 results in default brightness and a value greater than 100 results in maximum brightness.
586 * @param[in] brightness The preferred brightness (0 to 100).
587 * @return True if no error occurred, false otherwise.
591 bool SetBrightness( int brightness );
594 * @brief Gets preferred brightness of the window.
596 * @return The preferred brightness.
598 int GetBrightness() const;
601 * @brief Sets a size of the window.
604 * @param[in] size The new window size
606 void SetSize( WindowSize size );
609 * @brief Gets a size of the window.
612 * @return The size of the window
614 WindowSize GetSize() const;
617 * @brief Sets a position of the window.
620 * @param[in] position The new window position
622 void SetPosition( WindowPosition position );
625 * @brief Gets a position of the window.
628 * @return The position of the window
630 WindowPosition GetPosition() const;
633 * @brief Sets whether the window is transparent or not.
636 * @param[in] transparent Whether the window is transparent
638 void SetTransparency( bool transparent );
643 * @brief The user should connect to this signal to get a timing when indicator was shown / hidden.
645 * @return The signal to connect to
647 IndicatorSignalType& IndicatorVisibilityChangedSignal() DALI_DEPRECATED_API;
651 * @brief The user should connect to this signal to get a timing when window gains focus or loses focus.
653 * A callback of the following type may be connected:
655 * void YourCallbackName( bool focusIn );
657 * The parameter is true if window gains focus, otherwise false.
660 * @return The signal to connect to
662 FocusSignalType& FocusChangedSignal() DALI_DEPRECATED_API;
665 * @brief This signal is emitted when the window is resized.
667 * A callback of the following type may be connected:
669 * void YourCallbackName( int width, int height );
671 * The parameters are the resized width and height.
674 * @return The signal to connect to
676 ResizedSignalType& ResizedSignal() DALI_DEPRECATED_API;
679 * @brief The user should connect to this signal to get a timing when window gains focus or loses focus.
681 * A callback of the following type may be connected:
683 * void YourCallbackName( Window window, bool focusIn );
685 * The parameter is true if window gains focus, otherwise false.
686 * and window means this signal was called from what window
689 * @return The signal to connect to
691 FocusChangeSignalType& FocusChangeSignal();
694 * @brief This signal is emitted when the window is resized.
696 * A callback of the following type may be connected:
698 * void YourCallbackName( Window window, int width, int height );
700 * The parameters are the resized width and height.
701 * and window means this signal was called from what window
704 * @return The signal to connect to
706 ResizeSignalType& ResizeSignal();
708 public: // Not intended for application developers
711 * @brief This constructor is used by Dali::Application::GetWindow().
713 * @param[in] window A pointer to the Window
715 explicit DALI_INTERNAL Window( Internal::Adaptor::Window* window );
724 #endif // __DALI_WINDOW_H__