Modify API name and the description of window APIs.

Modify API name as Bottom mode and the description fo window API AlwaysOnTop and fix the white space.

Change-Id: Idf1773519d4b1df220b5a32438cecdbd5a6128d1

diff --git a/dali/devel-api/adaptor-framework/window-devel.cpp b/dali/devel-api/adaptor-framework/window-devel.cpp
index 37a107cc5381e67ad13243504da42b505e0efab4..8f3456d68b5d4cc8fce921936766f942dec43f70 100644 (file)
--- a/dali/devel-api/adaptor-framework/window-devel.cpp
+++ b/dali/devel-api/adaptor-framework/window-devel.cpp
@@ -389,9 +389,9 @@ bool IsAlwaysOnTop(Window window)
   return GetImplementation(window).IsAlwaysOnTop();
 }
 
-void SetToBottom(Window window, bool toBottom)
+void SetBottom(Window window, bool enable)
 {
-  GetImplementation(window).SetToBottom(toBottom);
+  GetImplementation(window).SetBottom(enable);
 }
 
 bool IsBottom(Window window)

diff --git a/dali/devel-api/adaptor-framework/window-devel.h b/dali/devel-api/adaptor-framework/window-devel.h
index 34e06e17eb7a29b5f7c88ca5b1a13cf777ca05ea..e2ab62566653fef8503b483d44beb66acc0161d1 100644 (file)
--- a/dali/devel-api/adaptor-framework/window-devel.h
+++ b/dali/devel-api/adaptor-framework/window-devel.h
@@ -685,7 +685,9 @@ DALI_ADAPTOR_API bool IsModal(Window window);
 
 /**
  * @brief Enables or disables the window always is on top.
- * 
+ *
+ * This is valid between windows that have no notification level or a notification level of 'none'.
+ * If it has a notification level, this will not do anything.
  *
  * @param[in] window The window instance.
  * @param[in] alwaysOnTop true to enable the window always is on top, false to disable.
@@ -695,21 +697,21 @@ DALI_ADAPTOR_API void SetAlwaysOnTop(Window window, bool alwaysOnTop);
 /**
  * @brief Returns whether the window always is on top.
  *
- * This is valid between windows that have no notification level or a notification level of 'none'.
- * If it has a notification level, this will not do anything.
- *
  * @param[in] window The window instance.
  * @return True if the window always is on top, false otherwise.
  */
 DALI_ADAPTOR_API bool IsAlwaysOnTop(Window window);
 
 /**
- * @brief Enables or disables the window's layer is changed to the bottom.
+ * @brief Enables or disables the window's layer is changed to bottom.
+ *
+ * If the enable flag is true, this window will be placed below other windows.
+ * Otherwise, if it's called with a false value, it will be located above other windows.
  *
  * @param[in] window The window instance.
- * @param[in] toBottom true to change the window layer to the bottom.
+ * @param[in] enable true to change the window layer to the bottom.
  */
-DALI_ADAPTOR_API void SetToBottom(Window window, bool toBottom);
+DALI_ADAPTOR_API void SetBottom(Window window, bool enable);
 
 /**
  * @brief Returns whether the window layer is the bottom or not.

diff --git a/dali/internal/window-system/android/window-base-android.cpp b/dali/internal/window-system/android/window-base-android.cpp
index 75e37e64adc906f1713b5f92f71db6bb08f6acbe..cb9aea66de4ac545a3ad3245995ae8fd0ee7522c 100644 (file)
--- a/dali/internal/window-system/android/window-base-android.cpp
+++ b/dali/internal/window-system/android/window-base-android.cpp
@@ -516,7 +516,7 @@ bool WindowBaseAndroid::IsAlwaysOnTop()
   return false;
 }
 
-void WindowBaseAndroid::SetToBottom(bool toBottom)
+void WindowBaseAndroid::SetBottom(bool enable)
 {
 }
 

diff --git a/dali/internal/window-system/android/window-base-android.h b/dali/internal/window-system/android/window-base-android.h
index e6db23f5b04de09e24bcc6d9f9af7211d0abae8b..a7ffb96ba52d9e6bc3fd79f118fc720ea5bfbfa6 100644 (file)
--- a/dali/internal/window-system/android/window-base-android.h
+++ b/dali/internal/window-system/android/window-base-android.h
@@ -540,9 +540,9 @@ public:
   bool IsAlwaysOnTop() override;
 
   /**
-   * @copydoc Dali::Internal::Adaptor::WindowBase::SetToBottom()
+   * @copydoc Dali::Internal::Adaptor::WindowBase::SetBottom()
    */
