Rename WidgetPod::paint_with_offset to just paint (#980)

Author: totsteps

CHANGELOG.md

@@ -71,6 +71,7 @@ This means that druid no longer requires cairo on macOS and uses Core Graphics i
 - `SHOW_WINDOW` and `CLOSE_WINDOW` commands now only use `Target` to determine the affected window. ([#928] by [@finnerale])
 - Replaced `NEW_WINDOW`, `SET_MENU` and `SHOW_CONTEXT_MENU` commands with methods on `EventCtx` and `DelegateCtx`. ([#931] by [@finnerale])
 - Replaced `Command::one_shot` and `::take_object` with a `SingleUse` payload wrapper type. ([#959] by [@finnerale])
+- Renamed `WidgetPod` methods: `paint` to `paint_raw`, `paint_with_offset` to `paint`, `paint_with_offset_always` to `paint_always`. ([#980] by [@totsteps])
 
 ### Deprecated
 
@@ -227,6 +228,7 @@ This means that druid no longer requires cairo on macOS and uses Core Graphics i
 [#967]: https://github.com/xi-editor/druid/pull/967
 [#969]: https://github.com/xi-editor/druid/pull/969
 [#970]: https://github.com/xi-editor/druid/pull/970
+[#980]: https://github.com/xi-editor/druid/pull/980
 
 ## [0.5.0] - 2020-04-01
 

druid/examples/timer.rs

@@ -79,7 +79,7 @@ impl Widget<u32> for TimerWidget {
     }
 
     fn paint(&mut self, ctx: &mut PaintCtx, data: &u32, env: &Env) {
-        self.simple_box.paint_with_offset(ctx, data, env);
+        self.simple_box.paint(ctx, data, env);
     }
 }
 

druid/src/core.rs

@@ -356,16 +356,16 @@ impl<T, W: Widget<T>> WidgetPod<T, W> {
 impl<T: Data, W: Widget<T>> WidgetPod<T, W> {
     /// Paint a child widget.
     ///
-    /// Generally called by container widgets as part of their [`paint`]
+    /// Generally called by container widgets as part of their [`Widget::paint`]
     /// method.
     ///
     /// Note that this method does not apply the offset of the layout rect.
-    /// If that is desired, use [`paint_with_offset`] instead.
+    /// If that is desired, use [`paint`] instead.
     ///
     /// [`layout`]: trait.Widget.html#tymethod.layout
-    /// [`paint`]: trait.Widget.html#tymethod.paint
-    /// [`paint_with_offset`]: #method.paint_with_offset
-    pub fn paint(&mut self, ctx: &mut PaintCtx, data: &T, env: &Env) {
+    /// [`Widget::paint`]: trait.Widget.html#tymethod.paint
+    /// [`paint`]: #method.paint
+    pub fn paint_raw(&mut self, ctx: &mut PaintCtx, data: &T, env: &Env) {
         // we need to do this before we borrow from self
         if env.get(Env::DEBUG_WIDGET_ID) {
             self.make_widget_id_layout_if_needed(self.state.id, ctx, env);
@@ -400,25 +400,18 @@ impl<T: Data, W: Widget<T>> WidgetPod<T, W> {
     ///
     /// This will recursively paint widgets, stopping if a widget's layout
     /// rect is outside of the currently visible region.
-    // Discussion: should this be `paint` and the other `paint_raw`?
-    pub fn paint_with_offset(&mut self, ctx: &mut PaintCtx, data: &T, env: &Env) {
-        self.paint_with_offset_impl(ctx, data, env, false)
+    pub fn paint(&mut self, ctx: &mut PaintCtx, data: &T, env: &Env) {
+        self.paint_impl(ctx, data, env, false)
     }
 
     /// Paint the widget, even if its layout rect is outside of the currently
     /// visible region.
-    pub fn paint_with_offset_always(&mut self, ctx: &mut PaintCtx, data: &T, env: &Env) {
-        self.paint_with_offset_impl(ctx, data, env, true)
+    pub fn paint_always(&mut self, ctx: &mut PaintCtx, data: &T, env: &Env) {
+        self.paint_impl(ctx, data, env, true)
     }
 
     /// Shared implementation that can skip drawing non-visible content.
-    fn paint_with_offset_impl(
-        &mut self,
-        ctx: &mut PaintCtx,
-        data: &T,
-        env: &Env,
-        paint_if_not_visible: bool,
-    ) {
+    fn paint_impl(&mut self, ctx: &mut PaintCtx, data: &T, env: &Env, paint_if_not_visible: bool) {
         if !paint_if_not_visible && !ctx.region().intersects(self.state.paint_rect()) {
             return;
         }
@@ -427,7 +420,7 @@ impl<T: Data, W: Widget<T>> WidgetPod<T, W> {
             let layout_origin = self.layout_rect().origin().to_vec2();
             ctx.transform(Affine::translate(layout_origin));
             let visible = ctx.region().to_rect().intersect(self.state.paint_rect()) - layout_origin;
-            ctx.with_child_ctx(visible, |ctx| self.paint(ctx, data, env));
+            ctx.with_child_ctx(visible, |ctx| self.paint_raw(ctx, data, env));
         });
     }
 

druid/src/tests/helpers.rs

@@ -236,7 +236,7 @@ impl<T: Data> Widget<T> for ReplaceChild<T> {
     }
 
     fn paint(&mut self, ctx: &mut PaintCtx, data: &T, env: &Env) {
-        self.inner.paint(ctx, data, env)
+        self.inner.paint_raw(ctx, data, env)
     }
 }
 

druid/src/widget/align.rs

@@ -131,7 +131,7 @@ impl<T: Data> Widget<T> for Align<T> {
     }
 
     fn paint(&mut self, ctx: &mut PaintCtx, data: &T, env: &Env) {
-        self.child.paint_with_offset(ctx, data, env);
+        self.child.paint(ctx, data, env);
     }
 }
 

druid/src/widget/checkbox.rs

@@ -136,6 +136,6 @@ impl Widget<bool> for Checkbox {
         }
 
         // Paint the text label
-        self.child_label.paint_with_offset(ctx, data, env);
+        self.child_label.paint(ctx, data, env);
     }
 }

druid/src/widget/container.rs

@@ -154,6 +154,6 @@ impl<T: Data> Widget<T> for Container<T> {
             ctx.stroke(border_rect, &border.color.resolve(env), border_width);
         };
 
-        self.inner.paint_with_offset(ctx, data, env);
+        self.inner.paint(ctx, data, env);
     }
 }

druid/src/widget/either.rs

@@ -103,9 +103,9 @@ impl<T: Data> Widget<T> for Either<T> {
 
     fn paint(&mut self, ctx: &mut PaintCtx, data: &T, env: &Env) {
         if self.current {
-            self.true_branch.paint(ctx, data, env);
+            self.true_branch.paint_raw(ctx, data, env);
         } else {
-            self.false_branch.paint(ctx, data, env);
+            self.false_branch.paint_raw(ctx, data, env);
         }
     }
 }

druid/src/widget/flex.rs

@@ -647,7 +647,7 @@ impl<T: Data> Widget<T> for Flex<T> {
 
     fn paint(&mut self, ctx: &mut PaintCtx, data: &T, env: &Env) {
         for child in &mut self.children {
-            child.widget.paint_with_offset(ctx, data, env);
+            child.widget.paint(ctx, data, env);
         }
     }
 }

druid/src/widget/list.rs

@@ -269,7 +269,7 @@ impl<C: Data, T: ListIter<C>> Widget<T> for List<C> {
         let mut children = self.children.iter_mut();
         data.for_each(|child_data, _| {
             if let Some(child) = children.next() {
-                child.paint_with_offset(ctx, child_data, env);
+                child.paint(ctx, child_data, env);
             }
         });
     }