visible_bounds operation for Container

CHANGELOG.md

@@ -27,6 +27,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Helpers to change viewport alignment of a `Scrollable`. [#1953](https://github.com/iced-rs/iced/pull/1953)
 - `scroll_to` widget operation. [#1796](https://github.com/iced-rs/iced/pull/1796)
 - `scroll_to` helper. [#1804](https://github.com/iced-rs/iced/pull/1804)
+- `visible_bounds` widget operation for `Container`. [#1971](https://github.com/iced-rs/iced/pull/1971)
 - Command to fetch window size. [#1927](https://github.com/iced-rs/iced/pull/1927)
 - Conversion support from `Fn` trait to custom theme. [#1861](https://github.com/iced-rs/iced/pull/1861)
 - Configurable border radii on relevant widgets. [#1869](https://github.com/iced-rs/iced/pull/1869)

core/src/element.rs

@@ -5,7 +5,9 @@ use crate::overlay;
 use crate::renderer;
 use crate::widget;
 use crate::widget::tree::{self, Tree};
-use crate::{Clipboard, Color, Layout, Length, Rectangle, Shell, Widget};
+use crate::{
+ Clipboard, Color, Layout, Length, Rectangle, Shell, Vector, Widget,
+};
 
 use std::any::Any;
 use std::borrow::Borrow;
@@ -325,11 +327,12 @@ where
  fn container(
  &mut self,
  id: Option<&widget::Id>,
+ bounds: Rectangle,
  operate_on_children: &mut dyn FnMut(
  &mut dyn widget::Operation<T>,
  ),
  ) {
- self.operation.container(id, &mut |operation| {
+ self.operation.container(id, bounds, &mut |operation| {
  operate_on_children(&mut MapOperation { operation });
  });
  }
@@ -346,8 +349,10 @@ where
  &mut self,
  state: &mut dyn widget::operation::Scrollable,
  id: Option<&widget::Id>,
+ bounds: Rectangle,
+ translation: Vector,
  ) {
- self.operation.scrollable(state, id);
+ self.operation.scrollable(state, id, bounds, translation);
  }
 
  fn text_input(

core/src/overlay/element.rs

@@ -172,11 +172,12 @@ where
  fn container(
  &mut self,
  id: Option<&widget::Id>,
+ bounds: Rectangle,
  operate_on_children: &mut dyn FnMut(
  &mut dyn widget::Operation<T>,
  ),
  ) {
- self.operation.container(id, &mut |operation| {
+ self.operation.container(id, bounds, &mut |operation| {
  operate_on_children(&mut MapOperation { operation });
  });
  }
@@ -193,8 +194,10 @@ where
  &mut self,
  state: &mut dyn widget::operation::Scrollable,
  id: Option<&widget::Id>,
+ bounds: Rectangle,
+ translation: Vector,
  ) {
- self.operation.scrollable(state, id);
+ self.operation.scrollable(state, id, bounds, translation);
  }
 
  fn text_input(

core/src/overlay/group.rs

@@ -138,7 +138,7 @@ where
  renderer: &Renderer,
  operation: &mut dyn widget::Operation<Message>,
  ) {
- operation.container(None, &mut |operation| {
+ operation.container(None, layout.bounds(), &mut |operation| {
  self.children.iter_mut().zip(layout.children()).for_each(
  |(child, layout)| {
  child.operate(layout, renderer, operation);

core/src/rectangle.rs

@@ -197,3 +197,18 @@ where
  }
  }
 }
+
+impl<T> std::ops::Sub<Vector<T>> for Rectangle<T>
+where
+ T: std::ops::Sub<Output = T>,
+{
+ type Output = Rectangle<T>;
+
+ fn sub(self, translation: Vector<T>) -> Self {
+ Rectangle {
+ x: self.x - translation.x,
+ y: self.y - translation.y,
+ ..self
+ }
+ }
+}

core/src/widget/operation.rs

@@ -8,6 +8,7 @@ pub use scrollable::Scrollable;
 pub use text_input::TextInput;
 
 use crate::widget::Id;
+use crate::{Rectangle, Vector};
 
 use std::any::Any;
 use std::fmt;
@@ -23,14 +24,22 @@ pub trait Operation<T> {
  fn container(
  &mut self,
  id: Option<&Id>,
+ bounds: Rectangle,
  operate_on_children: &mut dyn FnMut(&mut dyn Operation<T>),
  );
 
  /// Operates on a widget that can be focused.
  fn focusable(&mut self, _state: &mut dyn Focusable, _id: Option<&Id>) {}
 
  /// Operates on a widget that can be scrolled.
- fn scrollable(&mut self, _state: &mut dyn Scrollable, _id: Option<&Id>) {}
+ fn scrollable(
+ &mut self,
+ _state: &mut dyn Scrollable,
+ _id: Option<&Id>,
+ _bounds: Rectangle,
+ _translation: Vector,
+ ) {
+ }
 
  /// Operates on a widget that has text input.
  fn text_input(&mut self, _state: &mut dyn TextInput, _id: Option<&Id>) {}
@@ -92,6 +101,7 @@ where
  fn container(
  &mut self,
  id: Option<&Id>,
+ bounds: Rectangle,
  operate_on_children: &mut dyn FnMut(&mut dyn Operation<B>),
  ) {
  struct MapRef<'a, A> {
@@ -102,11 +112,12 @@ where
  fn container(
  &mut self,
  id: Option<&Id>,
+ bounds: Rectangle,
  operate_on_children: &mut dyn FnMut(&mut dyn Operation<B>),
  ) {
  let Self { operation, .. } = self;
 
- operation.container(id, &mut |operation| {
+ operation.container(id, bounds, &mut |operation| {
  operate_on_children(&mut MapRef { operation });
  });
  }
@@ -115,8 +126,10 @@ where
  &mut self,
  state: &mut dyn Scrollable,
  id: Option<&Id>,
+ bounds: Rectangle,
+ translation: Vector,
  ) {
- self.operation.scrollable(state, id);
+ self.operation.scrollable(state, id, bounds, translation);
  }
 
  fn focusable(
@@ -145,15 +158,21 @@ where
  MapRef {
  operation: operation.as_mut(),
  }
- .container(id, operate_on_children);
+ .container(id, bounds, operate_on_children);
  }
 
  fn focusable(&mut self, state: &mut dyn Focusable, id: Option<&Id>) {
  self.operation.focusable(state, id);
  }
 
- fn scrollable(&mut self, state: &mut dyn Scrollable, id: Option<&Id>) {
- self.operation.scrollable(state, id);
+ fn scrollable(
+ &mut self,
+ state: &mut dyn Scrollable,
+ id: Option<&Id>,
+ bounds: Rectangle,
+ translation: Vector,
+ ) {
+ self.operation.scrollable(state, id, bounds, translation);
  }
 
  fn text_input(&mut self, state: &mut dyn TextInput, id: Option<&Id>) {
@@ -197,6 +216,7 @@ pub fn scope<T: 'static>(
  fn container(
  &mut self,
  id: Option<&Id>,
+ _bounds: Rectangle,
  operate_on_children: &mut dyn FnMut(&mut dyn Operation<Message>),
  ) {
  if id == Some(&self.target) {

core/src/widget/operation/focusable.rs

@@ -1,6 +1,7 @@
 //! Operate on widgets that can be focused.
 use crate::widget::operation::{Operation, Outcome};
 use crate::widget::Id;
+use crate::Rectangle;
 
 /// The internal state of a widget that can be focused.
 pub trait Focusable {
@@ -45,6 +46,7 @@ pub fn focus<T>(target: Id) -> impl Operation<T> {
  fn container(
  &mut self,
  _id: Option<&Id>,
+ _bounds: Rectangle,
  operate_on_children: &mut dyn FnMut(&mut dyn Operation<T>),
  ) {
  operate_on_children(self)
@@ -80,6 +82,7 @@ where
  fn container(
  &mut self,
  _id: Option<&Id>,
+ _bounds: Rectangle,
  operate_on_children: &mut dyn FnMut(&mut dyn Operation<T>),
  ) {
  operate_on_children(self)
@@ -126,6 +129,7 @@ pub fn focus_previous<T>() -> impl Operation<T> {
  fn container(
  &mut self,
  _id: Option<&Id>,
+ _bounds: Rectangle,
  operate_on_children: &mut dyn FnMut(&mut dyn Operation<T>),
  ) {
  operate_on_children(self)
@@ -159,6 +163,7 @@ pub fn focus_next<T>() -> impl Operation<T> {
  fn container(
  &mut self,
  _id: Option<&Id>,
+ _bounds: Rectangle,
  operate_on_children: &mut dyn FnMut(&mut dyn Operation<T>),
  ) {
  operate_on_children(self)
@@ -185,6 +190,7 @@ pub fn find_focused() -> impl Operation<Id> {
  fn container(
  &mut self,
  _id: Option<&Id>,
+ _bounds: Rectangle,
  operate_on_children: &mut dyn FnMut(&mut dyn Operation<Id>),
  ) {
  operate_on_children(self)

core/src/widget/operation/scrollable.rs

@@ -1,5 +1,6 @@
 //! Operate on widgets that can be scrolled.
 use crate::widget::{Id, Operation};
+use crate::{Rectangle, Vector};
 
 /// The internal state of a widget that can be scrolled.
 pub trait Scrollable {
@@ -22,12 +23,19 @@ pub fn snap_to<T>(target: Id, offset: RelativeOffset) -> impl Operation<T> {
  fn container(
  &mut self,
  _id: Option<&Id>,
+ _bounds: Rectangle,
  operate_on_children: &mut dyn FnMut(&mut dyn Operation<T>),
  ) {
  operate_on_children(self)
  }
 
- fn scrollable(&mut self, state: &mut dyn Scrollable, id: Option<&Id>) {
+ fn scrollable(
+ &mut self,
+ state: &mut dyn Scrollable,
+ id: Option<&Id>,
+ _bounds: Rectangle,
+ _translation: Vector,
+ ) {
  if Some(&self.target) == id {
  state.snap_to(self.offset);
  }
@@ -49,12 +57,19 @@ pub fn scroll_to<T>(target: Id, offset: AbsoluteOffset) -> impl Operation<T> {
  fn container(
  &mut self,
  _id: Option<&Id>,
+ _bounds: Rectangle,
  operate_on_children: &mut dyn FnMut(&mut dyn Operation<T>),
  ) {
  operate_on_children(self)
  }
 
- fn scrollable(&mut self, state: &mut dyn Scrollable, id: Option<&Id>) {
+ fn scrollable(
+ &mut self,
+ state: &mut dyn Scrollable,
+ id: Option<&Id>,
+ _bounds: Rectangle,
+ _translation: Vector,
+ ) {
  if Some(&self.target) == id {
  state.scroll_to(self.offset);
  }

core/src/widget/operation/text_input.rs

@@ -1,6 +1,7 @@
 //! Operate on widgets that have text input.
 use crate::widget::operation::Operation;
 use crate::widget::Id;
+use crate::Rectangle;
 
 /// The internal state of a widget that has text input.
 pub trait TextInput {
@@ -34,6 +35,7 @@ pub fn move_cursor_to_front<T>(target: Id) -> impl Operation<T> {
  fn container(
  &mut self,
  _id: Option<&Id>,
+ _bounds: Rectangle,
  operate_on_children: &mut dyn FnMut(&mut dyn Operation<T>),
  ) {
  operate_on_children(self)
@@ -63,6 +65,7 @@ pub fn move_cursor_to_end<T>(target: Id) -> impl Operation<T> {
  fn container(
  &mut self,
  _id: Option<&Id>,
+ _bounds: Rectangle,
  operate_on_children: &mut dyn FnMut(&mut dyn Operation<T>),
  ) {
  operate_on_children(self)
@@ -93,6 +96,7 @@ pub fn move_cursor_to<T>(target: Id, position: usize) -> impl Operation<T> {
  fn container(
  &mut self,
  _id: Option<&Id>,
+ _bounds: Rectangle,
  operate_on_children: &mut dyn FnMut(&mut dyn Operation<T>),
  ) {
  operate_on_children(self)
@@ -121,6 +125,7 @@ pub fn select_all<T>(target: Id) -> impl Operation<T> {
  fn container(
  &mut self,
  _id: Option<&Id>,
+ _bounds: Rectangle,
  operate_on_children: &mut dyn FnMut(&mut dyn Operation<T>),
  ) {
  operate_on_children(self)

examples/toast/src/main.rs

@@ -381,7 +381,7 @@ mod toast {
  renderer: &Renderer,
  operation: &mut dyn Operation<Message>,
  ) {
- operation.container(None, &mut |operation| {
+ operation.container(None, layout.bounds(), &mut |operation| {
  self.content.as_widget().operate(
  &mut state.children[0],
  layout,
@@ -622,7 +622,7 @@ mod toast {
  renderer: &Renderer,
  operation: &mut dyn widget::Operation<Message>,
  ) {
- operation.container(None, &mut |operation| {
+ operation.container(None, layout.bounds(), &mut |operation| {
  self.toasts
  .iter()
  .zip(self.state.iter_mut())

examples/visible_bounds/Cargo.toml

@@ -0,0 +1,10 @@
+[package]
+name = "visible_bounds"
+version = "0.1.0"
+authors = ["Héctor Ramón Jiménez <hector0193@gmail.com>"]
+edition = "2021"
+publish = false
+
+[dependencies]
+iced = { path = "../..", features = ["debug"] }
+once_cell = "1"