-  void SetToBottom(bool toBottom) override;
+  void SetBottom(bool enable) override;
 
   /**
    * @copydoc Dali::Internal::Adaptor::WindowBase::IsBottom()

diff --git a/dali/internal/window-system/common/window-base.h b/dali/internal/window-system/common/window-base.h
index 91b2dd26c8fcc8d5a7ba53aaa2af1ef4fb2339c0..5afb0848aaeca3ba158dae43d94d80f60d85369e 100644 (file)
--- a/dali/internal/window-system/common/window-base.h
+++ b/dali/internal/window-system/common/window-base.h
@@ -597,11 +597,15 @@ public:
   virtual bool IsAlwaysOnTop() = 0;
 
   /**
-   * @brief Enables or disables the window's layer is changed to the bottom.
+   * @brief Enables or disables the window's layer is changed to bottom.
    *
-   * @param[in] toBottom true to change the window layer to the bottom.
+   * If the enable flag is true, this window will be placed below other windows.
+   * Otherwise, if it's called with a false value, it will be located above other windows.
+   *
+   * @param[in] window The window instance.
+   * @param[in] enable true to change the window layer to the bottom.
    */
-  virtual void SetToBottom(bool toBottom) = 0;
+  virtual void SetBottom(bool enable) = 0;
 
   /**
    * @brief Returns whether the window layer is the bottom or not.

diff --git a/dali/internal/window-system/common/window-impl.cpp b/dali/internal/window-system/common/window-impl.cpp
index df760143b49f6eb1cf9f08b211257bc1bee4075d..6282dfb5f79f7875d3ca03034b849c79335d4387 100644 (file)
--- a/dali/internal/window-system/common/window-impl.cpp
+++ b/dali/internal/window-system/common/window-impl.cpp
@@ -1649,9 +1649,9 @@ bool Window::IsAlwaysOnTop()
   return mWindowBase->IsAlwaysOnTop();
 }
 
-void Window::SetToBottom(bool toBottom)
+void Window::SetBottom(bool enable)
 {
-  mWindowBase->SetToBottom(toBottom);
+  mWindowBase->SetBottom(enable);
 }
 
 bool Window::IsBottom()

diff --git a/dali/internal/window-system/common/window-impl.h b/dali/internal/window-system/common/window-impl.h
index c995aed9eccba5989f6521e7dc0c65dcb03d1ed6..3c31b00ab00f07a9472db3adb6a352c15c4ff185 100644 (file)
--- a/dali/internal/window-system/common/window-impl.h
+++ b/dali/internal/window-system/common/window-impl.h
@@ -603,9 +603,9 @@ public: // Dali::Internal::Adaptor::SceneHolder
   bool IsAlwaysOnTop();
 
   /**
-   * @copydoc Dali::DevelWindow::SetToBottom()
+   * @copydoc Dali::DevelWindow::SetBottom()
    */
-  void SetToBottom(bool toBottom);
+  void SetBottom(bool enable);
 
   /**
    * @copydoc Dali::DevelWindow::IsBottom()

diff --git a/dali/internal/window-system/macos/window-base-mac.h b/dali/internal/window-system/macos/window-base-mac.h
index 114e95af208ae68590bf36c344c142de302590eb..fd50d91de44cd4b2e404a71b468e26a5d08e8f91 100644 (file)
--- a/dali/internal/window-system/macos/window-base-mac.h
+++ b/dali/internal/window-system/macos/window-base-mac.h
@@ -468,9 +468,9 @@ public:
   bool IsAlwaysOnTop() override;
 
   /**
-   * @copydoc Dali::Internal::Adaptor::WindowBase::SetToBottom()
+   * @copydoc Dali::Internal::Adaptor::WindowBase::SetBottom()
    */
