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 37a107c..8f3456d 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 34e06e1..e2ab625 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 75e37e6..cb9aea6 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 e6db23f..a7ffb96 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 91b2dd2..5afb084 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 df76014..6282dfb 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 c995aed..3c31b00 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 114e95a..fd50d91 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 ca471b1..a414e05 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 1ea0a04..6027bb1 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 0df5b4a..1d12c2d 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 69bb658..cdb15da 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 4c65241..eaacefc 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 784d517..12a1521 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 3e0a0c7..c69991a 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 32b7cdc..f1164d1 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 6e43002..fd3c9f4 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()