Add mouse down out handlers

Nathan Sobo created 3 years ago

These will fire whenever the left/right mouse button is pressed down outside a specific region. I'll use these to cancel the context menu in the next commit.

Change summary

crates/gpui/src/elements/mouse_event_handler.rs | 46 ++++++++++--------
crates/gpui/src/presenter.rs                    | 33 +++++++++---
crates/gpui/src/scene.rs                        |  2 
3 files changed, 52 insertions(+), 29 deletions(-)

Detailed changes

crates/gpui/src/elements/mouse_event_handler.rs

@@ -18,11 +18,13 @@ pub struct MouseEventHandler {
     tag: TypeId,
     id: usize,
     cursor_style: Option<CursorStyle>,
-    mouse_down_handler: Option<Rc<dyn Fn(Vector2F, &mut EventContext)>>,
-    click_handler: Option<Rc<dyn Fn(Vector2F, usize, &mut EventContext)>>,
-    right_mouse_down_handler: Option<Rc<dyn Fn(Vector2F, &mut EventContext)>>,
-    right_click_handler: Option<Rc<dyn Fn(Vector2F, usize, &mut EventContext)>>,
-    drag_handler: Option<Rc<dyn Fn(Vector2F, &mut EventContext)>>,
+    mouse_down: Option<Rc<dyn Fn(Vector2F, &mut EventContext)>>,
+    click: Option<Rc<dyn Fn(Vector2F, usize, &mut EventContext)>>,
+    right_mouse_down: Option<Rc<dyn Fn(Vector2F, &mut EventContext)>>,
+    right_click: Option<Rc<dyn Fn(Vector2F, usize, &mut EventContext)>>,
+    mouse_down_out: Option<Rc<dyn Fn(Vector2F, &mut EventContext)>>,
+    right_mouse_down_out: Option<Rc<dyn Fn(Vector2F, &mut EventContext)>>,
+    drag: Option<Rc<dyn Fn(Vector2F, &mut EventContext)>>,
     padding: Padding,
 }
 
@@ -38,11 +40,13 @@ impl MouseEventHandler {
             tag: TypeId::of::<Tag>(),
             child: render_child(cx.mouse_state::<Tag>(id), cx),
             cursor_style: None,
-            mouse_down_handler: None,
-            click_handler: None,
-            right_mouse_down_handler: None,
-            right_click_handler: None,
-            drag_handler: None,
+            mouse_down: None,
+            click: None,
+            right_mouse_down: None,
+            right_click: None,
+            mouse_down_out: None,
+            right_mouse_down_out: None,
+            drag: None,
             padding: Default::default(),
         }
     }
@@ -56,7 +60,7 @@ impl MouseEventHandler {
         mut self,
         handler: impl Fn(Vector2F, &mut EventContext) + 'static,
     ) -> Self {
-        self.mouse_down_handler = Some(Rc::new(handler));
+        self.mouse_down = Some(Rc::new(handler));
         self
     }
 
@@ -64,7 +68,7 @@ impl MouseEventHandler {
         mut self,
         handler: impl Fn(Vector2F, usize, &mut EventContext) + 'static,
     ) -> Self {
-        self.click_handler = Some(Rc::new(handler));
+        self.click = Some(Rc::new(handler));
         self
     }
 
@@ -72,7 +76,7 @@ impl MouseEventHandler {
         mut self,
         handler: impl Fn(Vector2F, &mut EventContext) + 'static,
     ) -> Self {
-        self.right_mouse_down_handler = Some(Rc::new(handler));
+        self.right_mouse_down = Some(Rc::new(handler));
         self
     }
 
@@ -80,12 +84,12 @@ impl MouseEventHandler {
         mut self,
         handler: impl Fn(Vector2F, usize, &mut EventContext) + 'static,
     ) -> Self {
-        self.right_click_handler = Some(Rc::new(handler));
+        self.right_click = Some(Rc::new(handler));
         self
     }
 
     pub fn on_drag(mut self, handler: impl Fn(Vector2F, &mut EventContext) + 'static) -> Self {
-        self.drag_handler = Some(Rc::new(handler));
+        self.drag = Some(Rc::new(handler));
         self
     }
 