-  void SetToBottom(bool toBottom) override;
+  void SetBottom(bool enable) override;
 
   /**
    * @copydoc Dali::Internal::Adaptor::WindowBase::IsBottom()

diff --git a/dali/internal/window-system/macos/window-base-mac.mm b/dali/internal/window-system/macos/window-base-mac.mm
index ca471b1a259d3ae3470e1e6bdc3e94512d6da04a..a414e0529ae4f2bbfeb67922e2490f11ca5c6730 100644 (file)
--- a/dali/internal/window-system/macos/window-base-mac.mm
+++ b/dali/internal/window-system/macos/window-base-mac.mm
@@ -824,7 +824,7 @@ bool WindowBaseCocoa::IsAlwaysOnTop()
   return false;
 }
 
-void WindowBaseCocoa::SetToBottom(bool toBottom)
+void WindowBaseCocoa::SetBottom(bool enable)
 {
 }
 

diff --git a/dali/internal/window-system/tizen-wayland/ecore-wl2/window-base-ecore-wl2.cpp b/dali/internal/window-system/tizen-wayland/ecore-wl2/window-base-ecore-wl2.cpp
index 1ea0a044db196633d06f2626b7fca3d31ea036e0..6027bb16d1d2498668c4fa1dd40d62af11d6a65b 100644 (file)
--- a/dali/internal/window-system/tizen-wayland/ecore-wl2/window-base-ecore-wl2.cpp
+++ b/dali/internal/window-system/tizen-wayland/ecore-wl2/window-base-ecore-wl2.cpp
@@ -937,7 +937,7 @@ WindowBaseEcoreWl2::WindowBaseEcoreWl2(Dali::PositionSize positionSize, Any surf
   mBrightnessChangeDone(true),
   mIsFrontBufferRendering(false),
   mIsIMEWindowInitialized(false),
-  mToBottom(false)
+  mBottom(false)
 {
   Initialize(positionSize, surface, isTransparent);
 }
@@ -3702,27 +3702,27 @@ bool WindowBaseEcoreWl2::IsAlwaysOnTop()
   return ret;
 }
 
-void WindowBaseEcoreWl2::SetToBottom(bool toBottom)
+void WindowBaseEcoreWl2::SetBottom(bool enable)
 {
   START_DURATION_CHECK();
-  mToBottom = toBottom;
-  if(toBottom)
+  mBottom = enable;
+  if(mBottom)
   {
-    DALI_LOG_RELEASE_INFO("ecore_wl2_window_stack_mode_set, window: [%p], flag[%d] ECORE_WL2_WINDOW_STACK_BELOW\n", mEcoreWindow, toBottom);
+    DALI_LOG_RELEASE_INFO("ecore_wl2_window_stack_mode_set, window: [%p], flag[%d] ECORE_WL2_WINDOW_STACK_BELOW\n", mEcoreWindow, mBottom);
     ecore_wl2_window_stack_mode_set(mEcoreWindow, ECORE_WL2_WINDOW_STACK_BELOW);
   }
   else
   {
-    DALI_LOG_RELEASE_INFO("ecore_wl2_window_stack_mode_set, window: [%p], flag[%d] ECORE_WL2_WINDOW_STACK_NONE\n", mEcoreWindow, toBottom);
+    DALI_LOG_RELEASE_INFO("ecore_wl2_window_stack_mode_set, window: [%p], flag[%d] ECORE_WL2_WINDOW_STACK_NONE\n", mEcoreWindow, mBottom);
     ecore_wl2_window_stack_mode_set(mEcoreWindow, ECORE_WL2_WINDOW_STACK_NONE);
   }
   ecore_wl2_window_commit(mEcoreWindow, EINA_TRUE);
-  FINISH_DURATION_CHECK("ecore_wl2_window_pin_mode_set");
+  FINISH_DURATION_CHECK("ecore_wl2_window_stack_mode_set");
 }
 
 bool WindowBaseEcoreWl2::IsBottom()
 {
-  return mToBottom;
+  return mBottom;
 }
 
 Any WindowBaseEcoreWl2::GetNativeBuffer() const

diff --git a/dali/internal/window-system/tizen-wayland/ecore-wl2/window-base-ecore-wl2.h b/dali/internal/window-system/tizen-wayland/ecore-wl2/window-base-ecore-wl2.h
index 0df5b4afcb4eea464a1f58ca0add627362eb5199..1d12c2de538158e90f661ba2ac0452a830d8234a 100644 (file)
--- a/dali/internal/window-system/tizen-wayland/ecore-wl2/window-base-ecore-wl2.h
+++ b/dali/internal/window-system/tizen-wayland/ecore-wl2/window-base-ecore-wl2.h
@@ -683,9 +683,9 @@ public:
   bool IsAlwaysOnTop() override;
 
   /**
-   * @copydoc Dali::Internal::Adaptor::WindowBase::SetToBottom()
+   * @copydoc Dali::Internal::Adaptor::WindowBase::SetBottom()
    */
