Add Overlay Layer in window

[platform/core/uifw/dali-adaptor.git] / dali / public-api / adaptor-framework / window.h

diff --git a/dali/public-api/adaptor-framework/window.h b/dali/public-api/adaptor-framework/window.h
index 527da6b..e432d6f 100644 (file)
--- a/dali/public-api/adaptor-framework/window.h
+++ b/dali/public-api/adaptor-framework/window.h
@@ -2,7 +2,7 @@
 #define DALI_WINDOW_H
 
 /*
- * Copyright (c) 2020 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2022 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.
@@ -19,6 +19,8 @@
  */
 
 // EXTERNAL INCLUDES
+#include <dali/public-api/adaptor-framework/window-enumerations.h>
+#include <dali/public-api/math/int-pair.h>
 #include <dali/public-api/math/rect.h>
 #include <dali/public-api/math/uint-16-pair.h>
 #include <dali/public-api/math/vector2.h>
@@ -26,7 +28,6 @@
 #include <dali/public-api/object/any.h>
 #include <dali/public-api/object/base-handle.h>
 #include <dali/public-api/signals/dali-signal.h>
-#include <dali/public-api/adaptor-framework/window-enumerations.h>
 #include <string>
 
 // INTERNAL INCLUDES
@@ -71,7 +72,7 @@ class DALI_ADAPTOR_API Window : public BaseHandle
 {
 public:
   using WindowSize     = Uint16Pair; ///< Window size type @SINCE_1_2.60
-  using WindowPosition = Uint16Pair; ///< Window position type @SINCE_1_2.60
+  using WindowPosition = Int32Pair;  ///< Window position type @SINCE_2_1.45
 
   using FocusChangeSignalType = Signal<void(Window, bool)>;       ///< Window focus signal type @SINCE_1_4.35
   using ResizeSignalType      = Signal<void(Window, WindowSize)>; ///< Window resized signal type @SINCE_1_4.35
@@ -79,7 +80,6 @@ public:
   using TouchEventSignalType  = Signal<void(const TouchEvent&)>;  ///< Touch signal type @SINCE_1_9.28
 
 public:
-
   // Methods
 
   /**
@@ -157,6 +157,15 @@ public:
   Window& operator=(Window&& rhs);
 
   /**
+   * @brief Downcast sceneHolder to window
+   *
+   * @SINCE_2_1.46
+   * @param[in] handle The handle need to downcast
+   * @return Whether it's a valid window or not
+   */
+  static Window DownCast(BaseHandle handle);
+
+  /**
    * @brief Adds a child Actor to the Window.
    *
    * The child will be referenced.
@@ -204,6 +213,16 @@ public:
   Layer GetRootLayer() const;
 
   /**
+   * @brief Returns the overlay Layer of the Window.
+   * If there isn't overlay layer yet, this method create overlay layer and
+   * exclusive render task internally.
+   *
+   * @SINCE_2_2.10
+   * @return The root layer
+   */
+  Layer GetOverlayLayer();
+
+  /**
    * @brief Queries the number of on-scene layers in the Window.
    *
    * Note that a default layer is always provided (count >= 1).
@@ -421,12 +440,12 @@ public:
    * @brief Sets a priority level for the specified notification window.
    * @@SINCE_2_0.0
    * @param[in] level The notification window level.
-   * @return True if no error occurred, false otherwise.
+   * @return The result of the window operation.
    * @PRIVLEVEL_PUBLIC
    * @PRIVILEGE_WINDOW_PRIORITY
    * @remarks This can be used for a notification type window only. The default level is NotificationLevel::NONE.
    */
-  bool SetNotificationLevel(WindowNotificationLevel level);
+  WindowOperationResult SetNotificationLevel(WindowNotificationLevel level);
 
   /**
    * @brief Gets a priority level for the specified notification window.
@@ -463,11 +482,11 @@ public:
    * If the window is no longer shown, then the window manager requests the display system to go back to normal operation.
    * @@SINCE_2_0.0
    * @param[in] screenOffMode The screen mode.
-   * @return True if no error occurred, false otherwise.
+   * @return The result of the window operation.
    * @PRIVLEVEL_PUBLIC
    * @PRIVILEGE_DISPLAY
    */
-  bool SetScreenOffMode(WindowScreenOffMode screenOffMode);
+  WindowOperationResult SetScreenOffMode(WindowScreenOffMode screenOffMode);
 
   /**
    * @brief Gets a screen off mode of the window.
@@ -484,11 +503,11 @@ public:
    * A value less than 0 results in default brightness and a value greater than 100 results in maximum brightness.
    * @SINCE_1_2.60
    * @param[in] brightness The preferred brightness (0 to 100).
-   * @return True if no error occurred, false otherwise.
+   * @return The result of the window operation.
    * @PRIVLEVEL_PUBLIC
    * @PRIVILEGE_DISPLAY
    */
-  bool SetBrightness(int brightness);
+  WindowOperationResult SetBrightness(int brightness);
 
   /**
    * @brief Gets preferred brightness of the window.