refactor: always on bottom

Co-Authored-By: Amr Bashir <[email protected]>

.changes/always-on-bottom.md

@@ -0,0 +1,5 @@
+---
+"tao": "patch"
+---
+
+Implement "always on bottom" as contrary to "always on top".

examples/window_debug.rs

@@ -32,9 +32,9 @@ fn main() {
   eprintln!("  (V) Toggle visibility");
   eprintln!("  (X) Toggle maximized");
   eprintln!("  (T) Toggle always on top");
-  eprintln!("  (B) Toggle always below bottom");
+  eprintln!("  (B) Toggle always on bottom");
 
-  let mut always_below_bottom = false;
+  let mut always_on_bottom = false;
   let mut always_on_top = false;
   let mut visible = true;
 
@@ -129,8 +129,8 @@ fn main() {
           window.set_always_on_top(always_on_top);
         }
         "b" => {
-          always_below_bottom = !always_below_bottom;
-          window.set_always_below_bottom(always_below_bottom);
+          always_on_bottom = !always_on_bottom;
+          window.set_always_on_bottom(always_on_bottom);
         }
         _ => (),
       },

src/platform_impl/android/mod.rs

@@ -642,7 +642,7 @@ impl Window {
 
   pub fn set_decorations(&self, _decorations: bool) {}
 
-  pub fn set_always_below_bottom(&self, _always_below_bottom: bool) {}
+  pub fn set_always_on_bottom(&self, _always_on_bottom: bool) {}
 
   pub fn set_always_on_top(&self, _always_on_top: bool) {}
 

src/platform_impl/ios/window.rs

@@ -300,8 +300,8 @@ impl Inner {
     warn!("`Window::set_decorations` is ignored on iOS")
   }
 
-  pub fn set_always_below_bottom(&self, _always_below_bottom: bool) {
-    warn!("`Window::set_always_below_bottom` is ignored on iOS")
+  pub fn set_always_on_bottom(&self, _always_on_bottom: bool) {
+    warn!("`Window::set_always_on_bottom` is ignored on iOS")
   }
 
   pub fn set_always_on_top(&self, _always_on_top: bool) {

src/platform_impl/linux/event_loop.rs

@@ -258,8 +258,8 @@ impl<T: 'static> EventLoop<T> {
             None => window.unfullscreen(),
           },
           WindowRequest::Decorations(decorations) => window.set_decorated(decorations),
-          WindowRequest::AlwaysBelowBottom(always_below_bottom) => {
-            window.set_keep_below(always_below_bottom)
+          WindowRequest::AlwaysOnBottom(always_on_bottom) => {
+            window.set_keep_below(always_on_bottom)
           }
           WindowRequest::AlwaysOnTop(always_on_top) => window.set_keep_above(always_on_top),
           WindowRequest::WindowIcon(window_icon) => {

src/platform_impl/linux/window.rs

@@ -215,12 +215,15 @@ impl Window {
     window.set_visible(attributes.visible);
     window.set_decorated(attributes.decorations);
 
-    if attributes.always_below_bottom && !attributes.always_on_top {
-      window.set_keep_below(attributes.always_below_bottom);
-    }
-    if attributes.always_on_top && !attributes.always_below_bottom {
+    if attributes.always_on_bottom && attributes.always_on_top {
+      log::warn!(
+        "Always on top and always on bottom, are both specified, you should only set one."
+      );
+    } else if attributes.always_on_bottom || attributes.always_on_top {
+      window.set_keep_below(attributes.always_on_bottom);
       window.set_keep_above(attributes.always_on_top);
     }
+
     if let Some(icon) = attributes.window_icon {
       window.set_icon(Some(&icon.inner.into()));
     }
@@ -557,10 +560,10 @@ impl Window {
     }
   }
 
-  pub fn set_always_below_bottom(&self, always_below_bottom: bool) {
+  pub fn set_always_on_bottom(&self, always_on_bottom: bool) {
     if let Err(e) = self.window_requests_tx.send((
       self.window_id,
-      WindowRequest::AlwaysBelowBottom(always_below_bottom),
+      WindowRequest::AlwaysOnBottom(always_on_bottom),
     )) {
       log::warn!("Fail to send always on bottom request: {}", e);
     }
@@ -771,7 +774,7 @@ pub enum WindowRequest {
   DragWindow,
   Fullscreen(Option<Fullscreen>),
   Decorations(bool),
-  AlwaysBelowBottom(bool),
+  AlwaysOnBottom(bool),
   AlwaysOnTop(bool),
   WindowIcon(Option<Icon>),
   UserAttention(Option<UserAttentionType>),

src/platform_impl/macos/window.rs

@@ -232,14 +232,14 @@ fn create_window(
         ns_window.setMovableByWindowBackground_(YES);
       }
 
-      if attrs.always_on_top && !attrs.always_below_bottom {
+      if attrs.always_on_top && attrs.always_on_bottom {
+        log::warn!("Always on top and always on bottom, are both specified, you should only set one.");
+      } else if attrs.always_on_top {
         let _: () = msg_send![
           *ns_window,
           setLevel: ffi::NSWindowLevel::NSFloatingWindowLevel
         ];
-      }
-
-      if attrs.always_below_bottom && !attrs.always_on_top {
+      } else if attrs.always_on_bottom {
         let _: () = msg_send![
           *ns_window,
           setLevel: ffi::NSWindowLevel::BelowNormalWindowLevel
@@ -1133,8 +1133,8 @@ impl UnownedWindow {
   }
 
   #[inline]
-  pub fn set_always_below_bottom(&self, always_below_bottom: bool) {
-    let level = if always_below_bottom {
+  pub fn set_always_on_bottom(&self, always_on_bottom: bool) {
+    let level = if always_on_bottom {
       ffi::NSWindowLevel::BelowNormalWindowLevel
     } else {
       ffi::NSWindowLevel::NSNormalWindowLevel

src/platform_impl/windows/event_loop.rs

@@ -1153,7 +1153,7 @@ unsafe fn public_window_callback_inner<T: 'static>(
       }
 
       let window_flags = window_state.window_flags;
-      if window_flags.contains(WindowFlags::ALWAYS_BELOW_BOTTOM) {
+      if window_flags.contains(WindowFlags::ALWAYS_ON_BOTTOM) {
         let window_pos = &mut *(lparam.0 as *mut WINDOWPOS);
         window_pos.hwndInsertAfter = HWND_BOTTOM;
       }

src/platform_impl/windows/window.rs

@@ -656,13 +656,13 @@ impl Window {
   }
 
   #[inline]
-  pub fn set_always_below_bottom(&self, always_below_bottom: bool) {
+  pub fn set_always_on_bottom(&self, always_on_bottom: bool) {
     let window = self.window.clone();
     let window_state = Arc::clone(&self.window_state);
 
     self.thread_executor.execute_in_thread(move || {
       WindowState::set_window_flags(window_state.lock(), window.0, |f| {
-        f.set(WindowFlags::ALWAYS_BELOW_BOTTOM, always_below_bottom)
+        f.set(WindowFlags::ALWAYS_ON_BOTTOM, always_on_bottom)
       });
     });
   }

src/platform_impl/windows/window_state.rs

@@ -69,17 +69,17 @@ bitflags! {
 }
 bitflags! {
     pub struct WindowFlags: u32 {
-        const RESIZABLE           = 1 << 0;
-        const DECORATIONS         = 1 << 1;
-        const VISIBLE             = 1 << 2;
-        const ON_TASKBAR          = 1 << 3;
-        const ALWAYS_ON_TOP       = 1 << 4;
-        const NO_BACK_BUFFER      = 1 << 5;
-        const TRANSPARENT         = 1 << 6;
-        const CHILD               = 1 << 7;
-        const MAXIMIZED           = 1 << 8;
-        const POPUP               = 1 << 14;
-        const ALWAYS_BELOW_BOTTOM = 1 << 16;
+        const RESIZABLE        = 1 << 0;
+        const DECORATIONS      = 1 << 1;
+        const VISIBLE          = 1 << 2;
+        const ON_TASKBAR       = 1 << 3;
+        const ALWAYS_ON_TOP    = 1 << 4;
+        const NO_BACK_BUFFER   = 1 << 5;
+        const TRANSPARENT      = 1 << 6;
+        const CHILD            = 1 << 7;
+        const MAXIMIZED        = 1 << 8;
+        const POPUP            = 1 << 14;
+        const ALWAYS_ON_BOTTOM = 1 << 16;
 
         /// Marker flag for fullscreen. Should always match `WindowState::fullscreen`, but is
         /// included here to make masking easier.
@@ -298,11 +298,11 @@ impl WindowFlags {
       }
     }
 
-    if diff.contains(WindowFlags::ALWAYS_BELOW_BOTTOM) {
+    if diff.contains(WindowFlags::ALWAYS_ON_BOTTOM) {
       unsafe {
         SetWindowPos(
           window,
-          match new.contains(WindowFlags::ALWAYS_BELOW_BOTTOM) {
+          match new.contains(WindowFlags::ALWAYS_ON_BOTTOM) {
             true => HWND_BOTTOM,
             false => HWND_NOTOPMOST,
           },

src/window.rs

@@ -193,7 +193,7 @@ pub struct WindowAttributes {
   /// Whether the window should always be on bottom of other windows.
   ///
   /// The default is `false`.
-  pub always_below_bottom: bool,
+  pub always_on_bottom: bool,
 
   /// The window icon.
   ///
@@ -224,7 +224,7 @@ impl Default for WindowAttributes {
       transparent: false,
       decorations: true,
       always_on_top: false,
-      always_below_bottom: false,
+      always_on_bottom: false,
       window_icon: None,
       window_menu: None,
       preferred_theme: None,
@@ -369,12 +369,13 @@ impl WindowBuilder {
 
   /// Sets whether or not the window will always be below other windows.
   ///
-  /// See [`Window::set_always_below_bottom`] for details.
+  /// See [`Window::set_always_on_bottom`] for details.
   ///
-  /// [`Window::set_always_below_bottom`]: crate::window::Window::set_always_below_bottom
+  /// [`Window::set_always_on_bottom`]: crate::window::Window::set_always_on_bottom
   #[inline]
-  pub fn with_always_below_bottom(mut self, always_below_bottom: bool) -> Self {
-    self.window.always_below_bottom = always_below_bottom;
+  pub fn with_always_on_bottom(mut self, always_on_bottom: bool) -> Self {
+    self.window.always_on_top = false;
+    self.window.always_on_bottom = always_on_bottom;
     self
   }
 
@@ -385,6 +386,7 @@ impl WindowBuilder {
   /// [`Window::set_always_on_top`]: crate::window::Window::set_always_on_top
   #[inline]
   pub fn with_always_on_top(mut self, always_on_top: bool) -> Self {
+    self.window.always_on_bottom = false;
     self.window.always_on_top = always_on_top;
     self
   }
@@ -805,10 +807,11 @@ impl Window {
   ///
   /// ## Platform-specific
   ///
+  /// - **Windows**: There is no guarantee that the window will be the bottom most but it will try to be.
   /// - **iOS / Android:** Unsupported.
   #[inline]
-  pub fn set_always_below_bottom(&self, always_below_bottom: bool) {
-    self.window.set_always_below_bottom(always_below_bottom)
+  pub fn set_always_on_bottom(&self, always_on_bottom: bool) {
+    self.window.set_always_on_bottom(always_on_bottom)
   }
 
   /// Change whether or not the window will always be on top of other windows.