@@ -134,11 +138,13 @@ impl Element for MouseEventHandler {
             discriminant: Some((self.tag, self.id)),
             bounds: self.hit_bounds(bounds),
             hover: None,
-            click: self.click_handler.clone(),
-            mouse_down: self.mouse_down_handler.clone(),
-            right_click: self.right_click_handler.clone(),
-            right_mouse_down: self.right_mouse_down_handler.clone(),
-            drag: self.drag_handler.clone(),
+            click: self.click.clone(),
+            mouse_down: self.mouse_down.clone(),
+            right_click: self.right_click.clone(),
+            right_mouse_down: self.right_mouse_down.clone(),
+            mouse_down_out: self.mouse_down_out.clone(),
+            right_mouse_down_out: self.right_mouse_down_out.clone(),
+            drag: self.drag.clone(),
         });
 
         self.child.paint(bounds.origin(), visible_bounds, cx);

crates/gpui/src/presenter.rs

@@ -222,6 +222,7 @@ impl Presenter {
             let mut invalidated_views = Vec::new();
             let mut hovered_regions = Vec::new();
             let mut unhovered_regions = Vec::new();
+            let mut mouse_down_out_handlers = Vec::new();
             let mut mouse_down_region = None;
             let mut clicked_region = None;
             let mut right_mouse_down_region = None;
@@ -230,13 +231,18 @@ impl Presenter {
 
             match event {
                 Event::LeftMouseDown { position, .. } => {
+                    let mut hit = false;
                     for (region, _) in self.mouse_regions.iter().rev() {
                         if region.bounds.contains_point(position) {
-                            invalidated_views.push(region.view_id);
-                            mouse_down_region = Some((region.clone(), position));
-                            self.clicked_region = Some(region.clone());
-                            self.prev_drag_position = Some(position);
-                            break;
+                            if !hit {
+                                hit = true;
+                                invalidated_views.push(region.view_id);
+                                mouse_down_region = Some((region.clone(), position));
+                                self.clicked_region = Some(region.clone());
+                                self.prev_drag_position = Some(position);
+                            }
+                        } else if let Some(handler) = region.mouse_down_out.clone() {
+                            mouse_down_out_handlers.push((handler, region.view_id, position));
                         }
                     }
                 }
@@ -254,12 +260,17 @@ impl Presenter {
                     }
                 }
                 Event::RightMouseDown { position, .. } => {
+                    let mut hit = false;
                     for (region, _) in self.mouse_regions.iter().rev() {
                         if region.bounds.contains_point(position) {
-                            invalidated_views.push(region.view_id);
-                            right_mouse_down_region = Some((region.clone(), position));
-                            self.right_clicked_region = Some(region.clone());
-                            break;
+                            if !hit {
+                                hit = true;
+                                invalidated_views.push(region.view_id);
+                                right_mouse_down_region = Some((region.clone(), position));
+                                self.right_clicked_region = Some(region.clone());
+                            }
+                        } else if let Some(handler) = region.right_mouse_down_out.clone() {
+                            mouse_down_out_handlers.push((handler, region.view_id, position));
                         }
                     }
                 }
@@ -355,6 +366,10 @@ impl Presenter {
                 }
             }
 
+            for (handler, view_id, position) in mouse_down_out_handlers {
+                event_cx.with_current_view(view_id, |event_cx| handler(position, event_cx))
+            }
+
             if let Some((mouse_down_region, position)) = mouse_down_region {
                 if let Some(mouse_down_callback) = mouse_down_region.mouse_down {
                     handled = true;

crates/gpui/src/scene.rs

@@ -54,6 +54,8 @@ pub struct MouseRegion {
     pub right_mouse_down: Option<Rc<dyn Fn(Vector2F, &mut EventContext)>>,
     pub right_click: Option<Rc<dyn Fn(Vector2F, usize, &mut EventContext)>>,
     pub drag: Option<Rc<dyn Fn(Vector2F, &mut EventContext)>>,
+    pub mouse_down_out: Option<Rc<dyn Fn(Vector2F, &mut EventContext)>>,
+    pub right_mouse_down_out: Option<Rc<dyn Fn(Vector2F, &mut EventContext)>>,
 }
 
 #[derive(Copy, Clone, Eq, PartialEq, Hash)]