renamed InputProvider::mouse_button_currently_pressed methods to mouse_button_down

Author: psFried

src/events/global_input.rs

@@ -34,7 +34,7 @@ impl <'a> InputProvider<'a, GlobalInputEventIterator<'a>> for GlobalInput {
         &self.current_state
     }
 
-    fn mouse_button_currently_pressed(&self, button: MouseButton) -> Option<Point> {
+    fn mouse_button_down(&self, button: MouseButton) -> Option<Point> {
          self.current_state().mouse_buttons.get(button).map(|_| {
              self.mouse_position()
          })

src/events/input_provider.rs

@@ -21,7 +21,7 @@ pub trait InputProvider<'a, T: Iterator<Item=&'a UiEvent>> {
 
     /// If the given mouse button is currently pressed, returns the current position of the mouse.
     /// Otherwise, returns `None`
-    fn mouse_button_currently_pressed(&'a self, button: MouseButton) -> Option<Point>;
+    fn mouse_button_down(&'a self, button: MouseButton) -> Option<Point>;
 
     //////////////////////////////////////////////////
     // Methods that just check the stream of events //
@@ -156,14 +156,14 @@ pub trait InputProvider<'a, T: Iterator<Item=&'a UiEvent>> {
 
     /// Convenience method for checking if the Left mouse button is down.
     /// Returns mouse position if the Left mouse button is currently pressed, otherwise `None`.
-    fn mouse_left_button_currently_pressed(&'a self) -> Option<Point> {
-        self.mouse_button_currently_pressed(MouseButton::Left)
+    fn mouse_left_button_down(&'a self) -> Option<Point> {
+        self.mouse_button_down(MouseButton::Left)
     }
 
     /// Convenience method for checking if the Right mouse button is down.
     /// Returns mouse position if the Right mouse button is currently pressed, otherwise `None`.
-    fn mouse_right_button_currently_pressed(&'a self) -> Option<Point> {
-        self.mouse_button_currently_pressed(MouseButton::Right)
+    fn mouse_right_button_down(&'a self) -> Option<Point> {
+        self.mouse_button_down(MouseButton::Right)
     }
 
     /// Convenience method for returning the current mouse position.

src/events/widget_input.rs

@@ -128,7 +128,7 @@ impl<'a> InputProvider<'a, WidgetInputEventIterator<'a>> for WidgetInput<'a> {
         }).last()
     }
 
-    fn mouse_button_currently_pressed(&self, button: MouseButton) -> Option<Point> {
+    fn mouse_button_down(&self, button: MouseButton) -> Option<Point> {
         self.current_state().mouse_buttons.get(button).iter().filter(|_| {
             self.current_state().widget_capturing_mouse.map(|capturing| {
                 capturing == self.widget_idx

src/tests/global_input.rs

@@ -81,24 +81,24 @@ fn global_input_should_track_current_mouse_position() {
 }
 
 #[test]
-fn mouse_button_currently_pressed_should_return_current_mouse_position_if_button_is_pressed() {
+fn mouse_button_down_should_return_current_mouse_position_if_button_is_pressed() {
     let mut input = GlobalInput::new(0.0);
 
     input.push_event(mouse_move_event(50.0, 77.7));
     input.push_event(UiEvent::Raw(Input::Press(Mouse(MouseButton::Left))));
 
-    assert_eq!(Some([50.0, 77.7]), input.mouse_button_currently_pressed(MouseButton::Left));
+    assert_eq!(Some([50.0, 77.7]), input.mouse_button_down(MouseButton::Left));
 }
 
 #[test]
-fn mouse_button_currently_pressed_should_return_none_if_button_is_not_pressed() {
+fn mouse_button_down_should_return_none_if_button_is_not_pressed() {
     let pressed_button = MouseButton::Middle;
     let non_pressed_button = MouseButton::Right;
 
     let mut input = GlobalInput::new(0.0);
     input.push_event(UiEvent::Raw(Input::Press(Mouse(pressed_button))));
 
-    assert!(input.mouse_button_currently_pressed(non_pressed_button).is_none());
+    assert!(input.mouse_button_down(non_pressed_button).is_none());
 }
 
 #[test]

src/tests/input_provider.rs

@@ -14,12 +14,12 @@ fn mouse_position_should_return_mouse_position_from_current_state() {
 }
 
 #[test]
-fn mouse_button_currently_pressed_should_return_true_if_button_is_pressed() {
+fn mouse_button_down_should_return_true_if_button_is_pressed() {
     let mut input_state = InputState::new();
     input_state.mouse_buttons.set(MouseButton::Right, Some([0.0, 0.0]));
     let input = ProviderImpl::with_input_state(input_state);
-    assert_eq!(Some([0.0, 0.0]), input.mouse_button_currently_pressed(MouseButton::Right));
-    assert!(input.mouse_left_button_currently_pressed().is_none());
+    assert_eq!(Some([0.0, 0.0]), input.mouse_button_down(MouseButton::Right));
+    assert!(input.mouse_left_button_down().is_none());
 }
 
 #[test]
@@ -194,7 +194,7 @@ impl<'a> InputProvider<'a, TestInputEventIterator<'a>> for ProviderImpl {
         &self.current_state
     }
 
-    fn mouse_button_currently_pressed(&self, button: MouseButton) -> Option<Point> {
+    fn mouse_button_down(&self, button: MouseButton) -> Option<Point> {
         self.current_state().mouse_buttons.get(button).map(|_| {
             self.mouse_position()
         })

src/tests/widget_input.rs

@@ -6,19 +6,19 @@ use widget::{Index, Id};
 use position::Rect;
 
 #[test]
-fn mouse_button_currently_pressed_should_return_none_if_mouse_is_not_over_widget() {
+fn mouse_button_down_should_return_none_if_mouse_is_not_over_widget() {
     let widget_area = Rect::from_corners([10.0, 10.0], [50.0, 50.0]);
     let mut global_input = GlobalInput::new(4.0);
     // mouse position stays at (0,0)
     global_input.push_event(UiEvent::Raw(Input::Press(Button::Mouse(MouseButton::Left))));
 
     let widget_input = WidgetInput::for_widget(Index::Public(Id(2)), widget_area, &global_input);
 
-    assert!(widget_input.mouse_left_button_currently_pressed().is_none());
+    assert!(widget_input.mouse_left_button_down().is_none());
 }
 
 #[test]
-fn mouse_button_currently_pressed_should_return_none_if_another_widget_is_capturing_mouse() {
+fn mouse_button_down_should_return_none_if_another_widget_is_capturing_mouse() {
     let widget_area = Rect::from_corners([10.0, 10.0], [50.0, 50.0]);
     let mut global_input = GlobalInput::new(4.0);
     global_input.push_event(UiEvent::WidgetCapturesMouse(Index::Public(Id(999))));
@@ -27,19 +27,19 @@ fn mouse_button_currently_pressed_should_return_none_if_another_widget_is_captur
 
     let widget_input = WidgetInput::for_widget(Index::Public(Id(2)), widget_area, &global_input);
 
-    assert!(widget_input.mouse_left_button_currently_pressed().is_none());
+    assert!(widget_input.mouse_left_button_down().is_none());
 }
 
 #[test]
-fn mouse_button_currently_pressed_should_return_current_mouse_position_if_mouse_is_over_widget() {
+fn mouse_button_down_should_return_current_mouse_position_if_mouse_is_over_widget() {
     let widget_area = Rect::from_corners([10.0, 10.0], [50.0, 50.0]);
     let mut global_input = GlobalInput::new(4.0);
     global_input.push_event(UiEvent::Raw(Input::Move(Motion::MouseRelative(30.0, 30.0))));
     global_input.push_event(UiEvent::Raw(Input::Press(Button::Mouse(MouseButton::Left))));
 
     let widget_input = WidgetInput::for_widget(Index::Public(Id(2)), widget_area, &global_input);
 
-    assert_eq!(Some([0.0, 0.0]), widget_input.mouse_left_button_currently_pressed());
+    assert_eq!(Some([0.0, 0.0]), widget_input.mouse_left_button_down());
 }
 
 #[test]

src/widget/button.rs

@@ -14,7 +14,7 @@ use {
     Widget,
 };
 use widget;
-use events::{WidgetInput, InputProvider};
+use events::InputProvider;
 
 
 /// A pressable button widget whose reaction is triggered upon release.
@@ -116,7 +116,7 @@ impl<'a, F> Widget for Button<'a, F>
             }
 
             let style_color = style.color(ui.theme());
-            input.mouse_left_button_currently_pressed().map(|_| {
+            input.mouse_left_button_down().map(|_| {
                 style_color.clicked()
             }).or_else(|| {
                 input.maybe_mouse_position().map(|_| style_color.highlighted())