Merge pull request #1309 from JakeStanger/fix/launcher-popup

fix(launcher): popup flicker when `popup_autohide` enabled

Author: JakeStanger

src/modules/launcher/mod.rs

@@ -5,7 +5,8 @@ mod pagination;
 use self::item::{AppearanceOptions, Item, ItemButton, Window};
 use self::open_state::OpenState;
 use super::{
-    Module, ModuleInfo, ModuleParts, ModulePopup, ModuleUpdateEvent, PopupButton, WidgetContext,
+    Module, ModuleInfo, ModuleParts, ModulePopup, ModulePopupParts, ModuleUpdateEvent, PopupButton,
+    WidgetContext,
 };
 use crate::channels::{AsyncSenderExt, BroadcastReceiverExt};
 use crate::clients::wayland::{self, ToplevelEvent};
@@ -595,7 +596,8 @@ impl Module<gtk::Box> for LauncherModule {
                     .values()
                     .find(|b| b.button.button.popup_id() == id)
                     .map(|b| b.button.button.clone())
-            }));
+            }))
+            .map(ModulePopupParts::disable_autohide);
 
         Ok(ModuleParts {
             widget: container,

src/modules/mod.rs

@@ -198,10 +198,20 @@ pub struct ModulePopupParts {
     /// An array of buttons which can be used for opening the popup.
     /// For most modules, this will only be a single button.
     pub buttons: Vec<Button>,
+    /// Whether this module disallows the popover widget from using autohide.
+    /// Where popups are controlled via hover, autohide can cause issues.
+    pub disable_autohide: bool,
 
     pub button_finder: Option<Rc<ButtonFinder>>,
 }
 
+impl ModulePopupParts {
+    fn disable_autohide(mut self) -> Self {
+        self.disable_autohide = true;
+        self
+    }
+}
+
 impl Debug for ModulePopupParts {
     fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
         f.debug_struct("ModulePopupParts")
@@ -229,6 +239,7 @@ impl ModulePopup for Option<gtk::Box> {
             container,
             buttons,
             button_finder: None,
+            disable_autohide: false,
         })
     }
 
@@ -237,6 +248,7 @@ impl ModulePopup for Option<gtk::Box> {
             container,
             buttons: vec![],
             button_finder: Some(finder),
+            disable_autohide: false,
         })
     }
 }

src/popup.rs

@@ -11,8 +11,10 @@ use tracing::{debug, error};
 
 #[derive(Debug)]
 pub struct PopupCacheValue {
-    // pub name: String,
     pub content: gtk::Box,
+    /// Whether this module disallows the popover widget from using autohide.
+    /// Where popups are controlled via hover, autohide can cause issues.
+    pub disable_autohide: bool,
 }
 
 #[derive(Debug, Clone, Copy)]
@@ -30,6 +32,7 @@ pub struct Popup {
     pub button_cache: Rc<RefCell<Vec<Button>>>,
     pos: BarPosition,
     current_widget: Rc<RefCell<Option<CurrentWidgetInfo>>>,
+    autohide: bool,
 }
 
 impl Debug for Popup {
@@ -84,6 +87,7 @@ impl Popup {
             button_finder_cache: rc_mut!(HashMap::new()),
             pos,
             current_widget: rc_mut!(None),
+            autohide,
         }
     }
 
@@ -102,6 +106,7 @@ impl Popup {
             key,
             PopupCacheValue {
                 content: content.container.clone(),
+                disable_autohide: content.disable_autohide,
             },
         );
 
@@ -128,7 +133,11 @@ impl Popup {
     pub fn show(&self, widget_id: usize, button_id: usize) {
         self.clear_window();
 
-        if let Some(PopupCacheValue { content, .. }) = self.container_cache.borrow().get(&widget_id)
+        if let Some(PopupCacheValue {
+            content,
+            disable_autohide,
+            ..
+        }) = self.container_cache.borrow().get(&widget_id)
         {
             *self.current_widget.borrow_mut() = Some(CurrentWidgetInfo { widget_id });
 
@@ -151,6 +160,11 @@ impl Popup {
             self.popover.set_child(Some(content));
             self.popover.unparent();
             self.popover.set_parent(&button);
+
+            if *disable_autohide {
+                self.popover.set_autohide(false);
+            }
+
             self.popover.popup();
         }
     }
@@ -163,14 +177,23 @@ impl Popup {
     pub fn show_for(&self, widget_id: usize, button: &Button) -> bool {
         self.clear_window();
 
-        if let Some(PopupCacheValue { content, .. }) = self.container_cache.borrow().get(&widget_id)
+        if let Some(PopupCacheValue {
+            content,
+            disable_autohide,
+            ..
+        }) = self.container_cache.borrow().get(&widget_id)
         {
             *self.current_widget.borrow_mut() = Some(CurrentWidgetInfo { widget_id });
 
             content.add_css_class("popup");
             self.popover.set_child(Some(content));
             self.popover.unparent();
             self.popover.set_parent(button);
+
+            if *disable_autohide {
+                self.popover.set_autohide(false);
+            }
+
             self.popover.popup();
 
             true
@@ -181,6 +204,7 @@ impl Popup {
 
     fn clear_window(&self) {
         self.popover.set_child(None::<&gtk::Box>);
+        self.popover.set_autohide(self.autohide);
     }
 
     /// Hides the popup