Rename fn scroll2 to fn scroll (emilk#4282)

hacknus · Oct 30, 2024 · b8b0108 · b8b0108
1 parent 625f2c3
commit b8b0108
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 4 deletions.
diff --git a/crates/egui/src/containers/scroll_area.rs b/crates/egui/src/containers/scroll_area.rs
@@ -337,6 +337,16 @@ impl ScrollArea {
     }
 
     /// Turn on/off scrolling on the horizontal/vertical axes.
+    ///
+    /// You can pass in `false`, `true`, `[false, true]` etc.
+    #[inline]
+    pub fn scroll(mut self, scroll_enabled: impl Into<Vec2b>) -> Self {
+        self.scroll_enabled = scroll_enabled.into();
+        self
+    }
+
+    /// Turn on/off scrolling on the horizontal/vertical axes.
+    #[deprecated = "Renamed to `scroll`"]
     #[inline]
     pub fn scroll2(mut self, scroll_enabled: impl Into<Vec2b>) -> Self {
         self.scroll_enabled = scroll_enabled.into();

diff --git a/crates/egui/src/containers/window.rs b/crates/egui/src/containers/window.rs
@@ -328,9 +328,19 @@ impl<'open> Window<'open> {
     }
 
     /// Enable/disable horizontal/vertical scrolling. `false` by default.
+    ///
+    /// You can pass in `false`, `true`, `[false, true]` etc.
+    #[inline]
+    pub fn scroll(mut self, scroll: impl Into<Vec2b>) -> Self {
+        self.scroll = self.scroll.scroll(scroll);
+        self
+    }
+
+    /// Enable/disable horizontal/vertical scrolling. `false` by default.
+    #[deprecated = "Renamed to `scroll`"]
     #[inline]
     pub fn scroll2(mut self, scroll: impl Into<Vec2b>) -> Self {
-        self.scroll = self.scroll.scroll2(scroll);
+        self.scroll = self.scroll.scroll(scroll);
         self
     }
 

diff --git a/crates/egui_demo_lib/src/demo/code_example.rs b/crates/egui_demo_lib/src/demo/code_example.rs
@@ -115,7 +115,7 @@ impl super::Demo for CodeExample {
             .open(open)
             .min_width(375.0)
             .default_size([390.0, 500.0])
-            .scroll2(false)
+            .scroll(false)
             .resizable([true, false])
             .show(ctx, |ui| self.ui(ui));
     }

diff --git a/crates/egui_demo_lib/src/demo/tests.rs b/crates/egui_demo_lib/src/demo/tests.rs
@@ -372,7 +372,7 @@ impl super::Demo for InputTest {
             .default_width(800.0)
             .open(open)
             .resizable(true)
-            .scroll2(false)
+            .scroll(false)
             .show(ctx, |ui| {
                 use super::View as _;
                 self.ui(ui);

diff --git a/crates/egui_demo_lib/src/demo/window_options.rs b/crates/egui_demo_lib/src/demo/window_options.rs
@@ -67,7 +67,7 @@ impl super::Demo for WindowOptions {
             .constrain(constrain)
             .collapsible(collapsible)
             .title_bar(title_bar)
-            .scroll2(scroll2)
+            .scroll(scroll2)
             .enabled(enabled);
         if closable {
             window = window.open(open);