-  void SetToBottom(bool toBottom) override;
+  void SetBottom(bool enable) override;
 
   /**
    * @copydoc Dali::Internal::Adaptor::WindowBase::IsBottom()
@@ -816,7 +816,7 @@ private:
   bool mBrightnessChangeDone;
   bool mIsFrontBufferRendering;
   bool mIsIMEWindowInitialized;
-  bool mToBottom;
+  bool mBottom;
 };
 
 } // namespace Adaptor

diff --git a/dali/internal/window-system/ubuntu-x11/window-base-ecore-x.cpp b/dali/internal/window-system/ubuntu-x11/window-base-ecore-x.cpp
index 69bb658d18ff55bfc332b776806e7135437a2ac9..cdb15dad14e2dc56331822f9bb3444b91aefec8d 100644 (file)
--- a/dali/internal/window-system/ubuntu-x11/window-base-ecore-x.cpp
+++ b/dali/internal/window-system/ubuntu-x11/window-base-ecore-x.cpp
@@ -1115,7 +1115,7 @@ bool WindowBaseEcoreX::IsAlwaysOnTop()
   return false;
 }
 
-void WindowBaseEcoreX::SetToBottom(bool toBottom)
+void WindowBaseEcoreX::SetBottom(bool enable)
 {
 }
 

diff --git a/dali/internal/window-system/ubuntu-x11/window-base-ecore-x.h b/dali/internal/window-system/ubuntu-x11/window-base-ecore-x.h
index 4c65241a4563f74ea9757e2466b4600438ffe313..eaacefc0891d3e70eda8549ac37841dd2672318a 100644 (file)
--- a/dali/internal/window-system/ubuntu-x11/window-base-ecore-x.h
+++ b/dali/internal/window-system/ubuntu-x11/window-base-ecore-x.h
@@ -545,9 +545,9 @@ public:
   bool IsAlwaysOnTop() override;
 
   /**
-   * @copydoc Dali::Internal::Adaptor::WindowBase::SetToBottom()
+   * @copydoc Dali::Internal::Adaptor::WindowBase::SetBottom()
    */
-  void SetToBottom(bool toBottom) override;
+  void SetBottom(bool enable) override;
 
   /**
    * @copydoc Dali::Internal::Adaptor::WindowBase::IsBottom()

diff --git a/dali/internal/window-system/windows/window-base-win.cpp b/dali/internal/window-system/windows/window-base-win.cpp
index 784d51760caf932e5917b325eece2c8d87f64066..12a152177b27d827c3f7c2830bc9f79e7732512b 100644 (file)
--- a/dali/internal/window-system/windows/window-base-win.cpp
+++ b/dali/internal/window-system/windows/window-base-win.cpp
@@ -744,7 +744,7 @@ bool WindowBaseWin::IsAlwaysOnTop()
   return false;
 }
 
-void WindowBaseWin::SetToBottom(bool toBottom)
+void WindowBaseWin::SetBottom(bool enable)
 {
 }
 

diff --git a/dali/internal/window-system/windows/window-base-win.h b/dali/internal/window-system/windows/window-base-win.h
index 3e0a0c720b99294b934777f2ed9a76ca8ba2b7ce..c69991ac2454b8abd238baa20ca9d220366cf937 100644 (file)
--- a/dali/internal/window-system/windows/window-base-win.h
+++ b/dali/internal/window-system/windows/window-base-win.h
@@ -527,9 +527,9 @@ public:
   bool IsAlwaysOnTop() override;
 
   /**
-   * @copydoc Dali::Internal::Adaptor::WindowBase::SetToBottom()
+   * @copydoc Dali::Internal::Adaptor::WindowBase::SetBottom()
    */
-  void SetToBottom(bool toBottom) override;
+  void SetBottom(bool enable) override;
 
   /**
    * @copydoc Dali::Internal::Adaptor::WindowBase::IsBottom()

diff --git a/dali/internal/window-system/x11/window-base-x.cpp b/dali/internal/window-system/x11/window-base-x.cpp
index 32b7cdc297b5bc64b22da0fc37b4302a4ad4ce2d..f1164d1e42b3c9ed1c162715b9b1a1d3e15edeee 100644 (file)
--- a/dali/internal/window-system/x11/window-base-x.cpp
+++ b/dali/internal/window-system/x11/window-base-x.cpp
@@ -1049,7 +1049,7 @@ bool WindowBaseX::IsAlwaysOnTop()
   return false;
 }
 
-void WindowBaseX::SetToBottom(bool toBottom)
+void WindowBaseX::SetBottom(bool enable)
 {
 }
 

diff --git a/dali/internal/window-system/x11/window-base-x.h b/dali/internal/window-system/x11/window-base-x.h
index 6e43002289ee83506f2efd5d60ef3893b05892ca..fd3c9f474cfd42f676e30b673826d3ff2d221ebe 100644 (file)
--- a/dali/internal/window-system/x11/window-base-x.h
+++ b/dali/internal/window-system/x11/window-base-x.h
@@ -550,9 +550,9 @@ public:
   bool IsAlwaysOnTop() override;
 
   /**
-   * @copydoc Dali::Internal::Adaptor::WindowBase::SetToBottom()
+   * @copydoc Dali::Internal::Adaptor::WindowBase::SetBottom()
    */
-  void SetToBottom(bool toBottom) override;
+  void SetBottom(bool enable) override;
 
   /**
    * @copydoc Dali::Internal::Adaptor::WindowBase::IsBottom()